Zum Inhalt springen
/
Abonnement aktualisieren

Subscriptions API (2.0)

Ü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 und in der Begriffserläuterung.

OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/subscriptions/

Token

Operationen

Abo-Modelle

Operationen

Produkte

Operationen

Subscription management

Operationen

Abonnement abrufen

Anfrage

Ruft bestimmte Abonnementangaben mithilfe einer ID ab.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

subscription_idintegererforderlich

Abonnement-ID.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'

Antworten

OK.

Bodyapplication/json
charge_amountnumber(float)

Abrechnungsbetrag.

commentstring

Grund für die Änderung des Abonnementstatus

currencystring

Kaufwährung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

date_createstring(datetime)

Abschlussdatum des Abonnements im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.

date_endstring(datetime)

Enddatum de Abonnements im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.

date_last_chargestring or null(datetime)

Datum der letzten Abozahlung im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.

date_next_chargestring or null(datetime)

Datum der nächsten Abozahlung im Format "JJJJ-MM-TT’T’HH:MM:SS" gemäß ISO 8601.

idinteger

Abonnement-ID

planobject
productobject or null
statusstring

Status

Enum"new""active""canceled""non_renewing""freeze"
userobject
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"
  }
}

Abonnement aktualisieren

Anfrage

Aktualisiert ein Abonnement, indem entweder dessen Status (active, canceled oder non_renewing) geändert oder das nächste Abrechnungsdatum zeitlich verschoben wird.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

user_idstringerforderlich

Benutzer-ID.

subscription_idintegererforderlich

Abonnement-ID.

Bodyapplication/jsonerforderlich
cancel_subscription_paymentboolean

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.

statusstring

Status.

Enum"active""canceled""non_renewing"
timeshiftobject

Zeitliche Zurückstellung der Abrechnung.

xsolla_networkobject
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"
  }'

Antworten

OK.

Bodyapplication/json
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"
  }
}

Zahlungen

Operationen

Werbeaktionen

Operationen

Gutscheine

Operationen

Subscription management

Operationen