Перейти к содержимому
/
Unlink payment account

Subscriptions API (2.0)

Введение

  • Версия: 2.0
  • Серверы: https://api.xsolla.com/merchant/v2/

Этот справочник API описывает методы для управления подписками, купонами и акциями. Подробная информация о продукте Subscriptions приведена в руководстве по продукту и глоссарии.

Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/subscriptions/

Токен

Операции

Планы

Операции

Продукты

Операции

Subscription management

Операции

Платежи

Операции

Акции

Операции

Купоны

Операции

Subscription management

Операции

List plans for change

Запрос

Безопасность
subscriptionsManagementJwtAuth
Путь
subscription_idinteger\d+обязательный
project_idinteger\d+обязательный
Запрос
limitinteger
offsetinteger
localestring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change?limit=0&offset=0&locale=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

List of available plans for change

Телоapplication/json
has_morebooleanобязательный
Пример: "false"
itemsArray of objects(PlanResponse)
По умолчанию []
items[].​chargeobject(Charge4)обязательный
items[].​charge.​amountnumber(float)обязательный
Пример: "4.99"
items[].​charge.​currencystringобязательный
Пример: "USD"
items[].​charge.​setup_feenumber or null(float)
Пример: "0.99"
items[].​periodobject(Period4)обязательный
items[].​period.​unitstring or null
По умолчанию null
Пример: "month"
items[].​period.​valueinteger or null
По умолчанию null
Пример: "1"
items[].​plan_descriptionstringобязательный
Пример: "Localized plan description"
items[].​plan_end_datestring or null(date-time)
Пример: "2031-04-11T13:51:02+03:00"
items[].​plan_external_idstringобязательный
Пример: "PlanExternalId"
items[].​plan_group_idstring or null
Пример: "TestGroupId"
items[].​plan_idintegerобязательный
Пример: "54321"
items[].​plan_namestringобязательный
Пример: "Localized plan name"
items[].​plan_start_datestring or null(date-time)
Пример: "2021-04-11T13:51:02+03:00"
items[].​plan_typestringобязательный
Пример: "all"
items[].​promotionobject(Promotion2)обязательный
items[].​promotion.​promotion_charge_amountnumber or null(float)
По умолчанию null
Пример: "3.99"
items[].​promotion.​promotion_remaining_chargesinteger or null
По умолчанию null
Пример: "3"
items[].​trial_periodinteger or null
Пример: "7"
Ответ
application/json
{
  "has_more": "false",
  "items": []
}