Placeholders for the Subscription entity

The following Placeholders are used for the Subscription entity.

Placeholder Description

subscription.id Subscription ID

subscription.name

Subscription name

subscription.status Subscription status

subscription.start_date Activation date of the Subscription

subscription.expiration_date Expiration date of the Subscription (see Setting the expiration date of a subscription)

subscription.auto_renewal Boolean; the Auto-renew option of the Subscription is activated (see Auto-renewing a subscription)

subscription.auto_renewal_disabled Boolean; the Disable the Auto-renew option option of the Subscription is activated

subscription.plan_auto_renewal_disabled Boolean; the Disable the Auto-renew option option of the linked Plan is activated

subscription.days_left

Number of days until the expiration date of the Subscription

subscription.days_passed

Number of days that have passed since the expiration date of the Subscription

subscription.trial Boolean; Subscription available only for the trial period

subscription.account Name of the Account, which ordered the Subscription

subscription.plan_class Name of the Service Term (see Managing service terms)

subscription.plan

General information about the Plan: ID, name, description, status, Service Term ID (data will be separated by ";")

subscription.plan_period

General information about the Plan period: duration, trial, setup fee, recurring fee/ month, transfer fee, renewal fee, etc. (data will be separated by ";")

subscription.resources Inserting detailed information about every Resource of the Subscription. See Placeholders for the Subscription Resource entity

subscription.billing_type Billing type of the Subscription

subscription.billing_day Day of the month, which is set as a Subscription Billing day

subscription.billing_day_date Date of the nearest Billing day of the Subscription in the dd/mm/yyyy format

subscription.billing_day_charge Total amount of Charges in the Open status that will be closed or blocked on the Billing day that caused the Notification event occurring. Only Subscriptions with the Auto-renew point (days) = 0 are counted. Applied to the G-Suite, CSP monthly, Pay in Full, ESET solutions for ISP (Monthly), and Non-refund billing types

subscription.payment_model

Payment model: prepay of postpay.

To display information about a Subscription with the specified payment model:

If subscription.payment_model == 'postpay', displays information about a postpaid Subscription only.
If subscription.payment_model == 'prepay', displays information about a prepaid Subscription only.

'notification_settings' For Subscription to Microsoft Services, see an example in 'first_subscription'

subscription.renew_payment_amount Numeric amount of funds required to renew a Subscription

subscription.renew_payment_amount_currency Amount of funds with currency required to renew a Subscription

subscription.renewal_amount The amount of funds in the Reseller currency required to renew a Subscription. The Placeholder can be used to display the amount with the Reseller currency units {{ subscription.renewal_amount | format_as_currency }}

subscription.renewal_amount_in_original_currency The amount of funds in the Plan currency with the Plan currency units required to renew a Subscription. Does not require specifying the format_as_currency modifier

subscription.renewal_payment.receipt_url

Download link to the receipt (this link is used in the notification about the expiration of the Subscription)

'first_subscription'

The Placeholder for an email template to determine whether it is the first Subscription to Microsoft Services for an Account. If the Microsoft Subscription is the first one, all necessary data can be sent to the customer, for example, the login and password of the created Microsoft account. Otherwise, any alternative information can be sent using the {% else %} instruction (see possible examples below). Subscriptions based on the office365 and microsoft_csp_products Plugins are counted for an Account together.

A fragment of the notification template for a Subscription based on the office365 Plugin:

<strong>Login</strong>: {{subscription['notification_settings']['office365']['login']}}<br/>
{% if subscription['notification_settings']['office365']['first_subscription'] %}
<strong>Password</strong>: {{subscription['notification_settings']['office365']['password']}}
{% else %}
<strong>Password</strong>: current password for your Microsoft account.
{% endif %}

A fragment of the notification template for a Subscription based on the microsoft_csp_products Plugin:

{% if subscription['notification_settings']['microsoft_csp_products']['first_subscription'] %}
<strong>Your login</strong>: {{subscription['notification_settings']['microsoft_csp_products']['login']}}<br/>
<strong>Temporary password</strong>: {{subscription['notification_settings']['microsoft_csp_products']['password']}}<br/>
{% else %}
Use your current login and password for the Microsoft account.<br/>
{% endif %}

For more information about the notifications configuration for Subscriptions to Microsoft Services, see Services. Operator Guide.

subscription.csp Array of the Account Subscriptions within the Microsoft CSP program

