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

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

Операции

Платежи

Операции

Акции

Операции

Удаление акции

Запрос

Удаляет акцию. Вы можете удалять акции только с параметром enabled = false.

Внимание

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

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

ID продавца.

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

ID акции.

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

Ответы

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}'

Ответы

OK.

Телоapplication/json
descriptionobject

Массив локализованных описаний акции.

labelobject

Массив локализованных лейблов, будут показаны в платежном интерфейсе.

nameobject

Массив локализованных названий акции.

project_idinteger

ID проекта.

technical_namestring

Техническое название акции.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
Ответ
application/json
{
  "description": {
    "en": "Promotion with 30% discount",
    "ru": "Акция со скидкой 30%"
  },
  "enabled": false,
  "id": 17890,
  "label": {
    "en": "30%",
    "ru": "30%"
  },
  "name": {
    "en": "30% discount",
    "ru": "Скидка 30%"
  },
  "project_id": 40544,
  "read_only": false,
  "show_banner": true,
  "technical_name": "Sale promotion"
}

Изменение акции

Запрос

Обновляет акцию. Если акция доступна только для чтения (read_only = true), вам не разрешается изменять параметр project_id.

Внимание

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

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

ID продавца.

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

ID акции.

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

Массив локализованных описаний акции.

labelobject

Массив локализованных лейблов, будут показаны в платежном интерфейсе.

nameobject

Массив локализованных названий акции.

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

ID проекта.

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

Техническое название акции.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Promotion with 5% discount",
      "ru": "Акция со скидкой 5%"
    },
    "label": {
      "en": "5%",
      "ru": "5%"
    },
    "name": {
      "en": "5% discount",
      "ru": "скидка 5%"
    },
    "project_id": 40544,
    "technical_name": "Sale promotion"
  }'

Ответы

No content.

Купоны

Операции

Subscription management

Операции