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

Content-Type

header

string

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

Тип данных, передаваемых в запросе. Укажите application/vnd.api+json

Accept

header

string

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

Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json

X-Api-Locale

header

string

Опциональный

Двухбуквенный код языка данных в ответе

Authorization 

header

string

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

Действующий access token пользователя. Формат: Bearer <access token>

reseller_domain

path

string

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

Доменное имя реселлера

account_id

path

integer

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

ID аккаунта, для которого запрашивается информация о подписке

subscription_id

path

integer

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

ID подписки

data

object

Данные ответа

id

string

ID подписки

type

string

Тип данных

attributes

object

Информация о подписке

product_id

integer

ID продукта, на тарифный план которого заказана подписка

product_name

string

Название продукта, на тарифный план которого заказана подписка

created_at

string

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

start_date

string

Дата и время начала работы подписки

name

string

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

status

string

Статус подписки:

• ordered — Новый заказ.

• active — Активная.

• delivered — Доставлена.

• graced — Просрочена оплата.

• stopped — Остановлена.

• deleted — Удалена.

• installation_failed — Ошибка установки.

• activation_failed — Ошибка активации.

• renewal_failed — Ошибка продления.

• updating_failed — Ошибка обновления.

• stopping_failed — Остановка не может быть завершена.

• deletion_failed — Ошибка удаления.

• switching_failed — Ошибка переключения.

• installing — Установка.

• activating — Активируется.

• renewing — Продление.

• updating — Обновление.

• stopping — Останавливается.

• deleting — Удаляется.

• switching — Переключение.

• waiting_for_manual_approve — Ожидает ручного подтверждения.

• blocked — Заблокирована.

trial

bool

Признак пробной подписки:

• true — подписка на пробный период.

• false — коммерческая подписка.

payment_model

string

Модель оплаты подписки:

• prepay — Предоплата.

• postpay — Постоплата.

expiration_date

string

Дата истечения подписки (ГГГГ-ММ-ДД)

paid_to_date

string

Дата Оплачена до подписки (ГГГГ-ММ-ДД)

billing_type

string

Тип биллинга тарифного плана, на который заказана подписка

fixed_price

bool

Признак фиксированной цены:

• true — для подписки зафиксированы цены, действовавшие на момент заказа.

• false — для подписки применяются актуальные цены тарифного плана.

custom_price

bool

Признак индивидуальной цены:

• true — подписка заказана по индивидуальным ценам.

• false — подписка заказана по ценам тарифного плана.

auto_renewal

bool

Состояние опции Автопродление подписки:

• true — автопродление включено.

• false — автопродление выключено.

renew_type

bool

Параметр продления подписки, заказанной по индивидуальным ценам (подробнее см. ):

• Использовать наибольшие цены.

• Использовать индивидуальные цены.

• Использовать цены тарифного плана.

plan_period_data

object

Информация о периоде тарифного плана, на который заказана подписка

id

integer

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

duration_value

integer

Длительность периода тарифного плана. Если период бессрочный, то duration_value = null

duration_type

string

Единица измерения периода тарифного плана:

• day — день.

• month — месяц.

• year — год.

Если период бессрочный, то duration_type = null

endless

bool

Признак того, является ли период тарифного плана бессрочным:

• true — период является бессрочным.

• false — продолжительность периода ограничена и указана в duration_value и duration_type.

plan_class_data

object

Информация о правилах предоставления услуги для тарифного плана, на который заказана подписка (см.

)

billing_day

integer

Финансовый день

deletion_client_period

integer

Период удаления подписки для клиента (в сутках)

unpaid_payments

object

Информация о неоплаченных платежах по подписке — платежах в статусах Ожидает оплаты, Просрочен, Обрабатывается, исключая платежи по модели Постоплата, у которых не задана дата Оплатить до (см. также

)

unpaid_sum

number

Сумма в валюте реселлера неоплаченных платежей по подписке

payments

array of objects

Список неоплаченных платежей по подписке

id

integer

ID платежа

document_id

string

Номер платежа

status

string

Статус платежа (см.

)

order_type

string

