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

Subscription management

Opérations

Paiements

Opérations

Lire les devises

Requête

Récupère la liste de toutes les devises d'abonnement prises en charge.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

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

Réponses

OK.

Corpsapplication/json
Réponse
application/json
[
  "AED",
  "ALL",
  "AMD",
  "ARS",
  "AUD",
  "AZN",
  "BAM",
  "BBD",
  "BGN",
  "BHD",
  "BND",
  "BRL",
  "BYN",
  "BZD",
  "CAD",
  "CHF",
  "CLP",
  "CNY",
  "COP",
  "CRC",
  "CZK",
  "DKK",
  "DZD",
  "EGP",
  "EUR",
  "GBP",
  "GEL",
  "GHS",
  "GIP",
  "GTQ",
  "HKD",
  "HRK",
  "HUF",
  "IDR",
  "ILS",
  "INR",
  "IQD",
  "IRR",
  "ISK",
  "JMD",
  "JOD",
  "JPY",
  "KES",
  "KGS",
  "KRW",
  "KWD",
  "KZT",
  "LAK",
  "LBP",
  "LKR",
  "MAD",
  "MDL",
  "MKD",
  "MMK",
  "MNT",
  "MUR",
  "MXN",
  "MYR",
  "NGN",
  "NIO",
  "NOK",
  "NPR",
  "NZD",
  "OMR",
  "PAB",
  "PEN",
  "PHP",
  "PKR",
  "PLN",
  "PYG",
  "QAR",
  "RON",
  "RSD",
  "RUB",
  "SAR",
  "SEK",
  "SGD",
  "SVC",
  "THB",
  "TND",
  "TRY",
  "TWD",
  "UAH",
  "USD",
  "UYU",
  "UZS",
  "VEF",
  "VND",
  "XOF",
  "YER",
  "ZAR"
]

Lire les paiements

Requête

Récupère la liste de tous les paiements d'abonnements.

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.

user_idstring

ID utilisateur.

statusstring

Statut de la transaction.

Enum ValeurDescription
done

Paiement traité avec succès.

fail

Le paiement a échoué ou un remboursement a été effectué.

datetime_fromstring(datetime)

Début de la période.

datetime_tostring(datetime)

Fin de la période.

subscription_idinteger

ID d'abonnement.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/subscriptions/payments?offset=0&limit=0&user_id=string&status=done&datetime_from=string&datetime_to=string&subscription_id=0'

Réponses

OK.

Corpsapplication/json
Réponse
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 67683,
    "id_payment": 203960,
    "status": "fail",
    "subscription": { … }
  },
  {
    "date_payment": "2015-09-21T17:06:47+03:00",
    "id": 1531,
    "id_payment": 168866,
    "status": "done",
    "subscription": { … }
  }
]

Lire les paiements d'un utilisateur

Requête

Récupère la liste de tous les paiements effectués par un utilisateur spécifique.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

user_idstringobligatoire

ID utilisateur.

Requête
statusstring

Statut de la transaction.

Enum ValeurDescription
done

Paiement traité avec succès.

fail

Le paiement a échoué ou un remboursement a été effectué.

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.

datetime_fromstring(datetime)

Date de l'échantillon. Permet de rechercher les abonnements créés après la requête.

datetime_tostring(datetime)

Date de l'échantillon. Permet de rechercher les abonnements créés après la requête.

subscription_idinteger

ID d'abonnement.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/payments?status=done&offset=0&limit=0&datetime_from=string&datetime_to=string&subscription_id=0'

Réponses

OK.

Corpsapplication/json
Réponse
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 6746083,
    "id_payment": 202789960,
    "status": "fail",
    "subscription": { … }
  }
]

Promotions

Opérations

Coupons

Opérations

Subscription management

Opérations