Перейти к содержимому
/
Список вознаграждений

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 продавца.

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

ID акции.

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

Ответы

OK.

Телоapplication/jsonArray [
componentstring
messagestring
]
Ответ
application/json
[
  {
    "component": "rewards",
    "message": "Please select a reward"
  }
]

Список вознаграждений

Запрос

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

Внимание

Этот метод 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}/rewards'

Ответы

OK.

Телоapplication/json
idinteger
itemobject

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

packageobject

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

purchaseobject

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

subscriptionobject

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

Ответ
application/json
{
  "id": 17840,
  "item": {
    "bonus": [ … ],
    "discount": [ … ]
  },
  "package": {
    "bonus_amount": 5,
    "bonus_percent": 5
  },
  "purchase": {
    "discount_percent": 10
  },
  "subscription": {
    "trial_days": 30
  }
}

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

Запрос

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

Внимание

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

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

ID продавца.

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

ID акции.

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

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

packageobject

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

purchaseobject

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

subscriptionobject

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

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.

Купоны

Операции

Subscription management

Операции