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

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

Операции

Платежи

Операции

Акции

Операции

Купоны

Операции

Создание кампании

Запрос

Создайте новую купонную кампанию.

Внимание

Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.

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

ID продавца.

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

Название кампании.

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

Объект с локализованными названиями кампании.

campaign_names.​arstring

Арабский.

campaign_names.​bgstring

Болгарский.

campaign_names.​cnstring

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

campaign_names.​csstring

Чешский.

campaign_names.​destring

Немецкий.

campaign_names.​enstring

Английский.

campaign_names.​esstring

Испанский.

campaign_names.​frstring

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

campaign_names.​hestring

Иврит.

campaign_names.​itstring

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

campaign_names.​jastring

Японский.

campaign_names.​kostring

Корейский.

campaign_names.​plstring

Польский.

campaign_names.​ptstring

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

campaign_names.​rostring

Румынский.

campaign_names.​rustring

Русский.

campaign_names.​thstring

Тайский.

campaign_names.​trstring

Турецкий.

campaign_names.​twstring

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

campaign_names.​vistring

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

campaign_redeems_count_for_userinteger

Максимальное количество погашений купона для одного пользователя в рамках кампании. Если передан null, количество погашений не ограничено.

expiration_datestring(datetime)

Дата окончания кампании в формате YYYY-MM-DD’T’HH:MM:SS согласно стандарту ISO 8601.

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

ID проекта.

redeems_countinteger

Максимальное количество погашений купона. Если передан null, количество погашений не ограничено.

redeems_count_for_userinteger

Максимальное количество погашений купона для одного пользователя. Если передан null, количество погашений не ограничено.

subscription_couponobject

Объект с параметрами подписки в вознаграждении.

virtual_currency_amountnumber(float)

Количество виртуальной валюты в вознаграждении.

virtual_itemsobject

Массив с параметрами виртуальных товаров в вознаграждении.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/coupon_promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_code": "sample_campaign",
    "campaign_names": {
      "en": "Campaign Name",
      "ru": "Название кампании"
    },
    "campaign_redeems_count_for_user": 1,
    "expiration_date": "2019-12-31",
    "project_id": 12345,
    "redeems_count": 10,
    "redeems_count_for_user": 1,
    "subscription_coupon": {
      "plan_id": 123,
      "product_id": 456,
      "trial_period": 30
    },
    "virtual_currency_amount": 200
  }'

Ответы

Created.

Телоapplication/json
idinteger
Пример: 9134
Ответ
application/json
{
  "id": 9134
}

Добавление купона в кампанию

Запрос

Добавьте код купона в купонную кампанию.

Внимание

Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.

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

ID продавца.

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

ID кампании.

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

Код купона.

Пример: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

Ответы

No content.

Привязка кампании к акции

Запрос

Прикрепите купонную кампанию к определенной акции.

Внимание

Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.

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

ID продавца.

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

ID акции.

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

Массив с ID кампаний.

Пример: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

Ответы

No content.

Subscription management

Операции