Перейти к содержимому

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/

Токен

Операции

Планы

Операции

Список планов

Запрос

Список рекуррентных планов.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта.

Запрос
plan_idinteger

ID плана подписки.

limitintegerобязательный

Лимит количества элементов на странице.

offsetinteger

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

external_idstring

Внешний идентификатор плана.

group_idstring

ID группы, к которой привязаны планы.

product_idinteger

ID продукта, к которому привязаны планы.

querystring

Поисковый запрос (поиск name.en (язык по умолчанию)).

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/plans?plan_id=0&limit=0&offset=0&external_id=string&group_id=string&product_id=0&query=string'

Ответы

OK.

Телоapplication/jsonArray [
billing_retryobject

Данные о попытках списания средств.

chargeobject

Объект с данными о рекуррентном списании.

descriptionobject

Описание плана. Значение состоит из пар "localization":"plan description".

expirationobject

Информация об истечении срока подписки.

external_idstring

Внешний идентификатор плана.

grace_periodobject

Время периода отсрочки.

group_idstring or null

ID группы, к которой привязан план.

idinteger

ID плана подписки.

nameobject

Название плана. Значение состоит из пар "localization":"plan name".

project_idinteger

ID проекта.

refund_periodinteger or null

Период, в течение которого пользователь может вернуть средства, потраченные на план подписки (в днях).

statusobject
tagsArray of strings

Теги плана.

trialobject

Информация о пробном (триальном) периоде.

localized_namestring

Название плана языке по-умолчанию. Повторяет значение name.en.

]
Ответ
application/json
[
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "3b355320",
    "grace_period": { … },
    "group_id": null,
    "id": 241037,
    "localized_name": "Platinum VIP",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  },
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "0fe1b6fc",
    "grace_period": { … },
    "group_id": null,
    "id": 241038,
    "localized_name": "Gold Status",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  }
]

Создание плана

Запрос

Создание рекуррентного плана.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта.

Телоapplication/jsonобязательный
billing_retryobject

Данные о попытках списания средств.

chargeobjectобязательный

Объект с данными о рекуррентном списании.

charge.​amountnumber(float)

Сумма рекуррентного списания.

charge.​currencystring

Валюта заказа. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

charge.​periodobjectобязательный

Расчетный период.

charge.​period.​typestringобязательный

Единица времени. Может принимать значения day, month или lifetime.

Перечисление"day""month""lifetime"
charge.​period.​valueintegerобязательный

Количество временных единиц. Значение зависит от типа параметра и может быть:
- от 1 до 366, если параметр type принимает значение day;
- от 1 до 12, если параметр type принимает значение month;
- 0 если параметр type принимает значение lifetime.

charge.​pricesArray of objects

Список цен в различных валютах.

descriptionobject

Описание плана. Значение состоит из пар "localization":"plan description".

expirationobject

Информация об истечении срока подписки.

external_idstring

Внешний идентификатор плана.

grace_periodobject

Время периода отсрочки.

group_idstring or null

ID группы, к которой привязан план.

idinteger

ID плана подписки.

nameobjectобязательный

Название плана. Значение состоит из пар "localization":"plan name".

name.​arstring

Арабский.

name.​bgstring

Болгарский.

name.​cnstring

Китайский упрощенный.

name.​csstring

Чешский.

name.​destring

Немецкий.

name.​enstring

Английский.

name.​esstring

Испанский.

name.​frstring

Французский.

name.​hestring

Иврит.

name.​itstring

Итальянский.

name.​jastring

Японский.

name.​kostring

Корейский.

name.​plstring

Польский.

name.​ptstring

Португальский.

name.​rostring

Румынский.

name.​rustring

Русский.

name.​thstring

Тайский.

name.​trstring

Турецкий.

name.​twstring

Китайский традиционный.

name.​vistring

Вьетнамский.

project_idinteger

ID проекта.

refund_periodinteger or null

Период, в течение которого пользователь может вернуть средства, потраченные на план подписки (в днях).

statusobject
tagsArray of strings

Теги плана.

trialobject

Информация о пробном (триальном) периоде.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/plans' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_retry": {
      "value": 1
    },
    "charge": {
      "amount": 10,
      "currency": "USD",
      "period": {
        "type": "month",
        "value": 1
      },
      "prices": [
        {
          "amount": 8,
          "currency": "EUR",
          "setup_fee": 1.5
        },
        {
          "amount": 1000,
          "currency": "JPY",
          "setup_fee": 2.5
        }
      ]
    },
    "description": {
      "en": "2x more experience!"
    },
    "expiration": {
      "type": "day",
      "value": null
    },
    "external_id": "exp",
    "grace_period": {
      "type": "day",
      "value": 2
    },
    "name": {
      "en": "Experience boost"
    },
    "refund_period": null,
    "status": {
      "value": "active"
    },
    "trial": {
      "type": "day",
      "value": 7
    }
  }'

Ответы

Сreated.

Телоapplication/json
external_idstring
plan_idinteger
Ответ
application/json
{
  "external_id": "exp",
  "plan_id": 241082
}

Отключение плана

Запрос

Отключение рекуррентного плана.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта.

plan_idintegerобязательный

ID рекуррентного плана.

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

Ответы

No content.

Продукты

Операции

Subscription management

Операции

Платежи

Операции

Акции

Операции

Купоны

Операции

Subscription management

Операции