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

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обязательный
payment_systemsArray of objects

Платежные системы.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/payment_systems' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_systems": [
      {
        "id": 24,
        "name": "PayPal"
      }
    ]
  }'

Ответы

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

Ответы

OK.

Телоapplication/json
idinteger
periodsArray of objects

Диапазоны дат/времени.

Ответ
application/json
{
  "id": 17840,
  "periods": [
    { … }
  ]
}

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

Запрос

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

Внимание

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

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

ID продавца.

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

ID акции.

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

Диапазоны дат/времени.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/periods' \
  -H 'Content-Type: application/json' \
  -d '{
    "periods": [
      {
        "from": "2019-03-02T00:00:00+04:00",
        "to": "2019-04-02T00:00:00+04:00"
      }
    ]
  }'

Ответы

No content.

Купоны

Операции

Subscription management

Операции