Passer au contenu
/
Mettre à jour un abonneme...

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

Lire un abonnement

Requête

Récupère les informations d'un abonnement spécifique par son ID.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

subscription_idintegerobligatoire

ID d'abonnement.

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

Réponses

OK.

Corpsapplication/json
charge_amountnumber(float)

Montant de facturation.

commentstring

Raison du changement de statut de l'abonnement

currencystring

Devise d'achat. Code de devise à trois lettres selon la norme ISO 4217.

date_createstring(datetime)

Date de création de l'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.

date_endstring(datetime)

Date de fin d'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.

date_last_chargestring or null(datetime)

Date de la dernière facturation de l'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.

date_next_chargestring or null(datetime)

Date de la prochaine facturation de l'abonnement au format YYYY-MM-DD’T’HH:MM:SS selon la norme ISO 8601.

idinteger

ID d'abonnement

planobject
productobject or null
statusstring

Statut

Enum"new""active""canceled""non_renewing""freeze"
userobject
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"
  }
}

Mettre à jour un abonnement

Requête

Met à jour un abonnement en modifiant son statut (active, canceled ou non_renewing) ou en reportant la prochaine date de facturation.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

user_idstringobligatoire

ID utilisateur.

subscription_idintegerobligatoire

ID d'abonnement.

Corpsapplication/jsonobligatoire
cancel_subscription_paymentboolean

Définir sur true rembourse le dernier paiement effectué pour cet abonnement. Ne fonctionne que si le statut du paiement est canceled.

statusstring

Statut.

Enum"active""canceled""non_renewing"
timeshiftobject

Report de facturation.

xsolla_networkobject
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éponses

OK.

Corpsapplication/json
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"
  }
}

Paiements

Opérations

Promotions

Opérations

Coupons

Opérations

Subscription management

Opérations