# Subscriptions API # Overview {% #overview %} * **Version:** 2.0 * **Servers**: `https://api.xsolla.com/merchant/v2/` This API reference describes endpoints for managing subscriptions, coupons, and promotions. To get more information about Subscriptions, see the [product guide](https://developers.xsolla.com/de/doc/subscriptions) and the [glossary](https://developers.xsolla.com/de/doc/subscriptions/integration-guide/get-started/#general_glossary). Version: 2.0 ## Security ### basicAuth Xsolla API uses basic access authentication. All requests to API must contain the `Authorization: Basic ` header, where `` is the `merchant_id:api_key` pair encoded according to the Base64 standard. Go to **[Xsolla Publisher Account](https://publisher.xsolla.com/) > Company settings** to find
Type: http Scheme: basic ### managementJwtAuth Type: http Scheme: bearer ### projectUserJwtAuth Type: http Scheme: bearer ## Download OpenAPI description [Subscriptions API](https://xsolla.redocly.app/_bundle/@l10n/de/api/subscriptions/index.yaml) ## Token ### Token erstellen - [POST /merchants/{merchant_id}/token](https://xsolla.redocly.app/de/api/subscriptions/admin_api_token/create-token.md): Sie können einen Token mit beliebigen Benutzerparametern erstellen. Diese Parameter senden Sie beim Erhalt des Tokens und erhalten sie nach einer erfolgreichen Zahlung zurück. Ein Token kann nur Parameter enthalten, die entweder in diesem Dokument beschrieben oder von Ihnen vordefiniert sind. Wenn ein Parameter im falschen Format gesendet wird oder den falschen Typ hat, wird kein Token ausgestellt. Sie erhalten einen 422-HTTP-Code mit der Fehlerbeschreibung im JSON-Body. In extended_message erhalten Sie eine Information, welche genauen Parameter falsch gesendet wurden. BemerkungDieser API-Aufruf enthält nicht den Pfadparameter project_id, daher müssen Sie zum Einrichten der Autorisierung den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist. ## Abo-Modelle ### List plans - [GET /projects/{project_id}/subscriptions/plans](https://xsolla.redocly.app/de/api/subscriptions/admin_api_plans/get-plans.md): Listet alle Abo-Modelle auf. ### Create plan - [POST /projects/{project_id}/subscriptions/plans](https://xsolla.redocly.app/de/api/subscriptions/admin_api_plans/create-plan.md): Legt ein Abo-Modell an. ### Disable plan - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_plans/disable-plan.md): Deaktiviert ein Abo-Modell. ### Enable plan - [PATCH /projects/{project_id}/subscriptions/plans/{plan_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_plans/enable-plan.md): Schaltet ein Abo-Modell aktiv. ### Update plan - [PUT /projects/{project_id}/subscriptions/plans/{plan_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_plans/update-plan-parameters.md): Aktualisiert die Abo-Modell-Parameter. ### Delete plan - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}/delete](https://xsolla.redocly.app/de/api/subscriptions/admin_api_plans/delete-plan.md): Löscht ein Abo-Modell. ## Produkte ### List products - [GET /projects/{project_id}/subscriptions/products](https://xsolla.redocly.app/de/api/subscriptions/admin_api_products/get-products.md): Listet alle abonnement-basierten Produkte auf. ### Create product - [POST /projects/{project_id}/subscriptions/products](https://xsolla.redocly.app/de/api/subscriptions/admin_api_products/create-product.md): Legt ein abonnement-basiertes Produkt an. ### Delete product - [DELETE /projects/{project_id}/subscriptions/products/{product_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_products/delete-product.md): Löscht ein abonnement-basiertes Produkt. ### Update product - [PUT /projects/{project_id}/subscriptions/products/{product_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_products/update-product.md): Aktualisiert ein abonnement-basiertes Produkt. ## Abonnements ### Get user account link - [POST /api/v1/projects/{projectId}/subscriptions/user_account](https://xsolla.redocly.app/de/api/subscriptions/admin_api_subscriptions/post-subscriptions-get-user-account-link.md) ### List subscriptions - [GET /merchants/{merchant_id}/subscriptions](https://xsolla.redocly.app/de/api/subscriptions/admin_api_subscriptions/get-subscriptions.md): Listet alle wiederkehrenden Abonnements auf.BemerkungDiese API-Methode kann bei hoher Belastung nicht verwendet werden. Die maximale Belastung beträgt 20 Anfragen pro Minute. BemerkungDieser API-Aufruf enthält nicht den Pfadparameter project_id, daher müssen Sie zum Einrichten der Autorisierung den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist. ### Get subscription - [GET /projects/{project_id}/subscriptions/{subscription_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_subscriptions/get-subscription.md): Ruft bestimmte Abonnementangaben mithilfe einer ID ab. ### Update subscription - [PUT /projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_subscriptions/update-subscription.md): Aktualisiert ein Abonnement, indem entweder dessen Status (active, canceled oder non_renewing) geändert oder das nächste Abrechnungsdatum zeitlich verschoben wird. ## Zahlungen ### List currencies - [GET /projects/{project_id}/subscriptions/currencies](https://xsolla.redocly.app/de/api/subscriptions/admin_api_payments/get-currencies.md): Listet alle unterstützten Abonnement-Währungen auf. ### List payments - [GET /projects/{project_id}/subscriptions/payments](https://xsolla.redocly.app/de/api/subscriptions/admin_api_payments/get-payments.md): Listet alle Abonnement-Zahlungen auf. ### List user payments - [GET /projects/{project_id}/users/{user_id}/subscriptions/payments](https://xsolla.redocly.app/de/api/subscriptions/admin_api_payments/get-user-payments.md): Listet alle getätigten Zahlungen eines bestimmten Benutzers auf. ## Werbeaktionen ### List promotions - [GET /merchants/{merchant_id}/promotions](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/get-promotions-list.md): Ruft die Liste der Projekte des Händlers ab. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Create promotion - [POST /merchants/{merchant_id}/promotions](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/create-promotion.md): Ruft die Liste der Projekte des Händlers ab. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Delete promotion - [DELETE /merchants/{merchant_id}/promotions/{promotion_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/delete-promotion.md): Ruft die Liste der Projekte des Händlers ab enabled =false. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Get promotion - [GET /merchants/{merchant_id}/promotions/{promotion_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/get-promotion.md): Ruft die Liste der Projekte des Händlers ab. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Update promotion - [PUT /merchants/{merchant_id}/promotions/{promotion_id}](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/update-promotion.md): Ruft die Liste der Projekte des Händlers ab. Wenn die Aktion schreibgeschützt ist(read_only = true), können Sie dürfen den Parameter project_id nicht ändern. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Get payment systems - [GET /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/get-payment-systems.md): Ruft die für eine Aktion unterstützten Zahlungssysteme ab. Wenn die Liste leer ist, gilt die Aktion für alle Zahlungssysteme. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Set payment systems - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/set-payment-systems.md): Legt die für eine Aktion unterstützten Zahlungssysteme fest. Wenn die Liste leer ist, gilt die Aktion für alle Zahlungssysteme. Wenn die Aktion schreibgeschützt ist (read_only = true), können Sie diese Methode nicht aufrufen. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Get validity periods - [GET /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/get-validity-periods.md): Ruft die Liste der Projekte des Händlers ab. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Set validity periods - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/set-validity-periods.md): Ruft die Liste der Projekte des Händlers ab. Wenn die Aktion schreibgeschützt ist(read_only = true), können Sie die Prämien nicht aktualisieren. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Review promotion - [GET /merchants/{merchant_id}/promotions/{promotion_id}/review](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/review-promotion.md): Ruft die Liste der Projekte des Händlers ab. Diese Methode gibt die Liste der Fehler zurück, sofern welche vorhanden sind. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Get rewards - [GET /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/get-rewards.md): Ruft die Liste der Projekte des Händlers ab. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Set rewards - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/set-rewards.md): Ruft die Liste der Projekte des Händlers ab. Wenn die Aktion schreibgeschützt ist(read_only = true), können Sie die Prämien nicht aktualisieren. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Get promotion scope - [GET /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/get-subject.md): Ruft die Liste der Projekte des Händlers ab. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Set promotion scope - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/set-subject.md): Ruft die Liste der Projekte des Händlers ab. Wenn die Aktion schreibgeschützt ist(read_only = true), können Sie die Prämien nicht aktualisieren. Das Subjekt kann folgende Werte annehmen:purchase, oder items, oderpackages. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Toggle promotion - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/toggle](https://xsolla.redocly.app/de/api/subscriptions/admin_api_promotions/toggle-promotion.md): Schaltet den Status einer Aktion von enabled auf disabled um und umgekehrt. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ## Gutscheine ### Create campaign - [POST /merchants/{merchant_id}/coupon_promotions](https://xsolla.redocly.app/de/api/subscriptions/admin_api_coupons/create-campaign.md): Ruft die Liste der Projekte des Händlers ab. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Add coupon to campaign - [POST /merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons](https://xsolla.redocly.app/de/api/subscriptions/admin_api_coupons/add-coupon-to-campaign.md): Ruft die Liste der Projekte des Händlers ab. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Attach campaign to promotion - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/coupons](https://xsolla.redocly.app/de/api/subscriptions/admin_api_coupons/attach-campaign-to-promotion.md): Ruft die Liste der Projekte des Händlers ab. Bemerkung Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten. ### Get coupon - [GET /projects/{project_id}/coupons/{code}/details](https://xsolla.redocly.app/de/api/subscriptions/admin_api_coupons/get-coupon.md): Fordert nähere Informationen zum Gutschein mit Hilfe seines Codes an. ### Redeem coupon - [POST /projects/{project_id}/coupons/{code}/redeem](https://xsolla.redocly.app/de/api/subscriptions/admin_api_coupons/admin-redeem-coupon.md): Einen Gutschein mittels seines Codes einlösen. ## Abonnements ### List active subscriptions - [GET /api/user/v1/projects/{project_id}/subscriptions](https://xsolla.redocly.app/de/api/subscriptions/client_api_subscriptions/get-user-active-subscriptions.md) ### Buy subscription - [POST /api/user/v1/projects/{project_id}/subscriptions/buy](https://xsolla.redocly.app/de/api/subscriptions/client_api_subscriptions/buy-subscription.md) ### Get management link - [POST /api/user/v1/projects/{project_id}/subscriptions/manage](https://xsolla.redocly.app/de/api/subscriptions/client_api_subscriptions/get-manage-subscriptions-link.md) ### Get user account link - [GET /api/user/v1/projects/{project_id}/subscriptions/user_account](https://xsolla.redocly.app/de/api/subscriptions/client_api_subscriptions/get-user-account-link.md) ### Get subscription - [GET /api/user/v1/projects/{project_id}/subscriptions/{subscription_id}](https://xsolla.redocly.app/de/api/subscriptions/client_api_subscriptions/get-user-subscription.md) ### Cancel subscription - [PUT /api/user/v1/projects/{project_id}/subscriptions/{subscription_id}/cancel](https://xsolla.redocly.app/de/api/subscriptions/client_api_subscriptions/cancel-user-subscription.md) ### Renew subscription - [POST /api/user/v1/projects/{project_id}/subscriptions/{subscription_id}/renew](https://xsolla.redocly.app/de/api/subscriptions/client_api_subscriptions/renew-user-subscription.md) ## Catalog ### List products (no auth) - [GET /api/public/v1/projects/{project_id}/products](https://xsolla.redocly.app/de/api/subscriptions/client_api_catalog/list-public-products.md) ### List plans by product (no auth) - [GET /api/public/v1/projects/{project_id}/products/{productId}/user_plans](https://xsolla.redocly.app/de/api/subscriptions/client_api_catalog/list-public-plans-by-product.md) ### List plans (no auth) - [GET /api/public/v1/projects/{project_id}/user_plans](https://xsolla.redocly.app/de/api/subscriptions/client_api_catalog/list-public-plans.md) ### Get catalog - [GET /api/user/v1/projects/{project_id}/catalog](https://xsolla.redocly.app/de/api/subscriptions/client_api_catalog/get-subscriptions-catalog.md) ### List plans - [GET /api/user/v1/projects/{project_id}/plans](https://xsolla.redocly.app/de/api/subscriptions/client_api_catalog/get-subscription-plans.md) ### List products - [GET /api/user/v1/projects/{project_id}/products](https://xsolla.redocly.app/de/api/subscriptions/client_api_catalog/get-subscription-products.md) ### List plans by product - [GET /api/user/v1/projects/{project_id}/products/{productId}/plans](https://xsolla.redocly.app/de/api/subscriptions/client_api_catalog/get-subscription-plans-by-product.md) ## Gutscheine ### Redeem coupon - [POST /api/user/v1/projects/{project_id}/redeem_coupon](https://xsolla.redocly.app/de/api/subscriptions/client_api_coupons/redeem-coupon.md) ## Abonnements ### List subscriptions - [GET /api/user/v1/management/projects/{project_id}/subscriptions](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_subscriptions/list-subscriptions.md) ### Get management settings - [GET /api/user/v1/management/projects/{project_id}/subscriptions/settings](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_subscriptions/get-management-settings.md) ### Get subscription - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_subscriptions/get-management-subscription.md) ### Activate subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/activate](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_subscriptions/activate-subscription.md) ### Cancel subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/cancel](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_subscriptions/cancel-subscription.md) ### Get change plan link - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/change_plan](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_subscriptions/get-change-plan-link.md) ### List plans for change - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_subscriptions/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://xsolla.redocly.app/de/api/subscriptions/user_management_api_subscriptions/get-plan-for-change.md) ## Payment accounts ### Get payment account - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_payment-accounts/get-payment-account.md) ### Manage payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account/manage](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_payment-accounts/manage-payment-account.md) ### List payment accounts - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_payment-accounts/list-payment-accounts.md) ### Link payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_payment-accounts/link-payment-account.md) ### Unlink payment account - [DELETE /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts/{payment_account_id}](https://xsolla.redocly.app/de/api/subscriptions/user_management_api_payment-accounts/unlink-payment-account.md)