Метод получения статуса подписки по ID платежа
Метод позволяет получить подписку из системы платежного провайдера по invoice_id первого платежа.
Параметры взаимодействия
GET /public/subscription/{purchaseToken}/state
|
Атрибут |
Тип |
Описание |
Обязательность |
Расположение |
Пример заполнения |
|---|---|---|---|---|---|
|
Public-Token |
string |
Токен доступа к Public API Rustore |
Да |
header |
|
|
purchaseToken |
string |
Токен состоит из склеенных параметров invoiceId и userId. Пример токена для invoiceId = 111 и userId = 123: 111.123 |
Да |
path |
Параметры ответа
|
Атрибут |
Тип |
Описание |
Обязательность |
Расположение |
Пример заполнения |
|---|---|---|---|---|---|
|
code |
number |
Код ответа |
Да |
body |
|
|
message |
date |
Расшифровка кода ответа |
Нет |
body |
|
|
errorCode |
string |
Код ошибки (при наличии) |
Нет |
body |
|
|
body{} |
object |
Данные ответа от SmartPay |
Нет |
body |
body{}
|
Атрибут |
Тип |
Описание |
Обязательность |
Расположение |
Пример заполнения |
|---|---|---|---|---|---|
|
is_active |
boolean |
Флаг активности подписки. Вычисляется по статусу подписки:
|
Да |
body.body{} |
true |
errorCode:
-
outdated_token — токен недействителен (истек срок действия);
-
owner_blocked — владелец заблокирован и/или отключена монетизация;
-
app_owner_mismatch — приложение недоступно для переданного токена.
Валидация запроса
При получении запроса проверяется токен авторизации, полученный методом получения токена авторизации:
-
владелец и/или приложение не должны быть заблокированы;
-
токен должен быть действительным;
-
в ответе на запрос invoice в application_code должен содержаться код приложения, соответствующий владельцу, получившему токен.