Passer au contenu
/
Échanger un coupon

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

Coupons

Opérations

Lire un coupon

Requête

Récupération des informations sur le coupon par son code.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

codestringobligatoire

Code de coupon.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/coupons/{code}/details'

Réponses

OK.

Corpsapplication/json
keystring

Clé de l'attribut utilisateur.

list_of_valuesArray of objects

Tableau des valeurs possibles de l'attribut de type enum.

nameobject

Noms localisés d'attributs.

skip_condition_on_nonexistent_keyboolean

Indique si la condition doit être ignorée au cas où la clé n'existe pas.

typestring

Type de clé.

Enum"int""string""enum""date"
visibleboolean
Réponse
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

Échanger un coupon

Requête

Utilisation d'un coupon par son code.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

codestringobligatoire

Code de coupon.

Corpsapplication/jsonobligatoire
user_idstringobligatoire

ID utilisateur.

Exemple: "1234"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/coupons/{code}/redeem' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "1234"
  }'

Réponses

OK.

Corpsapplication/json
campaign_codestring
coupon_codestring
coupon_idinteger
expiration_datestring
is_activeboolean
project_idinteger
redeems_count_for_userinteger
redeems_count_remaininteger
subscription_couponstring or null
virtual_currency_amountinteger
virtual_itemsArray of strings
Réponse
application/json
{
  "campaign_code": "new_campaign",
  "coupon_code": "ddgf5bn4",
  "coupon_id": 89613996,
  "expiration_date": "2019-12-31T00:00:00+00:00",
  "is_active": true,
  "project_id": 12345,
  "redeems_count_for_user": 10,
  "redeems_count_remain": 20,
  "subscription_coupon": null,
  "virtual_currency_amount": 200,
  "virtual_items": []
}

Subscription management

Opérations