Begrenzung der Elementanzahl auf der Seite.
Subscriptions API (2.0)
- 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 und in der Begriffserläuterung.
OpenAPI-Beschreibung herunterladen
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/subscriptions/
Anfrage
Listet alle wiederkehrenden Abonnements auf.
Bemerkung
Diese API-Methode kann bei hoher Belastung nicht verwendet werden. Die maximale Belastung beträgt 20 Anfragen pro Minute.
Diese API-Methode kann bei hoher Belastung nicht verwendet werden. Die maximale Belastung beträgt 20 Anfragen pro Minute.
Bemerkung
Dieser 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.
Sicherheit
basicAuth
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/subscriptions
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/subscriptions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/subscriptions?offset=0&limit=0&user_id=string&project_id%5B%5D=0&plan_id%5B%5D=0&product_id%5B%5D=0&group_id%5B%5D=string&status%5B%5D=active&datetime_from=string&datetime_to=string'OK.
Abschlussdatum des Abonnements im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.
Enddatum de Abonnements im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.
Datum der letzten Abozahlung im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.
Datum der nächsten Abozahlung im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.
Details zu erneuten Abrechnungsversuchen.
Details zur Abrechnung.
Beschreibung zum Abo-Modell. Besteht aus Paaren vom Typ "localization":"plan description" (Sprache:Beschreibung zum Abo-Modell).
Details zum Auslaufen des Abonnements.
Angaben zur Übergangsfrist.
Bezeichnung des Abo-Modells. Besteht aus Paaren vom Typ "localization":"plan name" (Sprache:Bezeichnung des Abo-Modells).
Zeitraum, in dem der Nutzer die Zahlung für ein Abo-Modell erstattet bekommen kann (in Tagen).
Lokalisierte Beschreibungen des Gegenstands.
Antwort
application/json
[ { "charge_amount": 0.03, "currency": "USD", "date_create": "2013-09-05T15:27:47+04:00", "date_end": "2014-02-06T11:32:48+04:00", "date_last_charge": null, "date_next_charge": null, "id": 45, "plan": { … }, "product": { … }, "status": "canceled", "user": { … } } ]
- https://api.xsolla.com/merchant/v2/projects/{project_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'OK.
Abschlussdatum des Abonnements im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.
Enddatum de Abonnements im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.
Datum der letzten Abozahlung im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.
Datum der nächsten Abozahlung im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.
Details zu erneuten Abrechnungsversuchen.
Details zur Abrechnung.
Beschreibung zum Abo-Modell. Besteht aus Paaren vom Typ "localization":"plan description" (Sprache:Beschreibung zum Abo-Modell).
Details zum Auslaufen des Abonnements.
Angaben zur Übergangsfrist.
Bezeichnung des Abo-Modells. Besteht aus Paaren vom Typ "localization":"plan name" (Sprache:Bezeichnung des Abo-Modells).
Zeitraum, in dem der Nutzer die Zahlung für ein Abo-Modell erstattet bekommen kann (in Tagen).
Lokalisierte Beschreibungen des Gegenstands.
Antwort
application/json
{ "charge_amount": 0.03, "comment": "The subscription was not extended in due time", "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": "2019-02-06T12:43:04+03:00", "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 249579, "plan": { "external_id": "lowcost", "id": 601 }, "product": { "id": 123456 }, "status": "canceled", "user": { "id": "user1", "name": "John Smith" } }
Bodyapplication/jsonerforderlich
Ist true festgelegt, so wird die letzte, für dieses Abonnement getätigte Zahlung zurückerstattet. Funktioniert nur dann, wenn zugleich der Status auf canceled gesetzt ist.
Zeitliche Zurückstellung der Abrechnung.
Kooperationspartner-ID – Influencer- oder Affiliate-Netzwerk-Kennung. Diese finden Sie im Kundenportal unter Partner Network > Influencer.
- https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}' \
-H 'Content-Type: application/json' \
-d '{
"status": "active"
}'Antwort
application/json
{ "charge_amount": 0.03, "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": null, "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 24953579, "plan": { "billing_retry": { … }, "charge": { … }, "description": null, "expiration": { … }, "external_id": "lowcost", "grace_period": { … }, "group_id": "newPlans", "id": 66001, "localized_name": null, "name": null, "project_id": 18404, "refund_period": null, "status": { … }, "tags": null, "trial": { … }, "type": "all" }, "product": null, "status": "active", "user": { "id": "jb1", "name": "J.Black" } }