Zum Inhalt springen
/
Abo-Modell löschen

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-Modell aktualisieren

Anfrage

Aktualisiert die Abo-Modell-Parameter.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

plan_idintegererforderlich

ID des Abo-Modells.

Bodyapplication/jsonerforderlich
billing_retryobject

Details zu erneuten Abrechnungsversuchen.

billing_retry.​valueintegererforderlich

Anzahl der erneuten Abrechnungsversuche.

chargeobject

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.

charge.​prices[].​amountnumber(float)erforderlich

Abrechnungsbetrag.

charge.​prices[].​currencystringerforderlich

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

charge.​prices[].​setup_feenumber(float)

Einmalige Einrichtungsgebühr, die als Teil der ersten Rechnung berechnet wird.

descriptionobject

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

description.​arstring

Arabisch.

description.​bgstring

Bulgarisch.

description.​cnstring

Chinesisch (vereinfacht).

description.​csstring

Tschechisch.

description.​destring

Deutsch.

description.​enstring

Englisch.

description.​esstring

Spanisch.

description.​frstring

Französisch.

description.​hestring

Hebräisch.

description.​itstring

Italienisch.

description.​jastring

Japanisch.

description.​kostring

Koreanisch.

description.​plstring

Polnisch.

description.​ptstring

Portugiesisch.

description.​rostring

Rumänisch.

description.​rustring

Russisch.

description.​thstring

Thai.

description.​trstring

Türkisch.

description.​twstring

Chinesisch (traditionell).

description.​vistring

Vietnamesisch.

expirationobject

Details zum Auslaufen des Abonnements.

expiration.​typestringerforderlich

Zeiteinheit. Möglich sind day oder month.

Enum"day""month"
expiration.​valueinteger or nullerforderlich

Zeitliche Gültigkeit.

external_idstring

Externe ID des Abo-Modells (32 Zeichen).

grace_periodobject

Angaben zur Übergangsfrist.

grace_period.​typestringerforderlich

Zeiteinheit. Möglich sind day.

Wert"day"
grace_period.​valueintegererforderlich

Anzahl der Zeiteinheiten.

group_idstring

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

nameobject

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.

refund_periodinteger or null

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

statusobject
status.​valuestring

Status des Abo-Modells.

Enum"active""disabled"
tagsArray of strings

Abo-Modell-Markierungen.

trialobject

Details zum Probezeitraum. Wird dieser Parameter nicht übermittelt, wird der Standardwert (0 Tage) verwendet.

trial.​typestringerforderlich

Zeiteinheit. Möglich sind day.

Wert"day"
trial.​valueintegererforderlich

Anzahl der Zeiteinheiten.

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

Antworten

OK.

Bodyapplication/json
Antwort
application/json
{
  "billing_retry": {
    "value": 1
  },
  "charge": {
    "amount": 20,
    "currency": "USD",
    "period": { … },
    "prices": [ … ]
  },
  "description": {
    "en": "3x more experience!"
  },
  "expiration": {
    "type": "day",
    "value": 0
  },
  "external_id": "exp",
  "grace_period": {
    "type": "day",
    "value": 2
  },
  "group_id": null,
  "id": 241082,
  "localized_name": "Experience boost",
  "name": {
    "en": "Experience boost"
  },
  "project_id": 40797,
  "refund_period": null,
  "status": {
    "value": "active"
  },
  "tags": [],
  "trial": {
    "type": "day",
    "value": 7
  },
  "type": "all"
}

Abo-Modell löschen

Anfrage

Löscht 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}/delete'

Antworten

No Content (Kein Inhalt).

Produkte

Operationen

Subscription management

Operationen

Zahlungen

Operationen

Werbeaktionen

Operationen

Gutscheine

Operationen

Subscription management

Operationen