subscriptions Array of the Account Subscriptions

subscriptions[].billing_type Billing type of the Subscription

subscriptions[].billing_day Day of the month, which is set as a Subscription Billing day

subscriptions[].billing_day_date Date of the nearest Billing day of the Subscription in the dd/mm/yyyy format

subscriptions[].billing_day_charge Total amount of Charges in the Open status that will be closed or blocked on the Billing day that caused the Notification event occurring. Only Subscriptions with the Auto-renew point (days) = 0 are counted. Applied to the G-Suite, CSP monthly, Pay in Full, ESET solutions for ISP (Monthly), and Non-refund billing types

subscriptions[].payment_model

Array of the Account Subscriptions with the specified payment model:

If subscriptions[].payment_model = "postpay", the array includes postpaid Subscriptions only.
If subscriptions[].payment_model = "prepay", the array includes prepaid Subscriptions only.

subscription_postpay.credit_limit

subscription.credit_limit

Value of the subscription debt, above which the postpaid Subscription will be stopped

subscription_postpay.current_debt

subscription.current_debt

The current consumption for a subscription as the total amount of all blocked charges of a subscription for the current billing period

subscription.responsible_managers_by_product_id[PRODUCT_ID]['KEY_MANAGER_ROLE']['email']} Email of a Responsible Manager (см. Managing responsible managers) by the Product ID and Manager Role key

subscription.responsible_managers_by_product_id[PRODUCT_ID]['KEY_MANAGER_ROLE']['name'] Name of a Responsible Manager (см. Managing responsible managers) by the Product ID and Manager Role key

subscription['resources'][RESOURCE_PRIORITY].included

Amount of the Resource with the RESOURCE_PRIORITY priority included in the Subscription (for more information about the Resource priority, see Plan Resources)

Amount of the main Resource of the Subscription:

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

Inserting detailed information about every Resource of the Subscription: see Placeholders for the Subscription Resource entity

subscription['resources'][RESOURCE_PRIORITY].additional

Additional amount the Resource with the RESOURCE_PRIORITY priority ordered for the Subscription (for more information about the Resource priority, see Plan Resources)

Amount of the main Resource of the Subscription:

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

Inserting detailed information about every Resource of the Subscription: see Placeholders for the Subscription Resource entity

subscription.application_attributes.'plugin_slug'.'attribute_key'

The Placeholder contains the value of an additional attribute by the given key (see Viewing details about an application instance) of a Subscription based on the Plugin defined by plugin_slug:

plugin_slug	Plugin name
`office365`	Office365
`microsoft_csp_products`	MicrosoftCspProducts
`vendor_service`	Vendor Service Plugin (VSP)
`manual_provisioning`	Manual Provisioning

Placeholder	Description
subscription.application_attributes.office365.user_manual	Subscription activation instruction
subscription.application_attributes.vendor_service.user_manual
subscription.application_attributes.microsoft_csp_products.user_manual
subscription.application_attributes.vendor_service.external_id	Subscription External ID

subscription.last_billing_period_closed_charges_amount Amount of Charges in the Closed status for a Subscription which were closed for the previous Billing period. The amount is equal to the amount of Charges for this Subscription in an Invoice for the previous Billing period

subscription.budget_amount_with_currency The spending budget for a subscription, including the reseller currency sign (event handlers Data processing for Azure Plan subscriptions completed and Spending budget has been reached)

subscription.recipients.emails The recipients of a notification about the subscription consumption, regarding the spending budget and notification threshold (event handlers Data processing for Azure Plan subscriptions completed and Spending budget has been reached)

The following Placeholders are available for Subscriptions to the Plans delegated from Vendor Portal (Event handlers VSP subscription created and VSP resources changed):

Placeholder

Description

application.subscription_attribute_{attribute_key}

The Placeholder contains the value of an additional attribute with Subscription attribute type and {attribute_key} key, where {attribute_key} is the attribute key, set during the product creation in Vendor Portal.

For example, application.subscription_attribute_first_password is a Placeholder for an additional attribute with Subscription attribute type and first_password key.

application.distributor_attribute_{attribute_key}

The Placeholder contains the value of an additional attribute with Distributor attribute type and {attribute_key} key, where {attribute_key} is the attribute key, set during the product creation in Vendor Portal.

For example, application.distributor_attribute_base_url is a Placeholder for an additional attribute with Distributor attribute type and base_url key.