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

Token erstellen

Anfrage

Sie können einen Token mit beliebigen Benutzerparametern erstellen. Diese Parameter senden Sie beim Erhalt des Tokens und erhalten sie nach einer erfolgreichen Zahlung zurück. Ein Token kann nur Parameter enthalten, die entweder in diesem Dokument beschrieben oder von Ihnen vordefiniert sind.

Wenn ein Parameter im falschen Format gesendet wird oder den falschen Typ hat, wird kein Token ausgestellt. Sie erhalten einen 422-HTTP-Code mit der Fehlerbeschreibung im JSON-Body. In extended_message erhalten Sie eine Information, welche genauen Parameter falsch gesendet wurden.

Bemerkung

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

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

Bodyapplication/jsonerforderlich
custom_parametersobject

Sie können zusätzliche Parameter im Token im custom_parameters-Objekt übermitteln, um Betrugsschutzfilter zu konfigurieren. Die empfohlenen Parameter werden in der Drop-down-Liste angezeigt. Siehe Pay-Station-Dokumentation .

custom_parameters.​active_datestring

Letztmalig online; Datum gemäß ISO 8601.

custom_parameters.​additional_verificationboolean

Filtert danach, ob der Spieler Konto-Verifikationsverfahren verwendet.

custom_parameters.​character_customizedboolean

Filtert danach, ob der Spieler seinen Charakter individuell angepasst hat.

custom_parameters.​chat_activityboolean

Filtert danach, ob der Spieler die Chatfunktion verwendet.

custom_parameters.​completed_tasksinteger

Anzahl der erledigten Aufgaben bzw. erreichten Ziele.

custom_parameters.​forum_activityboolean

Filtert danach, ob der Spieler die Chatfunktion verwendet.

custom_parameters.​items_usedboolean

Filtert danach, ob der Spieler im Spiel gekaufte Gegenstände verwendet.

custom_parameters.​karma_pointsinteger

Karma des Spielers.

custom_parameters.​last_change_password_datestring

Datum der letzten Kennwortänderung; Datumsangabe gemäß ISO 8601.

custom_parameters.​non_premium_currencyinteger(float)

Betrag der gewöhnlichen ("non-premium") Währung.

custom_parameters.​notifications_enabledboolean

Filtert danach, ob der Spieler den Erhalt von Benachrichtigungen aktiviert hat.

custom_parameters.​profile_completedboolean

Filtert danach, ob der Spieler auf seinem Profil zusätzliche Informationen hinzugefügt hat.

custom_parameters.​profile_image_addedboolean

Filtert danach, ob der Spieler ein Profilbild hochgeladen hat.

custom_parameters.​pvp_activityboolean

Filtert danach, ob der Spieler an PvP-Schlachten teilnimmt.

custom_parameters.​registration_datestring

Datum der Kontoerstellung gemäß ISO 8601.

custom_parameters.​session_timestring

Durchschnittliche Sitzungsdauer, Angabe gemäß ISO 8601.

custom_parameters.​social_networks_addedboolean

Filtert danach, ob der Spieler Profile von sozialen Netzwerken verknüpft hat.

custom_parameters.​total_bansinteger

Filtert danach, wie oft der Spieler im Chat/Forum gesperrt wurde.

custom_parameters.​total_charactersinteger

Anzahl der Charaktere im Spiel.

custom_parameters.​total_clansinteger

Anzahl der Clans, bei denen der Spieler Mitglied ist.

custom_parameters.​total_friendsinteger

Anzahl der Freunde.

custom_parameters.​total_game_eventsinteger

Anzahl der Ingame-Events, an denen der Spieler teilgenommen hat.

custom_parameters.​total_giftsinteger

Anzahl der Geschenke im Spiel, die der Spieler verschickt/erhalten hat.

custom_parameters.​total_hoursinteger

Gesamtzahl der Spielstunden.

custom_parameters.​total_inventory_valueinteger(float)

Gesamtwert des Inventars (in Ingame-Währung).

custom_parameters.​total_suminteger(float)

Gesamtbetrag der Zahlungen.

custom_parameters.​tutorial_completedboolean

Filtert danach, ob der Spieler das Tutorial des Spiels absolviert hat.

custom_parameters.​unlocked_achievementsinteger

Anzahl an freigeschalteten Errungenschaften.

custom_parameters.​user_levelinteger

Level, Ansehen oder Rang des Spielers.

