Passer au contenu
/
Lire les périodes de vali...

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 systèmes de paiement

Requête

Définit les systèmes de paiement pris en charge pour une promotion. Si la liste est vide, la promotion s'appliquera à tous les systèmes de paiement. Si la promotion est en lecture seule (read_only = true), vous ne pouvez pas appeler cette méthode.

Remarque

Cet appel API ne contient pas le paramètre de cheminproject_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
payment_systemsArray of objects

Systèmes de paiement.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/payment_systems' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_systems": [
      {
        "id": 24,
        "name": "PayPal"
      }
    ]
  }'

Réponses

No content.

Lire les périodes de validité

Requête

Obtient les plages de dates/heures pendant lesquelles une promotion est valide.

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}/periods'

Réponses

OK.

Corpsapplication/json
idinteger
periodsArray of objects

Plages de dates et d'heures.

Réponse
application/json
{
  "id": 17840,
  "periods": [
    { … }
  ]
}

Définir les périodes de validité

Requête

Définit les plages de dates/heures pendant lesquelles une promotion est valide. Si la promotion est en lecture seule (read_only = true), vous ne pouvez pas modifier les périodes existantes, mais vous pouvez en ajouter de nouvelles.

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
periodsArray of objects

Plages de dates et d'heures.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/periods' \
  -H 'Content-Type: application/json' \
  -d '{
    "periods": [
      {
        "from": "2019-03-02T00:00:00+04:00",
        "to": "2019-04-02T00:00:00+04:00"
      }
    ]
  }'

Réponses

No content.

Coupons

Opérations

Subscription management

Opérations