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

Requête

Désactive un plan d'abonnement.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

plan_idintegerobligatoire

ID de plan.

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

Réponses

No content.

Requête

Active un plan d'abonnement.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

plan_idintegerobligatoire

ID de plan.

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

Réponses

No content.

Requête

Met à jour les paramètres d'un plan d'abonnement.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

plan_idintegerobligatoire

ID de plan.

Corpsapplication/jsonobligatoire
billing_retryobject

Informations sur la relance de la facturation.

chargeobject

Informations de facturation.

descriptionobject

Description du plan. La valeur est constituée de paires "localization":"plan description".

expirationobject

Informations sur l'expiration de l'abonnement.

external_idstring

ID externe du plan (32 caractères).

grace_periodobject

Informations sur le délai de grâce.

group_idstring

ID du groupe auquel le plan est lié.

nameobject

Nom du plan. La valeur est constituée de paires "localization":"plan name".

refund_periodinteger or null

Période durant laquelle l'utilisateur peut se faire rembourser le paiement d'un abonnement (en jours).

statusobject
tagsArray of strings

Balises du plan.

trialobject

Informations sur la période d'essai. Si ce paramètre n'est pas passé, les valeurs par défaut (0 jour) sont utilisées.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_retry": {
      "value": 1
    },
    "charge": {
      "amount": 20,
      "currency": "USD",
      "period": {
        "type": "month",
        "value": 1
      },
      "prices": [
        {
          "amount": 17,
          "currency": "EUR",
          "setup_fee": 1.5
        },
        {
          "amount": 2000,
          "currency": "JPY",
          "setup_fee": 2.5
        }
      ]
    },
    "description": {
      "en": "3x more experience!"
    },
    "expiration": {
      "type": "day",
      "value": null
    },
    "external_id": "exp",
    "grace_period": {
      "type": "day",
      "value": 2
    },
    "name": {
      "en": "Experience boost"
    },
    "refund_period": null,
    "tags": [],
    "trial": {
      "type": "day",
      "value": 7
    }
  }'

Réponses

OK.

Corpsapplication/json
Réponse
application/json
{ "billing_retry": { "value": 1 }, "charge": { "amount": 20, "currency": "USD", "period": {}, "prices": [] }, "description": { "en": "3x more experience!" }, "expiration": { "type": "day", "value": 0 }, "external_id": "exp", "grace_period": { "type": "day", "value": 2 }, "group_id": null, "id": 241082, "localized_name": "Experience boost", "name": { "en": "Experience boost" }, "project_id": 40797, "refund_period": null, "status": { "value": "active" }, "tags": [], "trial": { "type": "day", "value": 7 }, "type": "all" }
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations