Passer au contenu

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

Lire les produits

Requête

Récupère la liste de tous les produits par abonnement.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

Requête
offsetinteger

Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).

limitintegerobligatoire

Nombre maximal d'éléments sur une page.

group_idstring

ID du groupe auquel les plans sont liés.

product_idinteger

ID du produit auquel les plans sont liés.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/subscriptions/products?offset=0&limit=0&group_id=string&product_id=0'

Réponses

OK.

Corpsapplication/jsonArray [
idinteger or null

ID du produit auquel les plans sont liés.

descriptionobject

Descriptions localisées de l'objet.

group_idstring

ID du groupe auquel le produit est lié.

namestring

Nom du produit.

]
Réponse
application/json
[
  {
    "description": { … },
    "group_id": "charge",
    "id": 714,
    "name": "Channel"
  },
  {
    "description": { … },
    "group_id": "notify",
    "id": 715,
    "name": "notify"
  },
  {
    "description": { … },
    "group_id": "charge",
    "id": 716,
    "name": "charge2"
  },
  {
    "description": { … },
    "group_id": "charge",
    "id": 486,
    "name": "Channel2"
  }
]

Créer un produit

Requête

Crée un produit par abonnement.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

Corpsapplication/jsonobligatoire
descriptionobject

Descriptions localisées de l'objet.

group_idstringobligatoire

ID du groupe auquel le produit est lié.

namestringobligatoire

Nom du produit.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/subscriptions/products' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Kids TV"
    },
    "group_id": "charge",
    "name": "Channel2"
  }'

Réponses

Created.

Corpsapplication/json
product_idinteger
Réponse
application/json
{
  "product_id": 172003
}

Supprimer un produit

Requête

Supprime un produit par abonnement.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

product_idintegerobligatoire

ID du produit auquel les plans sont liés.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/subscriptions/products/{product_id}'

Réponses

No content.

Subscription management

Opérations

Paiements

Opérations

Promotions

Opérations

Coupons

Opérations

Subscription management

Opérations