Плейсхолдеры для сущности Подписка

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

Плейсхолдер Описание

subscription.id ID подписки

subscription.name

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

subscription.status Статус подписки

subscription.start_date Дата активации подписки

subscription.expiration_date Дата истечения подписки

subscription.auto_renewal Boolean; включена ли в подписке опция Автопродление

subscription.auto_renewal_disabled Boolean; включена ли в подписке опция Блокировать опцию Автопродление

subscription.auto_renewal.was Boolean; предыдущее состояние опции Автопродление в подписке в связи с созданием ручной операции. Подробнее см. Ручные операции

subscription.plan_auto_renewal_disabled Boolean; включена ли в связанном тарифном плане опция Блокировать опцию Автопродление

subscription.days_left Количество дней до даты истечения подписки

subscription.days_passed

Количество дней, прошедших со дня истечения подписки

subscription.trial Boolean; является ли подписка пробной

subscription.account Информация о клиенте, которому принадлежит подписка

subscription.plan_class Название правила предоставления тарифного плана подписки

subscription.plan Общая информация о тарифном плане подписки: ID, название, описание, статус, ID правила предоставления (данные будут выведены через ";")

subscription.plan_period Общая информация о периоде тарифного плана подписки: длительность, является ли период пробным, стоимость установки, продления, абонентская плата за период, описание (данные будут выведены через ";")

subscription.resources Подробная информация о каждом ресурсе. См. подробнее Плейсхолдеры для сущности Ресурс подписки

subscription.billing_type Тип биллинга подписки

subscription.billing_day Число месяца, в которое наступает финансовый день подписки

subscription.billing_day_date Дата ближайшего финансового дня подписки в формате ДД/ММ/ГГГГ

subscription.billing_day_charge Сумма списаний в статусе Открыто, которые будут закрыты или заблокированы в финансовый день, для которого было вызвано событие. Учитываются только подписки, у которых Точка автоматического продления = 0. Применимо для всех неудаленных подписок с месячными платежами (например, с типами биллинга CSP месячный, ESET solutions for ISP (Monthly))

subscription.payment_model

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

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

Чтобы задать условия отображения информации в зависимости от модели оплаты подписки:

Если subscription.payment_model == 'postpay', то отображается информация для подписки только по модели Постоплата.
Если subscription.payment_model == 'prepay', то отображается информация для подписки только по модели Предоплата.

'notification_settings' Для подписки на услуги Microsoft см. пример в 'first_subscription'

subscription.renew_payment_amount Численное значение суммы, необходимой для продления подписки

subscription.renew_payment_amount_currency Сумма, необходимая для продления подписки, с обозначением валюты

subscription.renewal_amount Сумма в валюте реселлера, необходимая для продления подписки. Плейсхолдер можно использовать для отображения суммы с указанием валюты реселлера {{ subscription.renewal_amount | format_as_currency }}

subscription.renewal_amount_in_original_currency Сумма в валюте тарифного плана, необходимая для продления подписки с указанием валюты тарифного плана. Не требует использования модификатора format_as_currency

subscription.renewal_payment.receipt_url Ссылка для загрузки счета на оплату из уведомления об истечении подписки

'first_subscription'

Boolean; является ли подписка на услугу Microsoft первой для клиента. Если подписка является первой, то в уведомлении могут быть отправлены необходимые данные, например, логин и пароль созданной учетной записи в Microsoft Partner Center. Если подписка не первая, можно отправить альтернативную инструкцию с помощью условия {% else %} (см. ниже примеры возможного использования). Подписки на основе модулей Office365 и MicrosoftCspProducts считаются для клиента вместе.

Фрагмент шаблона уведомления для подписок на основе модуля Ofice365:

<strong>Логин</strong>: {{subscription['notification_settings']['office365']['login']}}
<br /> {% if subscription['notification_settings']['office365']['first_subscription'] %} <strong>Пароль</strong>: {{subscription['notification_settings']['office365']['password']}} {% else %} <strong>Пароль</strong>: действующий пароль аккаунта в портале Microsoft. {% endif %}

Фрагмент шаблона уведомления для подписок на основе модуля MicrosoftCspProducts:

{% if subscription['notification_settings']['microsoft_csp_products']['first_subscription'] %} <strong>Ваш логин</strong>: {{subscription['notification_settings']['microsoft_csp_products']['login']}}
<br />
<strong>Временный пароль</strong>: {{subscription['notification_settings']['microsoft_csp_products']['password']}}
<br /> {% else %} Для входа используйте ранее полученный логин. <br /> {% endif %}

