Перейти к содержимому
/
Информация о предмете акц...

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

Операции

Платежи

Операции

Акции

Операции

Настройка вознаграждений

Запрос

Устанавливает вознаграждения за участие в акции. Если акция доступна только для чтения (read_only = true), вы не сможете обновить вознаграждения.

Внимание

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

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

ID продавца.

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

ID акции.

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

Настройка вознаграждения при покупке предмета.

item.​bonusArray of objects

Вознаграждение в виде бесплатного предмета.

item.​bonus[].​idinteger
item.​bonus[].​localized_namestring

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

item.​bonus[].​quantityinteger

Количество предметов.

item.​bonus[].​skustring

Артикул предмета.

item.​discountArray of objects

Настройка скидки при покупке предмета.

item.​discount[].​discount_percentnumber(float)

Скидка на покупку, %.

item.​discount[].​localized_namestring

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

item.​discount[].​max_amountnumber(integer)

Максимальное количество предметов, на которое будет распространяться акция.

item.​discount[].​skustring

Артикул предмета.

packageobject

Настройка вознаграждения при покупке пакета виртуальной валюты.

package.​bonus_amountnumber(float)

Вознаграждение, указанное в виде абсолютного значения количества виртуальной валюты.

package.​bonus_percentnumber(float)

Вознаграждение, указанное в виде процента от количества виртуальной валюты.

purchaseobject

Настройка вознаграждения на весь заказ.

purchase.​discount_percentnumber(float)

Скидка на покупку, %.

subscriptionobject

Настройка вознаграждения на подписку.

subscription.​trial_daysinteger

Количество дней триального периода.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards' \
  -H 'Content-Type: application/json' \
  -d '{
    "item": {
      "bonus": [
        {
          "quantity": 2,
          "sku": "1234"
        }
      ],
      "discount": [
        {
          "discount_percent": 5,
          "max_amount": 10,
          "sku": "1234"
        }
      ]
    },
    "package": {
      "bonus_amount": 5,
      "bonus_percent": 5
    },
    "purchase": {
      "discount_percent": 10
    },
    "subscription": {
      "trial_days": 30
    }
  }'

Ответы

No content.

Информация о предмете акции

Запрос

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

Внимание

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

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

ID продавца.

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

ID акции.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject'

Ответы

OK.

Телоapplication/json
digital_contentsobject or null
itemsArray of objects

Акция действует на указанные предметы.

items[].​idinteger
items[].​localized_namestring

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

items[].​skustring

Артикул предмета.

packagesArray of objects or null

Акция действует на указанные пакеты виртуальной валюты.

purchaseboolean

Действует ли акция на весь заказ.

subscriptionsobject or null

Объект с информцией о рекуррентных планах или продуктах, на которые будет действовать акция.

subscriptions.​max_charges_countinteger

Масимальное количество списаний, в течение которых будет действовать акция.

subscriptions.​plansArray of strings
subscriptions.​productsArray of strings
idinteger
Ответ
application/json
{
  "digital_contents": null,
  "id": 178,
  "items": [
    { … }
  ],
  "packages": null,
  "purchase": false,
  "subscriptions": null
}

Настройка предмета акции

Запрос

Определяет тему рекламной акции. Если рекламная акция доступна только для чтения (read_only = true), вы не сможете обновить тему. Тема может принимать следующие значения: purchase, items или packages.

Внимание

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

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

ID продавца.

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

ID акции.

Телоapplication/jsonобязательный
digital_contentsobject or null
itemsArray of objects

Акция действует на указанные предметы.

items[].​idinteger
items[].​localized_namestring

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

items[].​skustring

Артикул предмета.

packagesArray of objects or null

Акция действует на указанные пакеты виртуальной валюты.

purchaseboolean

Действует ли акция на весь заказ.

subscriptionsobject or null

Объект с информцией о рекуррентных планах или продуктах, на которые будет действовать акция.

subscriptions.​max_charges_countinteger

Масимальное количество списаний, в течение которых будет действовать акция.

subscriptions.​plansArray of strings
subscriptions.​productsArray of strings
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject' \
  -H 'Content-Type: application/json' \
  -d '{
    "digital_contents": null,
    "items": [
      {
        "sku": "1234"
      }
    ],
    "packages": null,
    "purchase": false,
    "subscriptions": null
  }'

Ответы

No content.

Купоны

Операции

Subscription management

Операции