Zum Inhalt springen
/
List plans (no auth)

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

Abonnements

Operationen

Zahlungen

Operationen

Werbeaktionen

Operationen

Gutscheine

Operationen

Abonnements

Operationen

Catalog

Operationen

List plans by product (no auth)

Anfrage

Pfad
project_idinteger\d+erforderlich
productIdstringerforderlich
Abfrage
plan_idArray of integers
plan_external_idArray of strings
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/api/public/v1/projects/{project_id}/products/{productId}/user_plans?plan_id=0&plan_external_id=string&limit=0&offset=0&locale=string&country=string'

Antworten

Subscription's plans by product

Bodyapplication/json
has_morebooleanerforderlich
Beispiel: "false"
itemsArray of objects
Standard []
items[].​chargeobjecterforderlich
items[].​charge.​amountnumber(float)erforderlich
Beispiel: 4.99
items[].​charge.​currencystringerforderlich
Beispiel: "USD"
items[].​charge.​setup_feenumber(float)erforderlich
Beispiel: 0.99
items[].​periodobjecterforderlich
items[].​period.​unitstring or null
Standard null
Beispiel: "month"
items[].​period.​valueinteger or null
Standard null
Beispiel: "1"
items[].​plan_descriptionstringerforderlich
Beispiel: "Localized plan description"
items[].​plan_end_datestring or null(date-time)
Beispiel: "2031-04-11T13:51:02+03:00"
items[].​plan_external_idstringerforderlich
Beispiel: "PlanExternalId"
items[].​plan_group_idstring or null
Beispiel: "TestGroupId"
items[].​plan_idintegererforderlich
Beispiel: "54321"
items[].​plan_namestringerforderlich
Beispiel: "Localized plan name"
items[].​plan_start_datestring or null(date-time)
Beispiel: "2021-04-11T13:51:02+03:00"
items[].​plan_typestringerforderlich
Beispiel: "all"
items[].​promotionobjecterforderlich
items[].​promotion.​promotion_charge_amountnumber or null(float)
Standard null
Beispiel: "3.99"
items[].​promotion.​promotion_remaining_chargesinteger or null
Standard null
Beispiel: "3"
items[].​trial_periodinteger or null
Beispiel: "7"
Antwort
application/json
{
  "has_more": "false",
  "items": []
}

List plans (no auth)

Anfrage

Pfad
project_idinteger\d+erforderlich
Abfrage
plan_idArray of integers
plan_external_idArray of strings
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/api/public/v1/projects/{project_id}/user_plans?plan_id=0&plan_external_id=string&limit=0&offset=0&locale=string&country=string'

Antworten

Subscription's default plans

Bodyapplication/json
has_morebooleanerforderlich
Beispiel: "false"
itemsArray of objects
Standard []
items[].​chargeobjecterforderlich
items[].​charge.​amountnumber(float)erforderlich
Beispiel: 4.99
items[].​charge.​currencystringerforderlich
Beispiel: "USD"
items[].​charge.​setup_feenumber(float)erforderlich
Beispiel: 0.99
items[].​periodobjecterforderlich
items[].​period.​unitstring or null
Standard null
Beispiel: "month"
items[].​period.​valueinteger or null
Standard null
Beispiel: "1"
items[].​plan_descriptionstringerforderlich
Beispiel: "Localized plan description"
items[].​plan_end_datestring or null(date-time)
Beispiel: "2031-04-11T13:51:02+03:00"
items[].​plan_external_idstringerforderlich
Beispiel: "PlanExternalId"
items[].​plan_group_idstring or null
Beispiel: "TestGroupId"
items[].​plan_idintegererforderlich
Beispiel: "54321"
items[].​plan_namestringerforderlich
Beispiel: "Localized plan name"
items[].​plan_start_datestring or null(date-time)
Beispiel: "2021-04-11T13:51:02+03:00"
items[].​plan_typestringerforderlich
Beispiel: "all"
items[].​promotionobjecterforderlich
items[].​promotion.​promotion_charge_amountnumber or null(float)
Standard null
Beispiel: "3.99"
items[].​promotion.​promotion_remaining_chargesinteger or null
Standard null
Beispiel: "3"
items[].​trial_periodinteger or null
Beispiel: "7"
Antwort
application/json
{
  "has_more": "false",
  "items": []
}

Get catalog

Anfrage

Sicherheit
projectUserJwtAuth
Pfad
project_idinteger\d+erforderlich
Abfrage
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/api/user/v1/projects/{project_id}/catalog?limit=0&offset=0&locale=string&country=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Antworten

