Passer au contenu
/
Supprimer un plan

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

Mettre à jour un plan

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.

billing_retry.​valueintegerobligatoire

Nombre de relances de facturation.

chargeobject

Informations de facturation.

charge.​amountnumber(float)

Montant de facturation.

charge.​currencystring

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

charge.​periodobjectobligatoire

Période de facturation.

charge.​period.​typestringobligatoire

Unité de temps. La valeur peut être day, month ou lifetime.

Enum"day""month""lifetime"
charge.​period.​valueintegerobligatoire

Nombre d'unités de temps. La valeur dépend du paramètre type et peut être :
- de 1 à 366, si type est défini sur day ;
- de 1 à 12, si type est défini sur month ;
- 0 si type est défini sur lifetime.

charge.​pricesArray of objects

Liste des prix dans différentes devises.

charge.​prices[].​amountnumber(float)obligatoire

Montant de facturation.

charge.​prices[].​currencystringobligatoire

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

charge.​prices[].​setup_feenumber(float)

Frais de mise en service uniques facturés dans le cadre de la première facture.

descriptionobject

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

description.​arstring

Arabe.

description.​bgstring

Bulgare.

description.​cnstring

Chinois (simplifié).

description.​csstring

Tchèque.

description.​destring

Allemand.

description.​enstring

Anglais.

description.​esstring

Espagnol.

description.​frstring

Français.

description.​hestring

Hébreu.

description.​itstring

Italien.

description.​jastring

Japonais.

description.​kostring

Coréen.

description.​plstring

Polonais.

description.​ptstring

Portugais.

description.​rostring

Roumain.

description.​rustring

Russe.

description.​thstring

Thaïlandais.

description.​trstring

Turc.

description.​twstring

Chinois (traditionnel).

description.​vistring

Vietnamien.

expirationobject

Informations sur l'expiration de l'abonnement.

expiration.​typestringobligatoire

Unité de temps. La valeur peut être day ou month.

Enum"day""month"
expiration.​valueinteger or nullobligatoire

Durée de validité.

external_idstring

ID externe du plan (32 caractères).

grace_periodobject

Informations sur le délai de grâce.

grace_period.​typestringobligatoire

Unité de temps. L'unique valeur possible est day.

Valeur"day"
grace_period.​valueintegerobligatoire

Nombre d'unités de temps.

group_idstring

ID du groupe auquel le plan est lié.

nameobject

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

name.​arstring

Arabe.

name.​bgstring

Bulgare.

name.​cnstring

Chinois (simplifié).

name.​csstring

Tchèque.

name.​destring

Allemand.

name.​enstring

Anglais.

name.​esstring

Espagnol.

name.​frstring

Français.

name.​hestring

Hébreu.

name.​itstring

Italien.

name.​jastring

Japonais.

name.​kostring

Coréen.

name.​plstring

Polonais.

name.​ptstring

Portugais.

name.​rostring

Roumain.

name.​rustring

Russe.

name.​thstring

Thaïlandais.

name.​trstring

Turc.

name.​twstring

Chinois (traditionnel).

name.​vistring

Vietnamien.

refund_periodinteger or null

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

statusobject
status.​valuestring

Statut de plan d'abonnement.

Enum"active""disabled"
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.

trial.​typestringobligatoire

Unité de temps. L'unique valeur possible est day.

Valeur"day"
trial.​valueintegerobligatoire

Nombre d'unités de temps.

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"
}

Supprimer un plan

Requête

Supprime 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}/delete'

Réponses

No content.

Produits

Opérations

Subscription management

Opérations

Paiements

Opérations

Promotions

Opérations

Coupons

Opérations

Subscription management

Opérations