Zum Inhalt springen

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

Zahlungen

Operationen

Währungen abrufen

Anfrage

Listet alle unterstützten Abonnement-Währungen auf.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

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

Antworten

OK.

Bodyapplication/json
Antwort
application/json
[
  "AED",
  "ALL",
  "AMD",
  "ARS",
  "AUD",
  "AZN",
  "BAM",
  "BBD",
  "BGN",
  "BHD",
  "BND",
  "BRL",
  "BYN",
  "BZD",
  "CAD",
  "CHF",
  "CLP",
  "CNY",
  "COP",
  "CRC",
  "CZK",
  "DKK",
  "DZD",
  "EGP",
  "EUR",
  "GBP",
  "GEL",
  "GHS",
  "GIP",
  "GTQ",
  "HKD",
  "HRK",
  "HUF",
  "IDR",
  "ILS",
  "INR",
  "IQD",
  "IRR",
  "ISK",
  "JMD",
  "JOD",
  "JPY",
  "KES",
  "KGS",
  "KRW",
  "KWD",
  "KZT",
  "LAK",
  "LBP",
  "LKR",
  "MAD",
  "MDL",
  "MKD",
  "MMK",
  "MNT",
  "MUR",
  "MXN",
  "MYR",
  "NGN",
  "NIO",
  "NOK",
  "NPR",
  "NZD",
  "OMR",
  "PAB",
  "PEN",
  "PHP",
  "PKR",
  "PLN",
  "PYG",
  "QAR",
  "RON",
  "RSD",
  "RUB",
  "SAR",
  "SEK",
  "SGD",
  "SVC",
  "THB",
  "TND",
  "TRY",
  "TWD",
  "UAH",
  "USD",
  "UYU",
  "UZS",
  "VEF",
  "VND",
  "XOF",
  "YER",
  "ZAR"
]

Zahlungen abrufen

Anfrage

Listet alle Abonnement-Zahlungen auf.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

Abfrage
offsetinteger

Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).

limitintegererforderlich

Begrenzung der Elementanzahl auf der Seite.

user_idstring

Benutzer-ID.

statusstring

Transaktionsstatus.

Enum WertBeschreibung
done

Die Zahlung wurde erfolgreich verarbeitet.

fail

Die Zahlung wurde nicht erfolgreich verarbeitet oder es wurde eine Erstattung veranlasst.

datetime_fromstring(datetime)

Beginn des Zeitraums.

datetime_tostring(datetime)

Ende des Zeitraums.

subscription_idinteger

Abonnement-ID.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/subscriptions/payments?offset=0&limit=0&user_id=string&status=done&datetime_from=string&datetime_to=string&subscription_id=0'

Antworten

OK.

Bodyapplication/json
Antwort
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 67683,
    "id_payment": 203960,
    "status": "fail",
    "subscription": { … }
  },
  {
    "date_payment": "2015-09-21T17:06:47+03:00",
    "id": 1531,
    "id_payment": 168866,
    "status": "done",
    "subscription": { … }
  }
]

Benutzerdaten anfordern

Anfrage

Listet alle getätigten Zahlungen eines bestimmten Benutzers auf.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

user_idstringerforderlich

Benutzer-ID.

Abfrage
statusstring

Transaktionsstatus.

Enum WertBeschreibung
done

Die Zahlung wurde erfolgreich verarbeitet.

fail

Die Zahlung wurde nicht erfolgreich verarbeitet oder es wurde eine Erstattung veranlasst.

offsetinteger

Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).

limitintegererforderlich

Begrenzung der Elementanzahl auf der Seite.

datetime_fromstring(datetime)

Abfragedatum. Damit findet man Abonnements, die nach dem angegebenen Datum erstellt wurden.

datetime_tostring(datetime)

Abfragedatum. Damit findet man Abonnements, die nach dem angegebenen Datum erstellt wurden.

subscription_idinteger

Abonnement-ID.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/payments?status=done&offset=0&limit=0&datetime_from=string&datetime_to=string&subscription_id=0'

Antworten

OK.

Bodyapplication/json
Antwort
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 6746083,
    "id_payment": 202789960,
    "status": "fail",
    "subscription": { … }
  }
]

Werbeaktionen

Operationen

Gutscheine

Operationen

Subscription management

Operationen