custom_parameters.​win_rateinteger

Gewinnquote.

purchaseobject

Objekt, welches Angaben zum Kauf enthält.

Beispiel: {"checkout":{"amount":10,"currency":"USD"},"subscription":{"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}}
purchase.​checkoutobject

Objekt, welches Angaben zur Bezahlung enthält.

Beispiel: {"amount":10,"currency":"USD"}
purchase.​checkout.​amountinteger(float)

Kaufbetrag.

Beispiel: 10
purchase.​checkout.​currencystring

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

Beispiel: "USD"
purchase.​subscriptionobject

Daten zum Abonnement (Objekt).

Beispiel: {"gift":{"email":"recipient_email@email.com","recipient":"test_recipient_v1"}}
purchase.​subscription.​available_plansArray of strings

Abonnement-Modelle (Array), die im Zahlungsportal angezeigt werden sollen.

purchase.​subscription.​currencystring

Währung des Abo-Modells, die bei allen Kalkulationen verwendet werden soll.

purchase.​subscription.​giftobject

Details des Geschenkabonnements.

Beispiel: {"email":"recipient_email@email.com","recipient":"test_recipient_v1"}
purchase.​subscription.​gift.​anonymousboolean

Ob der Name des Geschenkgebers verborgen werden soll. Wenn true, ist der Name des Geschenkgebers in der E-Mail-Benachrichtigung nicht sichtbar. Standardwert ist false.

purchase.​subscription.​gift.​emailstringerforderlich

E-Mail-Adresse des Empfängers.

Beispiel: "recipient_email@email.com"
purchase.​subscription.​gift.​messagestring

Nachricht für den Empfänger.

purchase.​subscription.​gift.​recipientstringerforderlich

ID des Empfängers.

Beispiel: "test_recipient_v1"
purchase.​subscription.​gift.​redirect_urlstring

Geben Sie hier einen Link zu einer Seite mit zusätzlichen Informationen über das Geschenkabonnement oder zur Seite für die Kontoerstellung an. Der Geschenkempfänger kann von der E-Mail-Benachrichtigung aus zu dieser Seite navigieren.

purchase.​subscription.​operationstring

Diese Operationsart kommt beim Abo-Modell des Nutzers zur Anwendung. Zur Änderung des Abo-Modells muss der change_plan-Wert übermittelt werden. Sie müssen die ID des neuen Abo-Modells im purchase.subscription.plan_id-Parameter festlegen.

purchase.​subscription.​plan_idstring

Externe ID des Abo-Modells. Diese finden Sie im Kundenportal unter Subscriptions > Abo-Modelle.

purchase.​subscription.​product_idstring

Produkt-ID.

purchase.​subscription.​trial_daysinteger

Probezeitraum in Tagen.

settingsobject

Benutzerdefinierte Projekteinstellungen (Objekt).

Beispiel: {"currency":"USD","language":"en","project_id":16184,"ui":{"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}}
settings.​currencystring

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

Beispiel: "USD"
settings.​external_idstring

Transaktions-ID im Spiel. Eine individuelle ID pro Benutzerzahlung erforderlich.

settings.​languagestring

Sprache der Benutzeroberfläche. Sprachencode, bestehend aus 2 Kleinbuchstaben.

Beispiel: "en"
settings.​modestring

Legen Sie als Wert sandbox fest, um den Zahlungsvorgang auszutesten. Für einen solchen Fall nutzen Sie https://sandbox-secure.xsolla.com, um das Zahlungsportal auszutesten.

settings.​payment_methodinteger

ID der Zahlungsart.

settings.​payment_widgetstring

Zahlungs-Widget. Kann paybycash oder giftcard sein. Wenn der Parameter festgelegt ist, wird der Benutzer entsprechend zum Widget "Pay by Cash" oder zum Widget "Gift Cards" weitergeleitet.

Enum"paybycash""giftcard"
settings.​project_idintegererforderlich

Xsolla-ID des Spiels. Kann im Kundenportal eingesehen werden.

Beispiel: 16184
settings.​redirect_policyobject

Weiterleitungsrichtlinien-Einstellungen (Objekt).

settings.​redirect_policy.​autoredirect_from_status_pageboolean

Legt fest, ob die Weiterleitung von der Statusseite automatisch erfolgt.

settings.​redirect_policy.​delayinteger

Verzögerung (in Sekunden), nach der ein Benutzer automatisch zur Rückgabe-URL weitergeleitet wird.

settings.​redirect_policy.​manual_redirection_actionstring

Das Verhalten der Pay Station wird ausgelöst, wenn der Benutzer auf die Schaltfläche Schließen oder die Schaltfläche Zurück zum Spiel klickt. Kann redirect (standardmäßig) und postmessage sein. Wenn auf redirect gesetzt, wird ein Benutzer zu der im Token übergebenen oder im Kundenportal angegebenen URL umgeleitet. Wenn er auf postmessage gesetzt ist, wird ein Benutzer nicht auf andere Seiten umgeleitet. Durch Klicken auf das Schließen-Symbol wird das close Ereignis gesendet, und durch Klicken auf die Schaltfläche Zurück zum Spiel - das return Ereignis.

Enum"redirect""postmessage"
settings.​redirect_policy.​redirect_button_captionstring

Text auf der Schaltfläche für die manuelle Weiterleitung.

settings.​redirect_policy.​redirect_conditionsstring

Zahlungsstatus, bei dem ein Benutzer zur Rückgabe-URL weitergeleitet wird. Möglich sind: none, successful, successful_or_canсeled oder any.

Enum"none""successful""successful_or_canceled""any"
settings.​redirect_policy.​status_for_manual_redirectionstring

Zahlungsstatus, bei dem eine Schaltfläche angezeigt wird, die einen Benutzer zur Rückgabe-URL weiterleitet. Möglich sind: none, successful, successful_or_canсeled oder any.

Enum"none""successful""successful_or_canceled""any"
settings.​return_urlstring

Seite, zu welcher der Benutzer nach der Zahlung weitergeleitet wird. Die folgenden Parameter werden dem Link automatisch hinzugefügt: user_id, foreigninvoice, invoice_id, status.

settings.​uiobject

Schnittstellen-Einstellungen (Objekt).

Beispiel: {"components":{"virtual_currency":{"custom_amount":true}},"desktop":{"virtual_item_list":{"button_with_price":true,"layout":"list"}},"size":"medium"}
settings.​ui.​componentsobject

Menü-Einstellungen (Objekt).

Beispiel: {"virtual_currency":{"custom_amount":true}}
settings.​ui.​components.​subscriptionsobject

Untermenü "Abo-Modelle" (Objekt).

settings.​ui.​components.​subscriptions.​hiddenboolean

Legt fest, ob das Untermenü angezeigt wird.

settings.​ui.​components.​subscriptions.​orderinteger

Position des Untermenüs im Hauptmenü.

settings.​ui.​components.​virtual_currencyobject

Untermenü "Virtuelle Währung".

Beispiel: {"custom_amount":true}
settings.​ui.​components.​virtual_currency.​custom_amountboolean

Legt fest, ob der Benutzer eine willkürliche Menge der virtuellen Währung im Zahlungsportal eingeben kann.

Beispiel: true
settings.​ui.​components.​virtual_currency.​hiddenboolean

Legt fest, ob das Untermenü angezeigt wird.

settings.​ui.​components.​virtual_currency.​orderinteger

Position des Untermenüs im Hauptmenü.

settings.​ui.​components.​virtual_itemsobject

Untermenü "Virtuelle Gegenstände".

settings.​ui.​components.​virtual_items.​hiddenboolean

Legt fest, ob das Untermenü angezeigt wird.

settings.​ui.​components.​virtual_items.​orderinteger

Position des Untermenüs im Hauptmenü.

settings.​ui.​components.​virtual_items.​selected_groupstring

Gruppe, die nach dem Öffnen der Registerkarte "Virtuelle Gegenstände" angezeigt wird.

settings.​ui.​components.​virtual_items.​selected_itemstring

Gegenstand, der nach dem Öffnen der Registerkarte "Virtuelle Gegenstände" angezeigt wird (SKU des Gegenstands).

settings.​ui.​desktopobject

Schnittstellen-Einstellungen für die Desktop-Version (Objekt).

Beispiel: {"virtual_item_list":{"button_with_price":true,"layout":"list"}}
settings.​ui.​desktop.​headerobject

Einstellungen für den Header (Objekt).

settings.​ui.​desktop.​header.​close_buttonboolean

Legt fest, ob eine Schließen-Schaltfläche in der Desktop-Version der Pay Station angezeigt wird. Die Schaltfläche schließt die Pay Station und leitet den Benutzer an die im settings.return_url-Parameter angegebene URL weiter. Standardmäßig ist false voreingestellt.

settings.​ui.​desktop.​header.​is_visibleboolean

Legt fest, ob der Header im Zahlungsportal angezeigt wird.

settings.​ui.​desktop.​header.​typestring

Erscheinungsbild des Headers. Als Wert lässt sich entweder compact (Projektname und Benutzer-ID sind ausgeblendet) oder normal (voreingestellt) festlegen.

Enum"compact""normal"
settings.​ui.​desktop.​header.​visible_logoboolean

Wenn true festgelegt ist, wird im Header Ihr Logo angezeigt (dafür müssen Sie das Bild zuerst Ihrem Customer Success Manager übermitteln).

settings.​ui.​desktop.​header.​visible_nameboolean

Legt fest, ob der Projektname im Header angezeigt wird.

settings.​ui.​desktop.​header.​visible_purchaseboolean

Legt fest, ob die Kaufbeschreibung (purchase.description.value) im Header angezeigt wird. true ist voreingestellt.

settings.​ui.​desktop.​subscription_listobject

Einstellungen zur Liste der Abo-Modelle (Objekt).

settings.​ui.​desktop.​subscription_list.​descriptionstring

Jeglicher Text, der im Zahlungsportal oberhalb der Liste der verfügbaren Abo-Modelle angezeigt werden soll.

settings.​ui.​desktop.​subscription_list.​display_local_priceboolean

Falls als Wert true festgelegt ist und falls die Landeswährung des Benutzers sich von der für das Abo-Modell festgelegten Währung unterscheidet, werden dem Benutzer beide Preise angezeigt: Einer in der Landes- und der andere in der Basiswährung.

settings.​ui.​desktop.​subscription_list.​layoutstring

Listenvorlage. Als Wert lässt sich entweder list (voreingestellt) oder grid festlegen.

Enum"list""grid"
settings.​ui.​desktop.​virtual_currency_listobject

Einstellungen zur Liste der virtuellen Währungen (Objekt).

settings.​ui.​desktop.​virtual_currency_list.​button_with_priceboolean

Falls als Wert true festgelegt ist, wird der Preis auf der Schaltfläche angezeigt. Falls false festgelegt ist, wird der Preis links neben der Schaltfläche angezeigt. Standardwert ist false.

settings.​ui.​desktop.​virtual_currency_list.​descriptionstring

Jeglicher Text, zur Anzeige oberhalb der Liste der virtuellen Währungen.

settings.​ui.​desktop.​virtual_item_listobject

Einstellungen zur Liste der virtuellen Gegenstände (Objekt).

Beispiel: {"button_with_price":true,"layout":"list"}
settings.​ui.​desktop.​virtual_item_list.​button_with_priceboolean

Falls als Wert true festgelegt ist, wird der Preis auf der Schaltfläche angezeigt. Falls false festgelegt ist, wird der Preis links neben der Schaltfläche angezeigt. Standardwert ist false.

Beispiel: true
settings.​ui.​desktop.​virtual_item_list.​layoutstring

Listenvorlage. Als Wert lässt sich entweder list (voreingestellt) oder grid festlegen.

Enum"list""grid"
Beispiel: "list"
settings.​ui.​desktop.​virtual_item_list.​viewstring

Virtuelle Gruppe an Elementen in vertikalem/horizontalem Menü anzeigen. Es kann horizontal_navigation oder vertical_navigation (Standard) sein.

Enum"horizontal_navigation""vertical_navigation"
settings.​ui.​headerobject
settings.​ui.​header.​visible_virtual_currency_balanceboolean

Legt fest, ob dieses Element im Zahlungsportal ausgeblendet werden kann. true voreingestellt.

settings.​ui.​is_prevent_external_link_openboolean

Ob die Umleitung von Links auf eine externe Ressource deaktiviert ist oder nicht. true standardmäßig. Wenn Sie auf einen externen Link klicken, wird das external-link-open Ereignis über den postMessage Mechanismus gesendet. Die Adresse für den umgeleiteten Link wird im url Parameter übergeben.

settings.​ui.​license_urlstring

Link zur EULA.

settings.​ui.​mobileobject
settings.​ui.​mobile.​footerobject
settings.​ui.​mobile.​footer.​is_visibleboolean

Legt fest, ob der Footer in der mobilen Version des Zahlungsportals ausgeblendet ist.

settings.​ui.​mobile.​headerobject
settings.​ui.​mobile.​header.​close_buttonboolean

Legt fest, ob eine Schließen-Schaltfläche in der Mobil-Version der Pay Station angezeigt wird. Die Schaltfläche schließt die Pay Station und leitet den Benutzer an die im settings.return_url-Parameter angegebene URL weiter. Standardmäßig ist false voreingestellt.

settings.​ui.​mobile.​modestring

Ein Benutzer kann nur mit seinen gespeicherten Zahlungsarten bezahlen. Als Wert lässt sich lediglich saved_accounts festlegen.

Wert"saved_accounts"
settings.​ui.​modestring

Schnittstellenmodus in der Pay Station. Als Wert lässt sich lediglich user_account festlegen: Der Header enthält ausschließlich die Navigationsleiste des Benutzerkontos und der Benutzer kann kein Produkt auswählen oder eine Zahlung tätigen. Dieser Modus ist nur in der Desktop-Version verfügbar.

settings.​ui.​sizestring

Größe des Zahlungsportals. Folgende Größen sind möglich:

  • small: die kleinstmögliche Größe des Zahlungsportals. Verwenden Sie diese, wenn die Fenstergröße begrenzt ist (Abmessungen: 620 x 630)
  • medium: empfohlene Größe. Verwenden Sie diese, um das Zahlungsportal in einer Lightbox darzustellen (Abmessungen: 820 x 840)
  • large: optimal für die Anzeige des Zahlungsportals in einem neuen Fenster/Registerkarte (Abmessungen: 820 x 840)
Enum"small""medium""large"
Beispiel: "medium"
settings.​ui.​themestring

Theme des Zahlungsportals. Als Wert lässt sich entweder default (voreingestellt) oder default_dark festlegen.

Enum"default""default_dark"
settings.​ui.​user_accountobject

Details zum Benutzerkonto (Objekt).

settings.​ui.​user_account.​historyobject

Untermenü Historie.

settings.​ui.​user_account.​history.​enableboolean

Legt fest, ob das Untermenü angezeigt wird. Standardwert ist false.

settings.​ui.​user_account.​history.​orderinteger

Position des Untermenüs im Hauptmenü.

settings.​ui.​user_account.​infoobject

Seite Mein Konto.

settings.​ui.​user_account.​info.​enableboolean

Legt fest, ob das Untermenü angezeigt wird. Standardwert ist false.

settings.​ui.​user_account.​info.​orderinteger

Position des Untermenüs im Hauptmenü.

settings.​ui.​user_account.​payment_accountsobject

Untermenü Meine Zahlungsarten.

settings.​ui.​user_account.​payment_accounts.​enableboolean

Legt fest, ob das Untermenü angezeigt wird. Standardwert ist false.

settings.​ui.​user_account.​payment_accounts.​orderinteger

Position des Untermenüs im Hauptmenü.

settings.​ui.​user_account.​subscriptionsobject

Untermenü Abonnements verwalten.

settings.​ui.​user_account.​subscriptions.​enableboolean

Legt fest, ob das Untermenü angezeigt wird. Standardwert ist false.

settings.​ui.​user_account.​subscriptions.​orderinteger

Position des Untermenüs im Hauptmenü.

settings.​ui.​versionstring

Gerätetyp. Als Wert lässt sich entweder desktop (voreingestellt) oder mobile festlegen.

Enum"desktop""mobile"
userobject

Benutzerdaten (Objekt).

Beispiel: {"age":19,"country":{"allow_modify":true,"value":"US"},"email":{"value":"john.smith@mail.com"},"id":{"value":"user_2"},"name":{"value":"John Smith"}}
user.​ageinteger

Alter des Benutzers.

Beispiel: 19
user.​attributesobject

Benutzerattribute zum Filtern der Liste der Gegenstände; repräsentiert durch eine gültige Reihe von JSON-Objekten bestehend aus Schlüssel-Wert-Paaren.

user.​countryobject
Beispiel: {"allow_modify":true,"value":"US"}
user.​country.​allow_modifyboolean

Legt fest, ob ein Benutzer das Land im Zahlungsportal ändern darf. Wenn country.value im Token übermittelt wird, ist der Wert standardmäßig auf false gestellt.

Beispiel: true
user.​country.​valuestring

Ländercode, bestehend aus 2 Großbuchstaben gemäß ISO 3166-1 ALPHA-2.

Beispiel: "US"
user.​emailobject

Das user.email Objekt ist ein integraler Bestandteil beim Aufbau von Anti-Betrugsmodellen und hilft, die Akzeptanzraten zu erhöhen. Es ist sowohl für Xsolla als auch für Zahlungssysteme erforderlich. Wenn der Parameter nicht übergeben wird, erscheint auf der Bezahlseite das Pflichtfeld zur Eingabe der E-Mail. Ein Benutzer erhält eine Kaufbestätigung an die im Parameter übergebene oder auf der Bezahlseite eingegebene E-Mail.

Beispiel: {"value":"john.smith@mail.com"}
user.​email.​valuestringerforderlich

E-Mail-Adresse des Benutzers. Muss gemäß RFC 822-Protokoll gültig sein.

Beispiel: "john.smith@mail.com"
user.​idobjecterforderlich
Beispiel: {"value":"user_2"}
user.​id.​valuestringerforderlich

Benutzer-ID.

Beispiel: "user_2"
user.​is_legalboolean

Legt fest, ob der Benutzer eine juristische Person ist.

user.​legalobject

Objekt mit Angaben zur juristischen Person. Objekt und alle seine Parameter sind erforderlich, falls für user.is_legal true festgelegt ist.

user.​legal.​addressstring

Vollständige Unternehmensanschrift.

user.​legal.​countrystring

Land des Unternehmenssitzes. Ländercode, bestehend aus 2 Großbuchstaben gemäß ISO 3166-1 ALPHA-2.

user.​legal.​namestring

Vollständiger Name des Unternehmens.

user.​legal.​vat_idstring

Steuerliche Identifikationsnummer.

user.​nameobject
Beispiel: {"value":"John Smith"}
user.​name.​valuestring

Benutzername.

Beispiel: "John Smith"
user.​phoneobject
user.​phone.​valuestring

Telefonnummer des Benutzers.

user.​public_idobject
user.​public_id.​valuestring

Parameter, durch den der Benutzer eindeutig identifizierbar ist und der dem Benutzer bekannt ist (E-Mail, Benutzername, usw.). Gestattet dem Benutzer, Käufe außerhalb des Game-Stores zu tätigen (z. B. via Verkaufsterminals).

user.​steam_idobject
user.​steam_id.​valuestring

Steam-ID.

user.​tracking_idobject
user.​tracking_id.​valuestring

Eindeutige Tracking-ID (wird bei Marketingkampagnen verwendet).

user.​utmobject

Datenverkehrsattribute (Objekt).

user.​utm.​utm_campaignstring

Kampagnenbezeichnung, ins Englische transliteriert oder übersetzt.

user.​utm.​utm_contentstring

Kampagneninhalt.

user.​utm.​utm_mediumstring

Datenverkehrskanal (kontextbezogene Anzeigen, mediale Anzeigen, E-Mail-Listen, usw.).

user.​utm.​utm_sourcestring

Ursprung des Datenverkehrs.

user.​utm.​utm_termstring

Kampagnen-Keyword. Falls festgelegt, basieren die Statistiken auf den Keywords, die für die Zielgruppenwerbung verwendet werden, anstatt auf spezifischen Suchanfragen. In Google Analytics ist der angegebene utm_term Teil des allgemeinen Berichts zu Suchbegriffen.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/token' \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "checkout": {
        "amount": 10,
        "currency": "USD"
      },
      "subscription": {
        "gift": {
          "email": "recipient_email@email.com",
          "recipient": "test_recipient_v1"
        }
      }
    },
    "settings": {
      "currency": "USD",
      "language": "en",
      "project_id": 16184,
      "ui": {
        "components": {
          "virtual_currency": {
            "custom_amount": true
          }
        },
        "desktop": {
          "virtual_item_list": {
            "button_with_price": true,
            "layout": "list"
          }
        },
        "size": "medium"
      }
    },
    "user": {
      "age": 19,
      "country": {
        "allow_modify": true,
        "value": "US"
      },
      "email": {
        "value": "john.smith@mail.com"
      },
      "id": {
        "value": "user_2"
      },
      "name": {
        "value": "John Smith"
      }
    }
  }'

Antworten

Created.

Bodyapplication/json
tokenstring
Antwort
application/json
{
  "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}

Abo-Modelle

Operationen

Produkte

Operationen

Subscription management

Operationen

Zahlungen

Operationen

Werbeaktionen

Operationen

Gutscheine

Operationen

Subscription management

Operationen