Passer au contenu

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
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/subscriptions/
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations

Requête

Sécurité
projectUserJwtAuth
Chemin
subscription_idinteger\d+obligatoire
project_idinteger\d+obligatoire
Requête
localestring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/api/user/v1/projects/{project_id}/subscriptions/{subscription_id}?locale=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Réponses

Get subscription info

Corpsapplication/json
chargeobjectobligatoire
charge.​amountnumber(float)obligatoire
Exemple: 4.99
charge.​currencystringobligatoire
Exemple: "USD"
charge.​setup_feenumber(float)obligatoire
Exemple: 0.99
date_createstring(date-time)obligatoire
Exemple: "2031-04-11T13:51:02+03:00"
date_endstring or null(date-time)
Exemple: "2031-04-11T13:51:02+03:00"
date_last_chargestring or null(date-time)
Exemple: "2031-04-11T13:51:02+03:00"
date_next_chargestring or null(date-time)
Exemple: "2031-04-11T13:51:02+03:00"
idintegerobligatoire
Exemple: "12345"
is_change_plan_allowedbooleanobligatoire
Exemple: "false"
is_change_to_non_renew_possiblebooleanobligatoire
Exemple: "true"
is_in_trialbooleanobligatoire
Exemple: "false"
is_renew_possiblebooleanobligatoire
Exemple: "true"
periodobjectobligatoire
period.​unitstring or null
Par défaut null
Exemple: "month"
period.​valueinteger or null
Par défaut null
Exemple: "1"
plan_descriptionstringobligatoire
Exemple: "Localized plan description"
plan_end_datestring or null(date-time)
Exemple: "2031-04-11T13:51:02+03:00"
plan_external_idstringobligatoire
Exemple: "PlanExternalId"
plan_idintegerobligatoire
Exemple: "54321"
plan_namestringobligatoire
Exemple: "Localized plan name"
plan_start_datestring or null(date-time)
Exemple: "2021-04-11T13:51:02+03:00"
product_descriptionstring or null
Exemple: "Localized product description"
product_external_idstring or null
Exemple: "ProductExternalId"
product_idinteger or null
Exemple: "12345"
product_namestring or null
Exemple: "Product name"
statusstringobligatoire
Exemple: "active"
trial_periodinteger or null
Exemple: "0"
Réponse
application/json
{ "charge": { "amount": 4.99, "currency": "USD", "setup_fee": 0.99 }, "date_create": "2031-04-11T13:51:02+03:00", "date_end": "2031-04-11T13:51:02+03:00", "date_last_charge": "2031-04-11T13:51:02+03:00", "date_next_charge": "2031-04-11T13:51:02+03:00", "id": "12345", "is_change_plan_allowed": "false", "is_change_to_non_renew_possible": "true", "is_in_trial": "false", "is_renew_possible": "true", "period": { "unit": "month", "value": "1" }, "plan_description": "Localized plan description", "plan_end_date": "2031-04-11T13:51:02+03:00", "plan_external_id": "PlanExternalId", "plan_id": "54321", "plan_name": "Localized plan name", "plan_start_date": "2021-04-11T13:51:02+03:00", "product_description": "Localized product description", "product_external_id": "ProductExternalId", "product_id": "12345", "product_name": "Product name", "status": "active", "trial_period": "0" }

Requête

Sécurité
projectUserJwtAuth
Chemin
subscription_idinteger\d+obligatoire
project_idinteger\d+obligatoire
curl -i -X PUT \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/api/user/v1/projects/{project_id}/subscriptions/{subscription_id}/cancel' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Réponses

Make subscription non-renewable

Corpsapplication/json
Réponse
application/json
null
Opérations
Opérations
Opérations
Opérations