# Subscriptions API # 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](https://developers.xsolla.com/fr/doc/subscriptions) et le [glossaire](https://developers.xsolla.com/fr/doc/subscriptions/integration-guide/get-started/#general_glossary). Version: 2.0 ## Security ### basicAuth L'API de Xsolla utilise l'authentification d'accès de base. Toutes les requêtes vers l'API doivent contenir l'en-tête `Authorization: Basic ` où `` est la paire `merchant_id:api_key` encodée conformément à la norme Base64. Pour trouver ces paramètres, accédez au [Compte éditeur](https://publisher.xsolla.com/) :
Pour plus d'informations sur l'utilisation des clés API, consultez la [référence API](https://developers.xsolla.com/fr/api/getting-started/#api_keys_overview). Type: http Scheme: basic ### subscriptionsManagementJwtAuth Type: http Scheme: bearer ## Download OpenAPI description [Subscriptions API](https://developers.xsolla.com/_bundle/@l10n/fr/api/subscriptions/index.yaml) ## Jeton ### Créer un jeton - [POST /merchants/{merchant_id}/token](https://developers.xsolla.com/fr/api/subscriptions/token/create-token.md): Vous pouvez créer un jeton avec des paramètres utilisateur arbitraires. Vous envoyez ces paramètres lors de l'obtention du jeton et les recevez en retour après un paiement réussi. Un jeton ne peut contenir que des paramètres décrits dans ce document ou prédéfinis par vous. Si un paramètre est envoyé dans un format incorrect ou a un type incorrect, aucun jeton ne sera émis. Vous recevrez un code HTTP 422 avec la description de l'erreur dans le corps JSON. Dans extended_message, vous recevrez une information sur les paramètres exacts qui ont été envoyés de manière incorrecte. 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. ## Plans ### Lire les plans - [GET /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/fr/api/subscriptions/plans/get-plans.md): Récupère la liste de tous les plans d'abonnement. ### Créer un plan - [POST /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/fr/api/subscriptions/plans/create-plan.md): Crée un plan d'abonnement. ### Désactiver un plan - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/fr/api/subscriptions/plans/disable-plan.md): Désactive un plan d'abonnement. ### Activer un plan - [PATCH /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/fr/api/subscriptions/plans/enable-plan.md): Active un plan d'abonnement. ### Mettre à jour un plan - [PUT /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/fr/api/subscriptions/plans/update-plan-parameters.md): Met à jour les paramètres d'un plan d'abonnement. ### Supprimer un plan - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}/delete](https://developers.xsolla.com/fr/api/subscriptions/plans/delete-plan.md): Supprime un plan d'abonnement. ## Produits ### Lire les produits - [GET /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/fr/api/subscriptions/products/get-products.md): Récupère la liste de tous les produits par abonnement. ### Créer un produit - [POST /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/fr/api/subscriptions/products/create-product.md): Crée un produit par abonnement. ### Supprimer un produit - [DELETE /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/fr/api/subscriptions/products/delete-product.md): Supprime un produit par abonnement. ### Mettre à jour un produit - [PUT /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/fr/api/subscriptions/products/update-product.md): Met à jour un produit par abonnement. ## Subscription management ### Lire la liste des abonnements - [GET /merchants/{merchant_id}/subscriptions](https://developers.xsolla.com/fr/api/subscriptions/subscriptions/get-subscriptions.md): Répertorie tous les abonnements récurrents.Remarque Cette méthode API ne peut pas être utilisée en cas de charge élevée. La charge maximale est de 20 requêtes par minute. 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. ### Lire un abonnement - [GET /projects/{project_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/fr/api/subscriptions/subscriptions/get-subscription.md): Récupère les informations d'un abonnement spécifique par son ID. ### Mettre à jour un abonnement - [PUT /projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/fr/api/subscriptions/subscriptions/update-subscription.md): Met à jour un abonnement en modifiant son statut (active, canceled ou non_renewing) ou en reportant la prochaine date de facturation. ## Paiements ### Lire les devises - [GET /projects/{project_id}/subscriptions/currencies](https://developers.xsolla.com/fr/api/subscriptions/payments/get-currencies.md): Récupère la liste de toutes les devises d'abonnement prises en charge. ### Lire les paiements - [GET /projects/{project_id}/subscriptions/payments](https://developers.xsolla.com/fr/api/subscriptions/payments/get-payments.md): Récupère la liste de tous les paiements d'abonnements. ### Lire les paiements d'un utilisateur - [GET /projects/{project_id}/users/{user_id}/subscriptions/payments](https://developers.xsolla.com/fr/api/subscriptions/payments/get-user-payments.md): Récupère la liste de tous les paiements effectués par un utilisateur spécifique. ## Promotions ### Lire la liste des promotions - [GET /merchants/{merchant_id}/promotions](https://developers.xsolla.com/fr/api/subscriptions/promotions/get-promotions-list.md): Liste de toutes les promotions. RemarqueCet 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. ### Créer une promotion - [POST /merchants/{merchant_id}/promotions](https://developers.xsolla.com/fr/api/subscriptions/promotions/create-promotion.md): Créer une nouvelle promotion. RemarqueCet 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. ### Supprimer une promotion - [DELETE /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/fr/api/subscriptions/promotions/delete-promotion.md): Supprime une promotion. Vous ne pouvez supprimer que les promotions avec enabled = false. RemarqueCet 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. ### Lire une promotion - [GET /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/fr/api/subscriptions/promotions/get-promotion.md): Récupère une promotion. RemarqueCet 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. ### Mettre à jour une promotion - [PUT /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/fr/api/subscriptions/promotions/update-promotion.md): Met à jour une promotion. Si la promotion est en lecture seule (read_only = true), vous n'êtes pas autorisé à modifier le paramètre project_id. RemarqueCet 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. ### Lire les systèmes de paiement - [GET /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/fr/api/subscriptions/promotions/get-payment-systems.md): Obtient 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. RemarqueCet 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. ### Définir les systèmes de paiement - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/fr/api/subscriptions/promotions/set-payment-systems.md): 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. RemarqueCet 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. ### Lire les périodes de validité - [GET /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/fr/api/subscriptions/promotions/get-validity-periods.md): 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. ### Définir les périodes de validité - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/fr/api/subscriptions/promotions/set-validity-periods.md): 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. ### Réviser une promotion - [GET /merchants/{merchant_id}/promotions/{promotion_id}/review](https://developers.xsolla.com/fr/api/subscriptions/promotions/review-promotion.md): Vous devez vérifier une promotion avant de l'activer. Cette méthode renvoie la liste des erreurs, le cas échéant. 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. ### Lire les récompenses - [GET /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/fr/api/subscriptions/promotions/get-rewards.md): Obtient la liste des récompenses associées à 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. ### Définir les récompenses - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/fr/api/subscriptions/promotions/set-rewards.md): 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. ### Lire le sujet - [GET /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/fr/api/subscriptions/promotions/get-subject.md): 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. ### Définir le sujet - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/fr/api/subscriptions/promotions/set-subject.md): 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. ### Basculer une promotion - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/toggle](https://developers.xsolla.com/fr/api/subscriptions/promotions/toggle-promotion.md): Bascule le statut d'une promotion de enabled à disabled et vice versa. 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. ## Coupons ### Créer une campagne - [POST /merchants/{merchant_id}/coupon_promotions](https://developers.xsolla.com/fr/api/subscriptions/coupons/create-campaign.md): Créez une nouvelle campagne de coupons. RemarqueCet 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. ### Ajouter un coupon à une campagne - [POST /merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons](https://developers.xsolla.com/fr/api/subscriptions/coupons/add-coupon-to-campaign.md): Ajoutez un code promo à une campagne de coupons. RemarqueCet 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. ### Lier une campagne à une promotion - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/coupons](https://developers.xsolla.com/fr/api/subscriptions/coupons/attach-campaign-to-promotion.md): Associez une campagne de coupons à une promotion spécifique. RemarqueCet 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. ### Lire un coupon - [GET /projects/{project_id}/coupons/{code}/details](https://developers.xsolla.com/fr/api/subscriptions/coupons/get-coupon.md): Récupération des informations sur le coupon par son code. ### Échanger un coupon - [POST /projects/{project_id}/coupons/{code}/redeem](https://developers.xsolla.com/fr/api/subscriptions/coupons/redeem-coupon.md): Utilisation d'un coupon par son code. ## Subscription management ### List subscriptions - [GET /api/user/v1/management/projects/{project_id}/subscriptions](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/list-subscriptions.md) ### Get management settings - [GET /api/user/v1/management/projects/{project_id}/subscriptions/settings](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/get-management-settings.md) ### Get subscription - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/get-management-subscription.md) ### Activate subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/activate](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/activate-subscription.md) ### Cancel subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/cancel](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/cancel-subscription.md) ### Get change plan link - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/change_plan](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/get-change-plan-link.md) ### Get payment account - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/get-payment-account.md) ### Manage payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account/manage](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/manage-payment-account.md) ### List payment accounts - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/list-payment-accounts.md) ### Link payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/link-payment-account.md) ### Unlink payment account - [DELETE /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts/{payment_account_id}](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/unlink-payment-account.md) ### List plans for change - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/list-plans-for-change.md) ### Get plan for change - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change/{plan_id}](https://developers.xsolla.com/fr/api/subscriptions/subscription-management/get-plan-for-change.md)