Метод получения данных подписки по токену подписки
Метод позволяет получить информацию о подписке по токену подписки.
Параметры взаимодействия
GET https://public-api.rustore.ru/public/subscription/{subscriptionToken}
Атрибут |
Тип |
Описание |
Обязательность |
Расположение |
Пример заполнения |
---|---|---|---|---|---|
Public-Token |
string |
Токен доступа к Public API Rustore |
Да |
header |
|
subscriptionToken |
string |
Да |
path |
111.123 |
Параметры ответа
Атрибут |
Тип |
Описание |
Обязательность |
Расположение |
Пример заполнения |
---|---|---|---|---|---|
code |
string |
Код ответа |
Да |
body |
ОК, ERROR, BAD_REQUEST, NOT_FOUND |
message |
string |
Расшифровка кода ответа |
Нет |
body |
|
timestamp |
timestamptz |
Время ответа |
Да |
body |
|
body{} |
object |
Тело ответа |
Нет |
body |
body{}
Атрибут |
Тип |
Описание |
Обязательность |
Расположение |
Пример заполнения |
---|---|---|---|---|---|
code |
number |
Код ответа |
Да |
body |
|
success |
boolean |
Флаг успешности ответа |
Да |
body |
true |
message |
string |
Расшифровка кода ответа |
Нет |
body |
Неизвестная ошибка |
body{} |
object |
Тело сообщения |
Нет |
body |
body.body{}
Атрибут |
Тип |
Описание |
Пример заполнения |
---|---|---|---|
serviceName | string | Название сервиса | Okko |
subscriptionId | integer | Уникальный идентификатор подписки | 12345 |
addParameters | string | Дополнительные параметры по подписке | Something about subscription |
productType | string | Тип продукта | SUBSCRIPTION |
productName | string | Название продукта | Okko оптимум |
productCode | string | Код продукта | monthly_sub |
recurrent | boolean | Признак автопродления | true |
countOfDay | integer | Количество дней | 10 |
periodType | string | Тип периода | Доступные значения: DAY, MONTH, YEAR |
periodDuration | integer | Длительность периода | 10 |
nextPaymentDate | string | Дата следующего платежа | 2021-03-23 |
price | integer | Цена в минимальной единице валюты (копейки) | 9999 |
currency | string | Валюта | RUB |
imageUrl | string | Ссылка на картинку продукта | |
state | string | Статус подписки |
Активные статусы ACTIVATED — подписка активна. Промежуточные статусы ACCEPTED — ожидает оплаты. DEPOSITED — платёж проведён, подписка ожидает активации; CLOSE_PENDING — подписка в процессе закрытия; REPEATING — подписка на стадии продления, производится попытка списания денег для продления. Финальные статусы DECLINED — подписка закрыта, все попытки очередных платежей по подписке завершились неуспешно, GRACE и HOLD периоды и количество попыток продления закончились CANCELED — пользователь не оплатил подписку; CLOSED — подписка закрыта; пользователь отключил автопродление подписки, истек оплаченный период, провайдер подтвердил закрытие подписки; REFUNDED — инициирован возврат средств пользователю. |
currentPeriod | string | Наименование текущего периода |
Доступные значения: PROMO — бесплатный период; START — стартовый период со сниженной ценой; STANDARD — стандартный период; GRACE — грейс период, пользователь не оплатил подписку, попытки списания продолжаются, доступ к контенту сохраняется; HOLD — холд период, пользователь не оплатил подписку, попытки списания продолжаются, доступ к контенту должен быть прекращён. |
debtPaymentPeriod | string | Наименование платежного периода | Null если период стандартный |
description | string | Описание продукта подписки | Описание |
tariffId | integer | Уникальный идентификатор тарифа | 12345 |
periods [] | array[object] | Информация о текущем периоде | Периоды тарифа |
body.body.periods []
Атрибут |
Тип |
Описание |
Пример заполнения |
---|---|---|---|
periodName | string | Наименование текущего периода | Доступные значения: PROMO, START, STANDARD, GRACE, HOLD |
periodType | string | Тип периода | Доступные значения: DAY, MONTH, YEAR |
periodDuration | number | Длительность периода | 10 |
periodPrice | number | Цена в минимальной единице валюты (копейки) | 10000 |
nextPeriod | string | Наименование следующего периода | Доступные значения: PROMO, START, STANDARD, GRACE, HOLD |
Пример ответа:
|
Валидация запроса
При получении запроса проверяется токен авторизации, полученный методом получения токена авторизации:
-
владелец и/или приложение не должны быть заблокированы;
-
токен должен быть действительным;
- код приложения application_code соответствует владельцу, получившему токен авторизации.