Тип заказа, с которым связан платеж. См. incomplete_orders

order_subtype

string

Подтип заказа:

• immediate_switch — немедленное переключение. Только для заказа на переключение тарифного плана.

• delayed_switch — отложенное переключение. Только для заказа на переключение тарифного плана.

• null — для всех остальных типов заказа.

subscription_credit_limit

number

Кредитный лимит по подписке по модели Постоплата в валюте реселлера

reseller_currency_iso_code

string

Код валюты реселлера

current_debt

number

Текущее потребление по подписке в валюте реселлера

product_category_data

object

Информация о категории продукта тарифного плана, на который заказана подписка

id

integer

ID категории продукта 

name

string

Название категории продукта 

next_charges_info

object

Предстоящие расходы — прогнозируемая сумма будущих платежей по подписке по модели Предоплата в статусе Активная, кроме подписок с оплатой по мере потребления (pay as you go, PAYG), с учетом налогов

charge_list

array of objects

Список списаний для расчета предстоящих расходов

text

string

Описание списания

summa

number

Сумма списания в валюте реселлера

start_date

string

Дата начала периода предстоящих расходов (ГГГГ-ММ-ДД)

plan_id

integer

ID тарифного плана, на который заказана подписка

plan_name

string

Название тарифного плана, на который заказана подписка

subscription_period_fees

object

Стоимость периода тарифного плана, действующая для подписки, в валюте тарифного плана

setup_fee

number

Стоимость установки

recurring_fee

number

Абонентская плата

renewal_fee

number

Стоимость продления

transfer_fee

number

Стоимость переноса

incomplete_orders

array of objects

Список незавершенных заказов по подписке — заказов в статусах Ожидает оплаты, Ожидает предоставления, Предоставляется

id

integer

ID заказа

document_id

number

Номер заказа

status

string

Статус заказа (см.

)

type

string

Тип заказа (см.

)

subtype

string

Подтип заказа:

• immediate_switch — немедленное переключение. Только для заказа на переключение тарифного плана.

• delayed_switch — отложенное переключение. Только для заказа на переключение тарифного плана.

• null — для всех остальных типов заказа.

provisioning_date

string

Дата предоставления заказа (ГГГГ-ММ-ДД)

available_operations

object

Доступные действия над заказом

cancel

bool

Отмена (см. Отмена заказа):

• true — действие доступно.

• false — действие недоступно.

recreate

bool

Изменение (см. Изменение заказа):

• true — действие доступно.

• false — действие недоступно.

entry_point

object

Информация о внешнем портале для доступа к услуге (см. )

url

string

URL портала вендора

icon_url

string

Ссылка на логотип портала вендора

url_text

string

Название ссылки

additional_params

array of objects

Список дополнительных атрибутов подписки

key

string

Ключ дополнительного атрибута

name

string

Название дополнительного атрибута

value

string

Значение дополнительного атрибута

resources

array of objects

Список ресурсов подписки и их стоимость, действующая для подписки, в валюте тарифного плана

id

integer

ID ресурса подписки

resource_id

integer

ID ресурса в шаблоне услуги

name

string

Название ресурса

setup_fee

number

Стоимость установки

recurring_fee

number

Абонентская плата

renewal_fee

number

Стоимость обновления

overuse_fee

number

Стоимость перерасхода

included

integer

Количество ресурса, включенное в тарифный план по умолчанию (включенные ресурсы входят в стоимость подписки)

used

integer

Использованное количество ресурса. Только для ресурсов с типом Измеримый

additional

integer

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

limit

integer

Максимальное количество ресурса, доступное для заказа. Если максимальное количество ресурса не ограничено (unlimited_units = true), то limit = 0

minimum

integer

Минимальное количество ресурса (с учетом included), обязательное для заказа

priority

integer

Приоритет ресурса. У основного ресурса priority максимальный

unlimited_units

bool

Признак безлимитного ресурса:

• true — максимальное количество ресурса не ограничено.

• false — максимальное количество ресурса указано в limit.

unit_of_measure

string

Единица измерения ресурса:

• unit — измеряемый ресурс, для которого указывается определенное количество.