Subscription's catalog

Bodyapplication/json
default_plansobjecterforderlich
default_plans.​has_morebooleanerforderlich
Beispiel: "false"
default_plans.​itemsArray of objects
Standard []
default_plans.​items[].​chargeobjecterforderlich
default_plans.​items[].​charge.​amountnumber(float)erforderlich
Beispiel: 4.99
default_plans.​items[].​charge.​currencystringerforderlich
Beispiel: "USD"
default_plans.​items[].​charge.​setup_feenumber(float)erforderlich
Beispiel: 0.99
default_plans.​items[].​periodobjecterforderlich
default_plans.​items[].​period.​unitstring or null
Standard null
Beispiel: "month"
default_plans.​items[].​period.​valueinteger or null
Standard null
Beispiel: "1"
default_plans.​items[].​plan_descriptionstringerforderlich
Beispiel: "Localized plan description"
default_plans.​items[].​plan_end_datestring or null(date-time)
Beispiel: "2031-04-11T13:51:02+03:00"
default_plans.​items[].​plan_external_idstringerforderlich
Beispiel: "PlanExternalId"
default_plans.​items[].​plan_group_idstring or null
Beispiel: "TestGroupId"
default_plans.​items[].​plan_idintegererforderlich
Beispiel: "54321"
default_plans.​items[].​plan_namestringerforderlich
Beispiel: "Localized plan name"
default_plans.​items[].​plan_start_datestring or null(date-time)
Beispiel: "2021-04-11T13:51:02+03:00"
default_plans.​items[].​plan_typestringerforderlich
Beispiel: "all"
default_plans.​items[].​promotionobjecterforderlich
default_plans.​items[].​promotion.​promotion_charge_amountnumber or null(float)
Standard null
Beispiel: "3.99"
default_plans.​items[].​promotion.​promotion_remaining_chargesinteger or null
Standard null
Beispiel: "3"
default_plans.​items[].​trial_periodinteger or null
Beispiel: "7"
default_plans.​namestring or null
Beispiel: "Some product name"
has_morebooleanerforderlich
Beispiel: "false"
plans_by_productArray of objects
Standard []
plans_by_product[].​has_morebooleanerforderlich
Beispiel: "false"
plans_by_product[].​itemsArray of objects
Standard []
plans_by_product[].​items[].​chargeobjecterforderlich
plans_by_product[].​items[].​charge.​amountnumber(float)erforderlich
Beispiel: 4.99
plans_by_product[].​items[].​charge.​currencystringerforderlich
Beispiel: "USD"
plans_by_product[].​items[].​charge.​setup_feenumber(float)erforderlich
Beispiel: 0.99
plans_by_product[].​items[].​periodobjecterforderlich
plans_by_product[].​items[].​period.​unitstring or null
Standard null
Beispiel: "month"
plans_by_product[].​items[].​period.​valueinteger or null
Standard null
Beispiel: "1"
plans_by_product[].​items[].​plan_descriptionstringerforderlich
Beispiel: "Localized plan description"
plans_by_product[].​items[].​plan_end_datestring or null(date-time)
Beispiel: "2031-04-11T13:51:02+03:00"
plans_by_product[].​items[].​plan_external_idstringerforderlich
Beispiel: "PlanExternalId"
plans_by_product[].​items[].​plan_group_idstring or null
Beispiel: "TestGroupId"
plans_by_product[].​items[].​plan_idintegererforderlich
Beispiel: "54321"
plans_by_product[].​items[].​plan_namestringerforderlich
Beispiel: "Localized plan name"
plans_by_product[].​items[].​plan_start_datestring or null(date-time)
Beispiel: "2021-04-11T13:51:02+03:00"
plans_by_product[].​items[].​plan_typestringerforderlich
Beispiel: "all"
plans_by_product[].​items[].​promotionobjecterforderlich
plans_by_product[].​items[].​promotion.​promotion_charge_amountnumber or null(float)
Standard null
Beispiel: "3.99"
plans_by_product[].​items[].​promotion.​promotion_remaining_chargesinteger or null
Standard null
Beispiel: "3"
plans_by_product[].​items[].​trial_periodinteger or null
Beispiel: "7"
plans_by_product[].​namestring or null
Beispiel: "Some product name"
Antwort
application/json
{
  "default_plans": {
    "has_more": "false",
    "items": [],
    "name": "Some product name"
  },
  "has_more": "false",
  "plans_by_product": []
}

Gutscheine

Operationen

Abonnements

Operationen

Payment accounts

Operationen