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

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

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

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

 Атрибут 

 Тип 

Описание

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

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

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

Public-Token

string

Токен доступа к Public API Rustore

Да

header

subscriptionToken

string

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

Да

path

111.123

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

Атрибут

Тип

Описание

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

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

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

code

number

Код ответа

Да

body

message

string

Расшифровка кода ответа

Нет

body

timestamp

timestamptz

Время запроса

Да

body

body{}

object

Тело ответа

Нет

body

body{}

Атрибут

Тип

Описание

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

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

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

is_active

boolean

Флаг активности подписки.

  • true — подписка активна, в одном из периодов: PROMO, START, STANDARD, GRACE

  • false — подписка не активна: в HOLD периоде или завершилась

Да

body.body{}

true

Пример ответа:

"code":"200",

"message":"something",

"timestamp":"2023-08-02T10:11:04.655684723+03:00",

"body":

{

   "is_active": "true"

}

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

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

  • владелец и/или приложение не должны быть заблокированы;

  • токен должен быть действительным;

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

Обновлено 29 сентября 2023 г.
Was this information helpful?