Метод получения статуса подписки по ID платежа

Метод позволяет получить подписку из системы платежного провайдера по invoice_id первого платежа. Получение производится с использованием методов SmartPay API.

Параметры взаимодействия

GET /public/subscriptions/{invoiceId}/state

Атрибут	Тип	Описание	Обязательность	Расположение	Пример заполнения
Public-Token	string	Токен доступа к Public API Rustore	Да	header
invoiceId	number	Идентификатор покупки	Да	path

Параметры ответа

Атрибут	Тип	Описание	Обязательность	Расположение
code	number	Код ответа	Да	body
message	date	Расшифровка кода ответа	Нет	body
errorCode	string	Код ошибки (при наличии)	Нет	body
body{}	object	Данные ответа от SmartPay	Нет	body

body{}

Атрибут	Тип	Описание	Обязательность	Расположение	Пример заполнения
is_active	boolean	Флаг активности подписки. Вычисляется по статусу подписки: true — для currentPeriod PROMO, START, STANDARD, GRACE && state != CLOSED. false — для currentPeriod HOLD и/или state = CLOSED.	Да	body.body{}	true

Атрибут

Тип

Описание

Обязательность

Расположение

Пример заполнения

is_active

boolean

Флаг активности подписки. Вычисляется по статусу подписки:

true — для currentPeriod PROMO, START, STANDARD, GRACE && state != CLOSED.
false — для currentPeriod HOLD и/или state = CLOSED.

Да

body.body{}

true

errorCode:

outdated_token — токен недействителен (истек срок действия);
owner_blocked — владелец заблокирован и/или отключена монетизация;
app_owner_mismatch — приложение недоступно для переданного токена.

Валидация запроса

При получении запроса проверяется токен авторизации, полученный методом получения токена авторизации:

владелец и/или приложение не должны быть заблокированы;
токен должен быть действительным;
в ответе на запрос invoice в application_code должен содержаться код приложения, соответствующий владельцу, получившему токен.