Подробнее о настройке уведомлений для услуг Microsoft см. Services. Operator Guide.

subscription.csp Плейсхолдер, возвращающий массив подписок клиента, которые предоставляются по программе Microsoft CSP. Используется, например, для отправки отдельного сообщения о необходимости пополнить баланс для подписок по программе Microsoft CSP

subscriptions Массив подписок клиента

subscriptions[].billing_type Тип биллинга подписки из множества подписок клиента

subscriptions[].billing_day Число месяца, в которое наступает финансовый день подписки из множества подписок клиента

subscriptions[].billing_day_date Дата ближайшего финансового дня в формате ДД/ММ/ГГГГ подписки из множества подписок клиента

subscriptions[].billing_day_charge Сумма списаний в статусе Открыто, которые будут закрыты или заблокированы в финансовый день, для которого было вызвано событие. Учитываются только подписки, у которых Точка автоматического продления = 0. Применимо для всех неудаленных подписок с месячными платежами (например, с типами биллинга CSP месячный, ESET solutions for ISP (Monthly))

subscriptions[].payment_model

Список подписок в зависимости от модели оплаты:

Если subscriptions[].payment_model == "postpay", то в списке отображаются подписки только по модели Постоплата.
Если subscriptions[].payment_model == "prepay", то в списке отображаются подписки только по модели Предоплата.

subscription_postpay.credit_limit

subscription.credit_limit

Величина задолженности по подписке, при превышении которой подписка по модели Постоплата будет остановлена

subscription_postpay.current_debt

subscription.current_debt

Текущее потребление по подписке как сумма всех списаний по подписке за текущий финансовый период в статусе Заблокировано

subscription.responsible_managers_by_product_id[PRODUCT_ID]['KEY_MANAGER_ROLE']['email']} Email ответственного сотрудника по продукту с этой ролью (см. Управление ответственными сотрудниками) по ID продукта и ключу роли сотрудника

subscription.responsible_managers_by_product_id[PRODUCT_ID]['KEY_MANAGER_ROLE']['name'] Имя ответственного сотрудника по продукту с этой ролью (см. Управление ответственными сотрудниками) по ID продукта и ключу роли сотрудника

subscription['resources'][RESOURCE_PRIORITY].included

Количество ресурса с приоритетом RESOURCE_PRIORITY, включенное в подписку (подробнее о приоритетах ресурсов см. Ресурсы тарифного плана)

Количество приоритетного ресурса в рамках подписки:

subscription['resources'][0].included | plus: subscription['resources'][0].additional

См. также Плейсхолдеры для сущности Ресурс подписки

subscription['resources'][RESOURCE_PRIORITY].additional

Дополнительное количество ресурса с приоритетом RESOURCE_PRIORITY, заказанное в рамках подписки (подробнее о приоритетах ресурсов см. Ресурсы тарифного плана)

Количество приоритетного ресурса в рамках подписки:

subscription['resources'][0].included | plus: subscription['resources'][0].additional

См. также Плейсхолдеры для сущности Ресурс подписки

subscription.application_attributes.'plugin_slug'.'attribute_key'

Значение дополнительного атрибута с указанным ключом (см. Просмотр информации об экземпляре услуги) для подписки на основе модуля, определяемого с помощью plugin_slug:

Значение plugin_slug	Модуль
office365	Office365
microsoft_csp_products	MicrosoftCspProducts
vendor_service	Vendor Service Plugin (VSP)
manual_provisioning	Ручной провижининг (Manual Provisioning plugin)

Плейсхолдер	Описание
subscription.application_attributes.office365.user_manual	Инструкция по активации подписки
subscription.application_attributes.vendor_service.user_manual
subscription.application_attributes.microsoft_csp_products.user_manual
subscription.application_attributes.vendor_service.external_id	Внешний ID подписки

subscription.last_billing_period_closed_charges_amount Сумма списаний в статусе Закрыто для подписки, которые были закрыты за предыдущий финансовый период. Сумма равна сумме списаний по подписке в акте за прошедший финансовый период

subscription.budget_amount_with_currency Установленный бюджет расходов по подписке с обозначением валюты реселлера (события уведомлений Расходы по подписке приближаются к установленному бюджету расходов на период и Расходы по подписке достигли установленного бюджета расходов на период)

