Passer au contenu
/
Lire une promotion

Subscriptions API (2.0)

Présentation

  • Version : 2.0
  • Serveurs : https://api.xsolla.com/merchant/v2/

Cette référence API décrit les endpoints pour la gestion des abonnements, des coupons et des promotions. Pour plus d'informations sur les abonnements, consultez le guide du produit et le glossaire.

Télécharger la description d'OpenAPI
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/subscriptions/

Jeton

Opérations

Plans

Opérations

Produits

Opérations

Subscription management

Opérations

Paiements

Opérations

Promotions

Opérations

Supprimer une promotion

Requête

Supprime une promotion. Vous ne pouvez supprimer que les promotions avec enabled = false.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

Sécurité
basicAuth
Chemin
merchant_idintegerobligatoire

ID de commerçant.

promotion_idintegerobligatoire

ID de promotion.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

Réponses

No content.

Lire une promotion

Requête

Récupère une promotion.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

Sécurité
basicAuth
Chemin
merchant_idintegerobligatoire

ID de commerçant.

promotion_idintegerobligatoire

ID de promotion.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

Réponses

OK.

Corpsapplication/json
descriptionobject

Tableau des descriptions localisées de la promotion.

labelobject

Tableau des étiquettes localisées à afficher dans l'interface de paiement.

nameobject

Tableau des noms localisés de la promotion.

project_idinteger

ID de projet.

technical_namestring

Nom technique de la promotion.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
Réponse
application/json
{
  "description": {
    "en": "Promotion with 30% discount",
    "ru": "Акция со скидкой 30%"
  },
  "enabled": false,
  "id": 17890,
  "label": {
    "en": "30%",
    "ru": "30%"
  },
  "name": {
    "en": "30% discount",
    "ru": "Скидка 30%"
  },
  "project_id": 40544,
  "read_only": false,
  "show_banner": true,
  "technical_name": "Sale promotion"
}

Mettre à jour une promotion

Requête

Met à jour une promotion. Si la promotion est en lecture seule (read_only = true), vous n'êtes pas autorisé à modifier le paramètre project_id.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.

Sécurité
basicAuth
Chemin
merchant_idintegerobligatoire

ID de commerçant.

promotion_idintegerobligatoire

ID de promotion.

Corpsapplication/jsonobligatoire
descriptionobject

Tableau des descriptions localisées de la promotion.

labelobject

Tableau des étiquettes localisées à afficher dans l'interface de paiement.

nameobject

Tableau des noms localisés de la promotion.

project_idintegerobligatoire

ID de projet.

technical_namestringobligatoire

Nom technique de la promotion.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Promotion with 5% discount",
      "ru": "Акция со скидкой 5%"
    },
    "label": {
      "en": "5%",
      "ru": "5%"
    },
    "name": {
      "en": "5% discount",
      "ru": "скидка 5%"
    },
    "project_id": 40544,
    "technical_name": "Sale promotion"
  }'

Réponses

No content.

Coupons

Opérations

Subscription management

Opérations