Passer au contenu
/
Lire le sujet

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

Paiements

Opérations

Promotions

Opérations

Définir les récompenses

Requête

Définit les récompenses pour une promotion. Si la promotion est en lecture seule (read_only = true), vous ne pouvez pas mettre à jour les récompenses.

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
Chemin
merchant_idintegerobligatoire

ID de commerçant.

promotion_idintegerobligatoire

ID de promotion.

Corpsapplication/jsonobligatoire
itemobject

Définit la récompense pour l'achat des objets virtuels spécifiques.

item.​bonusArray of objects

Objets virtuels supplémentaires octroyés en bonus.

item.​bonus[].​idinteger
item.​bonus[].​localized_namestring

Nom du plan dans la langue par défaut (en), répète la valeur du paramètre name.en.

item.​bonus[].​quantityinteger

Nombre d'objets virtuels octroyés en bonus.

item.​bonus[].​skustring

UGS de l'objet.

item.​discountArray of objects

Remises pour l'achat des objets virtuels spécifiques.

item.​discount[].​discount_percentnumber(float)

Pourcentage de remise.

item.​discount[].​localized_namestring

Nom du plan dans la langue par défaut (en), répète la valeur du paramètre name.en.

item.​discount[].​max_amountnumber(integer)

Nombre maximal d'objets auxquels la promotion s'applique.

item.​discount[].​skustring

UGS de l'objet.

packageobject

Définit la récompense pour l'achat d'un package de monnaie virtuelle.

package.​bonus_amountnumber(float)

Récompense sous forme d'une quantité absolue de monnaie virtuelle.

package.​bonus_percentnumber(float)

Récompense sous forme d'un pourcentage de la quantité de monnaie virtuelle dans le package.

purchaseobject

Définit la récompense pour l'ensemble de la commande.

purchase.​discount_percentnumber(float)

Pourcentage de remise.

subscriptionobject

Définit la récompense pour l'abonnement.

subscription.​trial_daysinteger

Période d'essai en jours.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards' \
  -H 'Content-Type: application/json' \
  -d '{
    "item": {
      "bonus": [
        {
          "quantity": 2,
          "sku": "1234"
        }
      ],
      "discount": [
        {
          "discount_percent": 5,
          "max_amount": 10,
          "sku": "1234"
        }
      ]
    },
    "package": {
      "bonus_amount": 5,
      "bonus_percent": 5
    },
    "purchase": {
      "discount_percent": 10
    },
    "subscription": {
      "trial_days": 30
    }
  }'

Réponses

No content.

Lire le sujet

Requête

Obtient des informations sur le sujet d'une promotion.

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
Chemin
merchant_idintegerobligatoire

ID de commerçant.

promotion_idintegerobligatoire

ID de promotion.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject'

Réponses

OK.

Corpsapplication/json
digital_contentsobject or null
itemsArray of objects

Tableau des objets virtuels auxquels la promotion s'applique.

items[].​idinteger
items[].​localized_namestring

Nom du plan dans la langue par défaut (en), répète la valeur du paramètre name.en.

items[].​skustring

UGS de l'objet.

packagesArray of objects or null

Tableau des packages de monnaie virtuelle auxquels la promotion s'applique.

purchaseboolean

Indique si la promotion s'applique à l'ensemble de la commande.

subscriptionsobject or null

Plans d'abonnement ou produits auxquels la promotion s'applique.

subscriptions.​max_charges_countinteger

Nombre maximal de facturations auxquelles la promotion s'applique.

subscriptions.​plansArray of strings
subscriptions.​productsArray of strings
idinteger
Réponse
application/json
{
  "digital_contents": null,
  "id": 178,
  "items": [
    { … }
  ],
  "packages": null,
  "purchase": false,
  "subscriptions": null
}

Définir le sujet

Requête

Définit le sujet d'une promotion. Si la promotion est en lecture seule (read_only = true), vous ne pouvez pas mettre à jour le sujet. Le sujet peut prendre les valeurs suivantes : purchase, items ou packages.

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
Chemin
merchant_idintegerobligatoire

ID de commerçant.

promotion_idintegerobligatoire

ID de promotion.

Corpsapplication/jsonobligatoire
digital_contentsobject or null
itemsArray of objects

Tableau des objets virtuels auxquels la promotion s'applique.

items[].​idinteger
items[].​localized_namestring

Nom du plan dans la langue par défaut (en), répète la valeur du paramètre name.en.

items[].​skustring

UGS de l'objet.

packagesArray of objects or null

Tableau des packages de monnaie virtuelle auxquels la promotion s'applique.

purchaseboolean

Indique si la promotion s'applique à l'ensemble de la commande.

subscriptionsobject or null

Plans d'abonnement ou produits auxquels la promotion s'applique.

subscriptions.​max_charges_countinteger

Nombre maximal de facturations auxquelles la promotion s'applique.

subscriptions.​plansArray of strings
subscriptions.​productsArray of strings
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject' \
  -H 'Content-Type: application/json' \
  -d '{
    "digital_contents": null,
    "items": [
      {
        "sku": "1234"
      }
    ],
    "packages": null,
    "purchase": false,
    "subscriptions": null
  }'

Réponses

No content.

Coupons

Opérations

Subscription management

Opérations