Zum Inhalt springen
/
Abo-Modelle abrufen

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

Abo-Modelle abrufen

Anfrage

Listet alle Abo-Modelle auf.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

Abfrage
plan_idinteger

ID des Abo-Modells.

limitintegererforderlich

Begrenzung der Elementanzahl auf der Seite.

offsetinteger

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

external_idstring

Externe ID des Abo-Modells (32 Zeichen).

group_idstring

Gruppen-ID, mit der die Abo-Modelle verknüpft sind.

product_idinteger

Produkt-ID, mit der die Abo-Modelle verknüpft sind.

querystring

Suchanfrage (Suche name.en (Standard-Gebietsschema)).

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/subscriptions/plans?plan_id=0&limit=0&offset=0&external_id=string&group_id=string&product_id=0&query=string'

Antworten

OK.

Bodyapplication/jsonArray [
billing_retryobject

Details zu erneuten Abrechnungsversuchen.

chargeobject

Details zur Abrechnung.

descriptionobject

Beschreibung zum Abo-Modell. Besteht aus Paaren vom Typ "localization":"plan description" (Sprache:Beschreibung zum Abo-Modell).

expirationobject

Details zum Auslaufen des Abonnements.

external_idstring

Externe ID des Abo-Modells (32 Zeichen).

grace_periodobject

Angaben zur Übergangsfrist.

group_idstring or null

Gruppen-ID, mit der das Abo-Modell verknüpft ist.

idinteger

ID des Abo-Modells.

nameobject

Bezeichnung des Abo-Modells. Besteht aus Paaren vom Typ "localization":"plan name" (Sprache:Bezeichnung des Abo-Modells).

project_idinteger

Projekt-ID.

refund_periodinteger or null

Zeitraum, in dem der Nutzer die Zahlung für ein Abo-Modell erstattet bekommen kann (in Tagen).

statusobject
tagsArray of strings

Abo-Modell-Markierungen.

trialobject

Details zum Probezeitraum.

localized_namestring

Name des Abo-Modells in der Standardsprache (en), repliziert den Wert name.en.

]
Antwort
application/json
[
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "3b355320",
    "grace_period": { … },
    "group_id": null,
    "id": 241037,
    "localized_name": "Platinum VIP",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  },
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "0fe1b6fc",
    "grace_period": { … },
    "group_id": null,
    "id": 241038,
    "localized_name": "Gold Status",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  }
]

Create Plan

Anfrage

Legt ein Abo-Modell an.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

Bodyapplication/jsonerforderlich
billing_retryobject

Details zu erneuten Abrechnungsversuchen.

chargeobjecterforderlich

Details zur Abrechnung.

charge.​amountnumber(float)

Abrechnungsbetrag.

charge.​currencystring

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

charge.​periodobjecterforderlich

Abrechnungszeitraum.

charge.​period.​typestringerforderlich

Zeiteinheit. Möglich sind day, month oder lifetime.

Enum"day""month""lifetime"
charge.​period.​valueintegererforderlich

Anzahl der Zeiteinheiten. Der Wert hängt vom Parametertyp ab, möglich sind:
- von 1 bis 366, sofern für type day festgelegt ist
- von 1 bis 12, sofern für type month festgelegt ist
-0, sofern für type lifetime festgelegt ist

charge.​pricesArray of objects

Liste der Preise in verschiedenen Währungen.

descriptionobject

Beschreibung zum Abo-Modell. Besteht aus Paaren vom Typ "localization":"plan description" (Sprache:Beschreibung zum Abo-Modell).

expirationobject

Details zum Auslaufen des Abonnements.

external_idstring

Externe ID des Abo-Modells (32 Zeichen).

grace_periodobject

Angaben zur Übergangsfrist.

group_idstring or null

Gruppen-ID, mit der das Abo-Modell verknüpft ist.

idinteger

ID des Abo-Modells.

nameobjecterforderlich

Bezeichnung des Abo-Modells. Besteht aus Paaren vom Typ "localization":"plan name" (Sprache:Bezeichnung des Abo-Modells).

name.​arstring

Arabisch.

name.​bgstring

Bulgarisch.

name.​cnstring

Chinesisch (vereinfacht).

name.​csstring

Tschechisch.

name.​destring

Deutsch.

name.​enstring

Englisch.

name.​esstring

Spanisch.

name.​frstring

Französisch.

name.​hestring

Hebräisch.

name.​itstring

Italienisch.

name.​jastring

Japanisch.

name.​kostring

Koreanisch.

name.​plstring

Polnisch.

name.​ptstring

Portugiesisch.

name.​rostring

Rumänisch.

name.​rustring

Russisch.

name.​thstring

Thai.

name.​trstring

Türkisch.

name.​twstring

Chinesisch (traditionell).

name.​vistring

Vietnamesisch.

project_idinteger

Projekt-ID.

refund_periodinteger or null

Zeitraum, in dem der Nutzer die Zahlung für ein Abo-Modell erstattet bekommen kann (in Tagen).

statusobject
tagsArray of strings

Abo-Modell-Markierungen.

trialobject

Details zum Probezeitraum.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/subscriptions/plans' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_retry": {
      "value": 1
    },
    "charge": {
      "amount": 10,
      "currency": "USD",
      "period": {
        "type": "month",
        "value": 1
      },
      "prices": [
        {
          "amount": 8,
          "currency": "EUR",
          "setup_fee": 1.5
        },
        {
          "amount": 1000,
          "currency": "JPY",
          "setup_fee": 2.5
        }
      ]
    },
    "description": {
      "en": "2x more experience!"
    },
    "expiration": {
      "type": "day",
      "value": null
    },
    "external_id": "exp",
    "grace_period": {
      "type": "day",
      "value": 2
    },
    "name": {
      "en": "Experience boost"
    },
    "refund_period": null,
    "status": {
      "value": "active"
    },
    "trial": {
      "type": "day",
      "value": 7
    }
  }'

Antworten

Erstellt.

Bodyapplication/json
external_idstring
plan_idinteger
Antwort
application/json
{
  "external_id": "exp",
  "plan_id": 241082
}

Abo-Modell deaktivieren

Anfrage

Deaktiviert ein Abo-Modell.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

plan_idintegererforderlich

ID des Abo-Modells.

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

Antworten

No Content (Kein Inhalt).

Produkte

Operationen

Subscription management

Operationen

Zahlungen

Operationen

Werbeaktionen

Operationen

Gutscheine

Operationen

Subscription management

Operationen