Zum Inhalt springen
/
Belohnungen festlegen

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

Werbeaktionen

Operationen

Belohnungen abrufen

Anfrage

Ruft die Liste der Projekte des Händlers ab.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

promotion_idintegererforderlich

ID der Werbeaktion.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards'

Antworten

OK.

Bodyapplication/json
idinteger
itemobject

Legt die Belohnung für bestimmte virtuelle Gegenstände fest.

item.​bonusArray of objects

Zusätzliche virtuelle Gegenstände, die als Bonus verteilt werden.

item.​bonus[].​idinteger
item.​bonus[].​localized_namestring

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

item.​bonus[].​quantityinteger

Anzahl der virtuellen Gegenstände, die als Bonus verteilt werden.

item.​bonus[].​skustring

SKU des Gegenstands.

item.​discountArray of objects

Rabatte für bestimmte virtuelle Gegenstände.

item.​discount[].​discount_percentnumber(float)

Prozentualer Rabatt.

item.​discount[].​localized_namestring

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

item.​discount[].​max_amountnumber(integer)

Maximale Anzahl an Gegenständen, die für die Werbeaktion verwendet wird.

item.​discount[].​skustring

SKU des Gegenstands.

packageobject

Legt die Belohnung für ein virtuelles Währungspaket fest.

package.​bonus_amountnumber(float)

Belohnung als absolute Menge der virtuellen Währung.

package.​bonus_percentnumber(float)

Belohnung als Prozentsatz der Paketmenge.

purchaseobject

Legt die Belohnung für den gesamten Einkauf fest.

purchase.​discount_percentnumber(float)

Prozentualer Rabatt.

subscriptionobject

Legt die Belohnung für ein Abonnement fest.

subscription.​trial_daysinteger

Probezeitraum in Tagen.

Antwort
application/json
{
  "id": 17840,
  "item": {
    "bonus": [ … ],
    "discount": [ … ]
  },
  "package": {
    "bonus_amount": 5,
    "bonus_percent": 5
  },
  "purchase": {
    "discount_percent": 10
  },
  "subscription": {
    "trial_days": 30
  }
}

Belohnungen festlegen

Anfrage

Ruft die Liste der Projekte des Händlers ab. Wenn die Aktion schreibgeschützt ist(read_only = true), können Sie die Prämien nicht aktualisieren.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

promotion_idintegererforderlich

ID der Werbeaktion.

Bodyapplication/jsonerforderlich
itemobject

Legt die Belohnung für bestimmte virtuelle Gegenstände fest.

item.​bonusArray of objects

Zusätzliche virtuelle Gegenstände, die als Bonus verteilt werden.

item.​bonus[].​idinteger
item.​bonus[].​localized_namestring

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

item.​bonus[].​quantityinteger

Anzahl der virtuellen Gegenstände, die als Bonus verteilt werden.

item.​bonus[].​skustring

SKU des Gegenstands.

item.​discountArray of objects

Rabatte für bestimmte virtuelle Gegenstände.

item.​discount[].​discount_percentnumber(float)

Prozentualer Rabatt.

item.​discount[].​localized_namestring

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

item.​discount[].​max_amountnumber(integer)

Maximale Anzahl an Gegenständen, die für die Werbeaktion verwendet wird.

item.​discount[].​skustring

SKU des Gegenstands.

packageobject

Legt die Belohnung für ein virtuelles Währungspaket fest.

package.​bonus_amountnumber(float)

Belohnung als absolute Menge der virtuellen Währung.

package.​bonus_percentnumber(float)

Belohnung als Prozentsatz der Paketmenge.

purchaseobject

Legt die Belohnung für den gesamten Einkauf fest.

purchase.​discount_percentnumber(float)

Prozentualer Rabatt.

subscriptionobject

Legt die Belohnung für ein Abonnement fest.

subscription.​trial_daysinteger

Probezeitraum in Tagen.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards' \
  -H 'Content-Type: application/json' \
  -d '{
    "item": {
      "bonus": [
        {
          "quantity": 2,
          "sku": "1234"
        }
      ],
      "discount": [
        {
          "discount_percent": 5,
          "max_amount": 10,
          "sku": "1234"
        }
      ]
    },
    "package": {
      "bonus_amount": 5,
      "bonus_percent": 5
    },
    "purchase": {
      "discount_percent": 10
    },
    "subscription": {
      "trial_days": 30
    }
  }'

Antworten

No Content (Kein Inhalt).

Thema anfordern

Anfrage

Ruft die Liste der Projekte des Händlers ab.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

promotion_idintegererforderlich

ID der Werbeaktion.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject'

Antworten

OK.

Bodyapplication/json
digital_contentsobject or null
itemsArray of objects

Array der virtuellen Gegenstände, die bei der Werbeaktion zum Einsatz kommen.

items[].​idinteger
items[].​localized_namestring

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

items[].​skustring

SKU des Gegenstands.

packagesArray of objects or null

Array der Angebotspakete mit virtueller Währung, die bei der Werbeaktion zum Einsatz kommen.

purchaseboolean

Legt fest, ob die Werbeaktion auf den gesamten Einkauf zutrifft.

subscriptionsobject or null

Abo-Modelle oder Produkte, die bei der Werbeaktion zum Einsatz kommen.

subscriptions.​max_charges_countinteger

Maximale Anzahl an Abrechnungen, die bei der Werbeaktion möglich sein soll.

subscriptions.​plansArray of strings
subscriptions.​productsArray of strings
idinteger
Antwort
application/json
{
  "digital_contents": null,
  "id": 178,
  "items": [
    { … }
  ],
  "packages": null,
  "purchase": false,
  "subscriptions": null
}

Gutscheine

Operationen

Subscription management

Operationen