# Subscriptions API # Überblick * **Version:** 2.0 * **Servers**: `https://api.xsolla.com/merchant/v2/` Diese API-Referenz beschreibt Endpunkte für die Verwaltung von Abonnements, Gutscheinen und Werbeaktionen. Weitere Informationen über Subscriptions finden Sie in der [Produktanleitung](https://developers.xsolla.com/de/doc/subscriptions) und in der [Begriffserläuterung](https://developers.xsolla.com/de/doc/subscriptions/integration-guide/get-started/#general_glossary). Version: 2.0 ## Security ### basicAuth Die Xsolla-API verwendet die Basisauthentifizierung. Alle Anfragen an die API müssen den Header `Authorization: Basic ` enthalten, wobei `` das `merchant_id:api_key`-Paar ist, das gemäß dem Base64-Standard kodiert ist. Diese Parameter finden Sie im [Kundenportal](https://publisher.xsolla.com/):
Weitere Informationen über die Arbeit mit API-Schlüsseln finden Sie in der [API-Referenz](https://developers.xsolla.com/de/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/de/api/subscriptions/index.yaml) ## Token ### Token erstellen - [POST /merchants/{merchant_id}/token](https://developers.xsolla.com/de/api/subscriptions/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 ### Abo-Modelle abrufen - [GET /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/de/api/subscriptions/plans/get-plans.md): Listet alle Abo-Modelle auf. ### Create Plan - [POST /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/de/api/subscriptions/plans/create-plan.md): Legt ein Abo-Modell an. ### Abo-Modell deaktivieren - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/de/api/subscriptions/plans/disable-plan.md): Deaktiviert ein Abo-Modell. ### Abo-Modell aktivieren - [PATCH /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/de/api/subscriptions/plans/enable-plan.md): Schaltet ein Abo-Modell aktiv. ### Abo-Modell aktualisieren - [PUT /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/de/api/subscriptions/plans/update-plan-parameters.md): Aktualisiert die Abo-Modell-Parameter. ### Abo-Modell löschen - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}/delete](https://developers.xsolla.com/de/api/subscriptions/plans/delete-plan.md): Löscht ein Abo-Modell. ## Produkte ### Get Products - [GET /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/de/api/subscriptions/products/get-products.md): Listet alle abonnement-basierten Produkte auf. ### Create Product - [POST /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/de/api/subscriptions/products/create-product.md): Legt ein abonnement-basiertes Produkt an. ### Produkt löschen - [DELETE /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/de/api/subscriptions/products/delete-product.md): Löscht ein abonnement-basiertes Produkt. ### Produkt aktualisieren - [PUT /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/de/api/subscriptions/products/update-product.md): Aktualisiert ein abonnement-basiertes Produkt. ## Subscription management ### Abonnements abrufen - [GET /merchants/{merchant_id}/subscriptions](https://developers.xsolla.com/de/api/subscriptions/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. ### Abonnement abrufen - [GET /projects/{project_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/de/api/subscriptions/subscriptions/get-subscription.md): Ruft bestimmte Abonnementangaben mithilfe einer ID ab. ### Abonnement aktualisieren - [PUT /projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/de/api/subscriptions/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 ### Währungen abrufen - [GET /projects/{project_id}/subscriptions/currencies](https://developers.xsolla.com/de/api/subscriptions/payments/get-currencies.md): Listet alle unterstützten Abonnement-Währungen auf. ### Zahlungen abrufen - [GET /projects/{project_id}/subscriptions/payments](https://developers.xsolla.com/de/api/subscriptions/payments/get-payments.md): Listet alle Abonnement-Zahlungen auf. ### Benutzerdaten anfordern - [GET /projects/{project_id}/users/{user_id}/subscriptions/payments](https://developers.xsolla.com/de/api/subscriptions/payments/get-user-payments.md): Listet alle getätigten Zahlungen eines bestimmten Benutzers auf. ## Werbeaktionen ### Liste der Werbeaktionen abrufen - [GET /merchants/{merchant_id}/promotions](https://developers.xsolla.com/de/api/subscriptions/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. ### Werbeaktion anlegen - [POST /merchants/{merchant_id}/promotions](https://developers.xsolla.com/de/api/subscriptions/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. ### Werbeaktion löschen - [DELETE /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/de/api/subscriptions/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. ### Werbeaktion anfordern - [GET /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/de/api/subscriptions/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. ### Werbeaktion aktualisieren - [PUT /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/de/api/subscriptions/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. ### Zahlungssysteme auflisten - [GET /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/de/api/subscriptions/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. ### Zahlungssysteme festlegen - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/de/api/subscriptions/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. ### Geltungszeiträume auflisten - [GET /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/de/api/subscriptions/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. ### Geltungszeiträume festlegen - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/de/api/subscriptions/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. ### Werbeaktion überprüfen - [GET /merchants/{merchant_id}/promotions/{promotion_id}/review](https://developers.xsolla.com/de/api/subscriptions/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. ### Belohnungen abrufen - [GET /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/de/api/subscriptions/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. ### Belohnungen festlegen - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/de/api/subscriptions/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. ### Thema anfordern - [GET /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/de/api/subscriptions/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. ### Thema festlegen - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/de/api/subscriptions/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. ### Werbeaktion zu-/abschalten - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/toggle](https://developers.xsolla.com/de/api/subscriptions/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 ### Kampagne erstellen - [POST /merchants/{merchant_id}/coupon_promotions](https://developers.xsolla.com/de/api/subscriptions/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. ### Gutschein zur Kampagne hinzufügen - [POST /merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons](https://developers.xsolla.com/de/api/subscriptions/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. ### Kampagne mit einer Werbeaktion verbinden - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/coupons](https://developers.xsolla.com/de/api/subscriptions/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. ### Gutschein anfordern - [GET /projects/{project_id}/coupons/{code}/details](https://developers.xsolla.com/de/api/subscriptions/coupons/get-coupon.md): Fordert nähere Informationen zum Gutschein mit Hilfe seines Codes an. ### Einen Gutschein einlösen - [POST /projects/{project_id}/coupons/{code}/redeem](https://developers.xsolla.com/de/api/subscriptions/coupons/redeem-coupon.md): Einen Gutschein mittels seines Codes einlösen. ## Subscription management ### List subscriptions - [GET /api/user/v1/management/projects/{project_id}/subscriptions](https://developers.xsolla.com/de/api/subscriptions/subscription-management/list-subscriptions.md) ### Get management settings - [GET /api/user/v1/management/projects/{project_id}/subscriptions/settings](https://developers.xsolla.com/de/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/de/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/de/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/de/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/de/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/de/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/de/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/de/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/de/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/de/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/de/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/de/api/subscriptions/subscription-management/get-plan-for-change.md)