ID utilisateur.
Subscriptions API (2.0)
- 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
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/subscriptions/
Requête
Répertorie tous les abonnements récurrents.
Remarque
Cette méthode API ne peut pas être utilisée en cas de charge élevée. La charge maximale est de 20 requêtes par minute.
Cette méthode API ne peut pas être utilisée en cas de charge élevée. La charge maximale est de 20 requêtes par minute.
Remarque
Cet appel API ne contient pas le paramètre de chemin project_id, vous devez donc utiliser la clé API valide dans tous les projets de l'entreprise pour l'autorisation.
Sécurité
basicAuth
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/subscriptions
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/subscriptions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/subscriptions?offset=0&limit=0&user_id=string&project_id%5B%5D=0&plan_id%5B%5D=0&product_id%5B%5D=0&group_id%5B%5D=string&status%5B%5D=active&datetime_from=string&datetime_to=string'OK.
Date de création de l'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.
Date de fin d'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.
Date de la dernière facturation de l'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.
Date de la prochaine facturation de l'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.
Informations sur la relance de la facturation.
Informations de facturation.
Description du plan. La valeur est constituée de paires "localization":"plan description".
Informations sur l'expiration de l'abonnement.
Informations sur le délai de grâce.
Nom du plan. La valeur est constituée de paires "localization":"plan name".
Période durant laquelle l'utilisateur peut se faire rembourser le paiement d'un abonnement (en jours).
Descriptions localisées de l'objet.
Réponse
application/json
[ { "charge_amount": 0.03, "currency": "USD", "date_create": "2013-09-05T15:27:47+04:00", "date_end": "2014-02-06T11:32:48+04:00", "date_last_charge": null, "date_next_charge": null, "id": 45, "plan": { … }, "product": { … }, "status": "canceled", "user": { … } } ]
- https://api.xsolla.com/merchant/v2/projects/{project_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'OK.
Date de création de l'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.
Date de fin d'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.
Date de la dernière facturation de l'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.
Date de la prochaine facturation de l'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.
Informations sur la relance de la facturation.
Informations de facturation.
Description du plan. La valeur est constituée de paires "localization":"plan description".
Informations sur l'expiration de l'abonnement.
Informations sur le délai de grâce.
Nom du plan. La valeur est constituée de paires "localization":"plan name".
Période durant laquelle l'utilisateur peut se faire rembourser le paiement d'un abonnement (en jours).
Descriptions localisées de l'objet.
Réponse
application/json
{ "charge_amount": 0.03, "comment": "The subscription was not extended in due time", "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": "2019-02-06T12:43:04+03:00", "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 249579, "plan": { "external_id": "lowcost", "id": 601 }, "product": { "id": 123456 }, "status": "canceled", "user": { "id": "user1", "name": "John Smith" } }
Corpsapplication/jsonobligatoire
Définir sur true rembourse le dernier paiement effectué pour cet abonnement. Ne fonctionne que si le statut du paiement est canceled.
Report de facturation.
Unité de temps de facturation. La valeur peut être day ou month.
Enum"day""month"
ID de collaborateur – identifiant d'influenceur ou de réseau d'affiliation. Il se trouve dans le compte éditeur sous la section Partner Network > Influencers.
- https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}' \
-H 'Content-Type: application/json' \
-d '{
"status": "active"
}'Réponse
application/json
{ "charge_amount": 0.03, "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": null, "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 24953579, "plan": { "billing_retry": { … }, "charge": { … }, "description": null, "expiration": { … }, "external_id": "lowcost", "grace_period": { … }, "group_id": "newPlans", "id": 66001, "localized_name": null, "name": null, "project_id": 18404, "refund_period": null, "status": { … }, "tags": null, "trial": { … }, "type": "all" }, "product": null, "status": "active", "user": { "id": "jb1", "name": "J.Black" } }