Passer au contenu
/
Get management link

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

Abonnements

Opérations

Paiements

Opérations

Promotions

Opérations

Coupons

Opérations

Abonnements

Opérations

Buy subscription

Requête

Sécurité
projectUserJwtAuth
Chemin
project_idinteger\d+obligatoire
Requête
countrystring
Corpsapplication/jsonobligatoire

Buy subscription

available_plansobject or null

Plans d'abonnement à afficher dans l'interface de paiement.

Par défaut null
custom_parametersobject or null

You can pass additional parameters in the token

Par défaut null
plan_external_idstring or null

You must provide either a plan_external_id

Par défaut null
Exemple: "PlanExternalId"
product_idinteger or null

ID of the product associated with the plan

Par défaut null
Exemple: "12345"
settings(object or null)
(object or null)
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/fr/api/subscriptions/api/user/v1/projects/{project_id}/subscriptions/buy?country=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "available_plans": null,
    "custom_parameters": null,
    "plan_external_id": "PlanExternalId",
    "product_id": "12345",
    "settings": {
      "currency": "str",
      "external_id": "string",
      "hide_saved_payment_accounts": true,
      "locale": "st",
      "payment_method": 1,
      "redirect_policy": {
        "delay": 0,
        "redirect_button_caption": "string",
        "redirect_conditions": "none",
        "status_for_manual_redirection": "none"
      },
      "return_url": "string",
      "steam_user_id": "stringstringstrin",
      "ui": {
        "desktop": {
          "header": {
            "close_button": true,
            "is_visible": true,
            "type": "compact",
            "visible_logo": true,
            "visible_name": true
          }
        },
        "independent_windows": true,
        "license_url": "string",
        "mobile": {
          "footer": {
            "is_visible": true
          },
          "header": {
            "close_button": true
          },
          "mode": "saved_accounts"
        },
        "mode": "user_account",
        "size": "large",
        "theme": "string",
        "user_account": {
          "history": {
            "enable": true,
            "order": 1
          },
          "info": {
            "enable": true,
            "order": 1
          },
          "payment_accounts": {
            "enable": true,
            "order": 1
          },
          "subscriptions": {
            "enable": true,
            "order": 1
          }
        },
        "version": "desktop"
      },
      "xsolla_product_tag": "string"
    }
  }'

Réponses

Get buy subscription url

Corpsapplication/json
link_to_psstringobligatoire
Exemple: "https://secure.xsolla.com/paystation2/?access_token=<access_token>"
Réponse
application/json
{
  "link_to_ps": "https://secure.xsolla.com/paystation2/?access_token=<access_token>"
}

Catalog

Opérations

Coupons

Opérations

Abonnements

Opérations

Payment accounts

Opérations