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

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

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

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

GET

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

АтрибутТипОписаниеОбязательностьРасположениеПример
Public-TokenstringJwe-токен авторизации в Public API Rustore.
Как получить токен авторизации.
ДаheaderN/A
subscriptionTokenstringКак получить токен подписки.Даpath111.123

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

АтрибутТипОписаниеОбязательностьРасположениеПример
codenumberКод ответа.Даbody ОК;
ERROR;
BAD_REQUEST;
NOT_FOUND.
messagedateРасшифровка кода ответа.НетbodyJwe token is expired
body{}objectТело ответаНетbodyN/A
timestampstringВремя ответа.Даbody2023-08-02T10:11:04.655684723+03:00

body{}

АтрибутТипОписаниеОбязательностьРасположениеПример
is_activebooleanФлаг активности подписки. Вычисляется по статусу подписки:
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.