Zum Inhalt springen

Ü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
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/subscriptions/
Operationen
Operationen

Anfrage

Schaltet ein Abo-Modell aktiv.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

plan_idintegererforderlich

ID des Abo-Modells.

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

Antworten

No Content (Kein Inhalt).

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.

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

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).

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. Wird dieser Parameter nicht übermittelt, wird der Standardwert (0 Tage) verwendet.

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

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).

Operationen
Operationen
Operationen
Operationen
Operationen
Operationen