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

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

Операции

Платежи

Операции

Список валют

Запрос

Список валют.

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

ID проекта.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/currencies'

Ответы

OK.

Телоapplication/json
Ответ
application/json
[
  "AED",
  "ALL",
  "AMD",
  "ARS",
  "AUD",
  "AZN",
  "BAM",
  "BBD",
  "BGN",
  "BHD",
  "BND",
  "BRL",
  "BYN",
  "BZD",
  "CAD",
  "CHF",
  "CLP",
  "CNY",
  "COP",
  "CRC",
  "CZK",
  "DKK",
  "DZD",
  "EGP",
  "EUR",
  "GBP",
  "GEL",
  "GHS",
  "GIP",
  "GTQ",
  "HKD",
  "HRK",
  "HUF",
  "IDR",
  "ILS",
  "INR",
  "IQD",
  "IRR",
  "ISK",
  "JMD",
  "JOD",
  "JPY",
  "KES",
  "KGS",
  "KRW",
  "KWD",
  "KZT",
  "LAK",
  "LBP",
  "LKR",
  "MAD",
  "MDL",
  "MKD",
  "MMK",
  "MNT",
  "MUR",
  "MXN",
  "MYR",
  "NGN",
  "NIO",
  "NOK",
  "NPR",
  "NZD",
  "OMR",
  "PAB",
  "PEN",
  "PHP",
  "PKR",
  "PLN",
  "PYG",
  "QAR",
  "RON",
  "RSD",
  "RUB",
  "SAR",
  "SEK",
  "SGD",
  "SVC",
  "THB",
  "TND",
  "TRY",
  "TWD",
  "UAH",
  "USD",
  "UYU",
  "UZS",
  "VEF",
  "VND",
  "XOF",
  "YER",
  "ZAR"
]

Список платежей

Запрос

Список рекуррентных платежей.

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

ID проекта.

Запрос
offsetinteger

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

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

Лимит количества элементов на странице.

user_idstring

ID пользователя.

statusstring

Статус транзакции.

Перечисление ЗначениеОписание
done

Платеж обработан успешно.

fail

Платеж не был обработан успешно или был выполнен возврат средств.

datetime_fromstring(datetime)

Начало периода.

datetime_tostring(datetime)

Конец периода.

subscription_idinteger

ID подписки.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/subscriptions/payments?offset=0&limit=0&user_id=string&status=done&datetime_from=string&datetime_to=string&subscription_id=0'

Ответы

OK.

Телоapplication/json
Ответ
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 67683,
    "id_payment": 203960,
    "status": "fail",
    "subscription": { … }
  },
  {
    "date_payment": "2015-09-21T17:06:47+03:00",
    "id": 1531,
    "id_payment": 168866,
    "status": "done",
    "subscription": { … }
  }
]

Список платежей пользователя

Запрос

Список рекуррентных платежей пользователя.

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

ID проекта.

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

ID пользователя.

Запрос
statusstring

Статус транзакции.

Перечисление ЗначениеОписание
done

Платеж обработан успешно.

fail

Платеж не был обработан успешно или был выполнен возврат средств.

offsetinteger

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

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

Лимит количества элементов на странице.

datetime_fromstring(datetime)

Дата выборки. Позволяет найти подписки, созданные позднее даты запроса.

datetime_tostring(datetime)

Дата выборки. Позволяет найти подписки, созданные позднее даты запроса.

subscription_idinteger

ID подписки.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/payments?status=done&offset=0&limit=0&datetime_from=string&datetime_to=string&subscription_id=0'

Ответы

OK.

Телоapplication/json
Ответ
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 6746083,
    "id_payment": 202789960,
    "status": "fail",
    "subscription": { … }
  }
]

Акции

Операции

Купоны

Операции

Subscription management

Операции