Получение информации о Подписке по ID

Метод Get Subscription Info by ID позволяет получить информацию о Подписке по ID данной Подписки.

GET /api/vendor/v1/subscriptions/{id}.json?api_token={api_token}

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ Опциональный

Описание

id

path

integer

Обязательный

ID Подписки

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см.Просмотр и обновление информации о сотруднике)

Модель ответа

Название

Тип данных

Описание

id

integer

ID Подписки

plan_id

integer

ID Тарифного плана Подписки

account_id

integer

ID Клиента, которому принадлежит Подписка

name

string

Название Подписки

trial

bool

Является ли данная Подписка пробной:

  • true – да
  • false – нет

status

string

Статус Подписки (список статусов см. в Просмотр списка подписок)

start_date

date

Дата активации Подписки

expiration_date

date

Дата истечения срока действия Подписки

plan_period_id

integer

ID периода Тарифного плана

promo_code

string

Код, который был использован для получения скидки

created_at

date

Дата и время создания Подписки

updated_at

date

Дата и время последнего изменения Подписки
hold_todateДата, до которой по Подписке не требуется выполнять биллинг процесс, так как все списания по Подписке были закрыты (см. Ручное закрытие всех списаний по подписке)
payment_modelstring

Модель оплаты Подписки. Возможные значения:

  • prepay – Предоплата
  • postpay – Постоплата
payment_model_parametersobjectПараметры модели оплаты Подписки

credit_limitfloatВеличина Кредитного лимита по подписке, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента или Подписки. Возвращается только для payment_model = postpay

current_debtfloatВеличина Текущей задолженности по Подписке. Возвращается только для payment_model = postpay

Пример запроса

GET /api/vendor/v1/subscriptions/3005362.json?api_token=vY5fwetestK3gJXZH5uHCw

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

{
    "id": 3005362,
    "plan_id": 1437,
    "account_id": 411,
    "name": " ESET NOD32 Mobile Security",
    "trial": false,
    "status": "deleted",
    "start_date": "2019-12-15",
    "expiration_date": "2020-12-15",
    "plan_period_id": 2597,
    "promo_code": null,
    "created_at": "2019-12-15T10:11:56.599+03:00",
    "updated_at": "2019-05-31T11:05:41.402+03:00",
    "hold_to": null,
    "payment_model": "postpay",
    "payment_model_parameters": {
        "credit_limit": 25.0,
        "current_debt": 0.0
    }
}