subscription.recipients.emails Заданные получатели уведомлений о расходах по подписке с учетом установленного бюджета и порога (события уведомлений Расходы по подписке приближаются к установленному бюджету расходов на период и Расходы по подписке достигли установленного бюджета расходов на период)

subscription.last_billing_period_start_day Сравнительные расходы клиента за прошлый и позапрошлый финансовые периоды, а также еженедельная динамика расходов в разрезе категорий ресурсов подписки. Используются только в шаблоне уведомления для события Финансовый день по подписке клиента наступил (Billing day for account's subscription has come). Подробнее см. пример кода в Создание события уведомлений.

subscription.last_billing_period_end_day

subscription.last_billing_period_year

subscription.last_billing_period_month

subscription.last_billing_period_amount_with_currency

subscription.last_billing_period_amount

subscription.pre_last_billing_period_amount

subscription.pre_last_billing_period_amount_with_currency

subscription.pre_last_billing_period_month

subscription.pre_last_billing_period_year

subscription.change_in_periods

subscription.resource_categories

subscription.decorated_steps

subscription.resources_total_by_weeks

subscription.max_totals_sum_weekly

subscription.sales_order.total Сумма заказа на покупку в валюте реселлера. Плейсхолдер можно использовать для отображения суммы с указанием валюты реселлера {{ subscription.sales_order.total | format_as_currency }}

subscription.sales_order.total_in_original_currency Сумма заказа на покупку в валюте тарифного плана с указанием валюты тарифного плана. Не требует использования модификатора format_as_currency

subscription.sales_order.charges

Список списаний по заказу на покупку. Используется вместе с плейсхолдерами для списаний (см. Плейсхолдеры для сущностей Заказ, Списание) для событий уведомлений о заказе, а также Подписка изменена и VSP подписка создана

<div> SO </div>
  <div>Subscription sales order total: {{ subscription.sales_order.total }}</div>
  <div>Subscription sales order total in original currency: {{ subscription.sales_order.total_in_original_currency }}</div>
  <table>
    <tr>
      <td>Description</td>
      <td>Unit price</td>
      <td>Unit price in original currency</td>
      <td>Quantity</td>
      <td>Discount amount</td>
      <td>Discount amount in original currency</td>
      <td>Period</td>
      <td>Amount</td>
      <td>Amount in original currency</td>
      <td>Operate from</td>
      <td>Operate to</td>
      <td>Resource name</td>
    </tr>
{% for charge in subscription.sales_order.charges %}
    <tr>
      <td>{{ charge.description }}</td>
      <td>{{ charge.unit_price }}</td>
      <td>{{ charge.unit_price_in_original_currency }}</td>
      <td>{{ charge.quantity }}</td>
      <td>{{ charge.discount_amount }}</td>
      <td>{{ charge.discount_amount_in_original_currency }}</td>
      <td>{{ charge.period }}</td>
      <td>{{ charge.amount }}</td>
      <td>{{ charge.amount_in_original_currency }}</td>
      <td>{{ charge.operate_from }}</td>
      <td>{{ charge.operate_to }}</td>
      <td>{{ charge.resource_name }}</td>
    </tr>
{% endfor %}
  </table>

subscription.last_change_order.total Сумма последнего для подписки заказа на изменение количества ресурсов в валюте реселлера. Плейсхолдер можно использовать для отображения суммы с указанием валюты реселлера {{ subscription.last_change_order.total | format_as_currency }}

subscription.last_change_order.total_in_original_currency Сумма последнего для подписки заказа на изменение количества ресурсов в валюте тарифного плана с указанием валюты тарифного плана. Не требует использования модификатора format_as_currency

subscription.last_change_order.charges

Список списаний по последнему для подписки заказу на изменение количества ресурсов. Используется вместе с плейсхолдерами для списаний (см. Плейсхолдеры для сущностей Заказ, Списание) для событий уведомлений о заказе, а также Подписка изменена и VSP ресурсы изменились

 <div> CO </div>
  <div>Subscription change order total: {{ subscription.last_change_order.total }}</div>
  <div>Subscription change order total in original currency: {{ subscription.last_change_order.total_in_original_currency }}</div>
  <table>
    <tr>
      <td>Description</td>
      <td>Unit price</td>
      <td>Unit price in original currency</td>
      <td>Quantity</td>
      <td>Discount amount</td>
      <td>Discount amount in original currency</td>
      <td>Period</td>
      <td>Amount</td>
      <td>Amount in original currency</td>
      <td>Operate from</td>
      <td>Operate to</td>
      <td>Resource name</td>
    </tr>
{% for charge in subscription.last_change_order.charges %}
    <tr>
      <td>{{ charge.description }}</td>
      <td>{{ charge.unit_price }}</td>
      <td>{{ charge.unit_price_in_original_currency }}</td>
      <td>{{ charge.quantity }}</td>
      <td>{{ charge.discount_amount }}</td>
      <td>{{ charge.discount_amount_in_original_currency }}</td>
      <td>{{ charge.period }}</td>
      <td>{{ charge.amount }}</td>
      <td>{{ charge.amount_in_original_currency }}</td>
      <td>{{ charge.operate_from }}</td>
      <td>{{ charge.operate_to }}</td>
      <td>{{ charge.resource_name }}</td>
    </tr>
{% endfor %}
  </table>

subscription.last_switch_order.total Сумма последнего для подписки заказа на переключение тарифного плана в валюте реселлера. Плейсхолдер можно использовать для отображения суммы с указанием валюты реселлера {{ subscription.last_switch_order.total | format_as_currency }}

subscription.last_switch_order.total_in_original_currency Сумма последнего для подписки заказа на переключение тарифного плана в валюте тарифного плана с указанием валюты тарифного плана. Не требует использования модификатора format_as_currency

subscription.last_switch_order.charges

Список списаний по последнему для подписки заказу на переключение тарифного плана. Используется вместе с плейсхолдерами для списаний (см. Плейсхолдеры для сущностей Заказ, Списание) для событий уведомлений о заказе, а также Подписка изменена и Подписка переведена из пробного статуса в платный

  <div> CH </div>
  <div>Subscription switch_order total: {{ subscription.last_switch_order.total }}</div>
  <div>Subscription switch order total in original currency: {{ subscription.last_switch_order.total_in_original_currency }}</div>
  <table>
    <tr>
      <td>Description</td>
      <td>Unit price</td>
      <td>Unit price in original currency</td>
      <td>Quantity</td>
      <td>Discount amount</td>
      <td>Discount amount in original currency</td>
      <td>Period</td>
      <td>Amount</td>
      <td>Amount in original currency</td>
      <td>Operate from</td>
      <td>Operate to</td>
      <td>Resource name</td>
    </tr>
{% for charge in subscription.last_switch_order.charges %}
    <tr>
      <td>{{ charge.description }}</td>
      <td>{{ charge.unit_price }}</td>
      <td>{{ charge.unit_price_in_original_currency }}</td>
      <td>{{ charge.quantity }}</td>
      <td>{{ charge.discount_amount }}</td>
      <td>{{ charge.discount_amount_in_original_currency }}</td>
      <td>{{ charge.period }}</td>
      <td>{{ charge.amount }}</td>
      <td>{{ charge.amount_in_original_currency }}</td>
      <td>{{ charge.operate_from }}</td>
      <td>{{ charge.operate_to }}</td>
      <td>{{ charge.resource_name }}</td>
    </tr>
{% endfor %}
  </table>

subscription.unexpected_consumptions

Список дней и сумм пикового потребления по подписке для события Обнаружение неожиданного увеличения потребления

{% for unexpected_consumption in subscription.unexpected_consumptions %}

  <p>Unexpected consumption date: {{ unexpected_consumption.date | format_as_date }}</p>

  <p>Unexpected consumption amount: {{ unexpected_consumption.amount | format_as_currency }}</p>

{% endfor %}

Только для подписок на тарифные планы, полученные из Vendor Portal (события уведомлений VSP подписка создана и VSP ресурсы изменились), доступны следующие плейсхолдеры:

Плейсхолдер Описание

application.subscription_attribute_{attribute_key}

Значение дополнительного атрибута c типом Subscription attribute и ключом {attribute_key}, где {attribute_key} — ключ дополнительного атрибута, указанный при создании продукта в Vendor Portal.

Например, application.subscription_attribute_first_password — плейсхолдер для дополнительного атрибута с типом Subscription attribute и ключом first_password

application.distributor_attribute_{attribute_key}

Значение дополнительного атрибута c типом Distributor attribute и ключом {attribute_key}, где {attribute_key} — ключ дополнительного атрибута, указанный при создании продукта в Vendor Portal.

Например, application.distributor_attribute_base_url — плейсхолдер для дополнительного атрибута с типом Distributor attribute и ключом base_url