• boolean — неизмеряемый ресурс.

plan_currency_iso_code

string

Код валюты тарифного плана

plan_resource_id

integer

ID ресурса тарифного плана

available_operations

object

Доступные действия над подпиской

activate

bool

Активировать (см. Активация подписки):

• true — действие доступно.

• false — действие недоступно.

stop

bool

Остановить (см. Остановка подписки):

• true — действие доступно.

• false — действие недоступно.

destroy

bool

Удалить (см. Удаление подписки):

• true — действие доступно.

• false — действие недоступно.

prolong

bool

Пролонгировать вручную:

• true — действие доступно.

• false — действие недоступно.

increase_resources_prolong_order

bool

Увеличить количество ресурсов при пролонгации вручную:

• true — действие доступно.

• false — действие недоступно.

decrease_resources_prolong_order

bool

Уменьшить количество ресурсов при пролонгации вручную:

• true — действие доступно.

• false — действие недоступно.

renew

bool

Продлить (с учетом доступности тарифного плана, см. ):

• true — действие доступно.

• false — действие недоступно.

increase_resources_renewal_order

bool

Увеличить количество ресурсов при продлении вручную:

• true — действие доступно.

• false — действие недоступно.

decrease_resources_renewal_order

bool

Уменьшить количество ресурсов при продлении вручную:

• true — действие доступно.

• false — действие недоступно.

change

bool

Изменить количество ресурсов:

• true — действие доступно.

• false — действие недоступно.

increase_resources_change_order

bool

Увеличить количество ресурсов:

• true — действие доступно.

• false — действие недоступно.

decrease_resources_change_order

bool

Уменьшить количество ресурсов:

• true — действие доступно.

• false — действие недоступно.

delayed_switch_plan_order

bool

Переключить тарифный план (отложенное переключение):

• true — действие доступно.

• false — действие недоступно.

immediate_switch_plan_order

bool

Переключить тарифный план (немедленное переключение):

• true — действие доступно.

• false — действие недоступно.

auto_renew

bool

Автоматическое продление:

• true — действие доступно.

• false — действие недоступно.

auto_renewal_disabled

bool

Доступность для изменения опции Автопродление подписки (см. Обновление информации о подписке):

• true — опция Автопродление недоступна для изменения.

• false — опция Автопродление доступна для изменения.

set_budget

bool

Установить бюджет расходов (см. Создание бюджета расходов):

• true — действие доступно.

• false — действие недоступно.

sync_subscription_name

bool

Синхронизация названия подписки с вендором:

• true — синхронизация доступна.

• false — синхронизация недоступна.

spending_budget

array

Информация о бюджете расходов подписки (см.

)

spending_budget_id

integer

ID бюджета расходов

budget_amount

number

Сумма лимита потребления по подписке в валюте реселлера для отправки уведомления

notification_threshold

number

Порог в процентах от лимита потребления для отправки дополнительного уведомления

recipients

array

Список ID пользователей, которым отправляются уведомления о бюджете расходов

period

string

Период, для которого установлен бюджет расходов

target_type

string

Тип сущности, для которой установлен бюджет расходов

target_id

integer

ID сущности, для которой установлен бюджет расходов

next_billing_date

string

Следующий финансовый день по подписке (ГГГГ-ММ-ДД)

deletion_date

string

Дата и время окончания периода удаления подписки для клиента

taxes_calculation_settings

object

Настройки расчета налогов (см.

)

tax_is_calculated_using

object

Настройка Налоги рассчитываются (см. ):

• net_prices — Сверх цены плана — все цены в тарифных планах указаны без налогов.

• gross_prices — Внутри цены плана — все цены в тарифных планах включают в себя налоги.

taxes

array of objects

Список налогов

id

integer

ID налога

name

string

Название налога

rate

number

Ставка налога в процентах

account_types

array

Список ключей типов клиента, для которых применяется налог

plugin_id

string

Идентификатор плагина, на основе которого создана услуга подписки. Например, microsoft_csp_products

meta

object

Дополнительная информация

server_current_time

string

Текущие дата и время сервера