Получение статуса подписки

Метод позволяет получить информацию о статусе подписки по токену подписки.

подсказка

Если не знаете с чего начать, прочтите инструкцию в сценариях использования.

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

Для реальных подписок:

GET

https://public-api.rustore.ru/public/subscription/{subscriptionToken}/state

предупреждение

Для тестовых подписок используйте отдельный метод:

GET

https://public-api.rustore.ru/public/sandbox/subscription/{subscriptionToken}/state

Для работы с тестовыми платежами и подписками вам понадобится новый ключ, при создании которого нужно указать методы для тестирования.

Атрибут	Тип	Описание	Обязательность	Расположение	Пример
Public-Token	string	Jwe-токен авторизации в Public API Rustore. Как получить токен авторизации.	Да	header	N/A
subscriptionToken	string	Как получить токен подписки, см. документацию по SDK платежей.	Да	path	111.123

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

Атрибут	Тип	Описание	Обязательность	Расположение	Пример
code	string	Код ответа.	Да	body	• ОК; • ERROR; • BAD_REQUEST; • NOT_FOUND.
message	string	Расшифровка кода ответа.	Нет	body	Jwe token is expired
body{}	object	Тело ответа	Нет	body	N/A
timestamp	string	Время ответа.	Да	body	2023-08-02T10:11:04.655684723+03:00

body{}

Атрибут	Тип	Описание	Обязательность	Расположение	Пример
is_active	boolean	Флаг активности подписки. Вычисляется по статусу подписки: • true — подписка активна, в одном из периодов: PROMO, START, STANDARD, GRACE; • false — подписка неактивна: в HOLD-периоде или завершилась.	Да	body.body	true

Пример успешного ответа

{
    "code": "OK",
    "message": null,
    "body":
        {
        "is_active": true
        },
    "timestamp": "2024-01-21T14:08:33.548812228+03:00"
}

Пример ответа с ошибкой

{
    "code": "ERROR",
    "message": "Jwe token is expired",
    "body": null,
    "timestamp": "2024-01-21T13:51:59.654427798+03:00"
}

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

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

• владелец и/или приложение не должны быть заблокированы;
• токен должен быть действительным;
• подписка приобретена в приложении, владельцем которого является компания, получившая токен доступа к Public API.