Placeholders for the Subscription entity

The following Placeholders are used for the Subscription entity.

PlaceholderDescription
subscription.idSubscription ID

subscription.name

Subscription name
subscription.statusSubscription status
subscription.start_dateActivation date of the Subscription
subscription.expiration_dateExpiration date of the Subscription (see Setting the Expiration Date of a Subscription)
subscription.auto_renewalBoolean; the option for activating the automatic Subscription renewal (see Auto-Renewing a Subscription)
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.trialBoolean; Subscription available only for the trial period
subscription.accountName of the Account, which ordered the Subscription
subscription.plan_className 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.renewal_payment.receipt_url

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

subscription.trial.status

Placeholder (boolean) for tracking the status (trial / no-trial) of the plan period, which is used for the "Subscription is changed" event. You can add this placeholder to the event handler for the "Subscription is changed" event (for example, «subscription.trial = false»). In this case, if the plan period is changed from trial to no-trial, the notifications will be sent.

'first_subscription'

Placeholder in email template for a CSP Subscription to determine whether the CSP Subscription is the first. If the CSP Subscription is the first, necessary data can be sent to the customer, for example, a login and password to Office 365 Portal.

{% if subscription['notification_settings']['Office 365 Enterprise E1']['first_subscription'] %}
    Some text
{% else %}
    Another text
{% endif %}
subscriptionsArray of the Account Subscriptions
subscription.cspArray of the Account Subscriptions within the Microsoft CSP program
subscriptions[].billing_typeBilling type of the Subscription
subscriptions[].billing_dayDay of the month, which is set as a Subscription Billing day
subscriptions[].billing_day_dateDate of the nearest Billing day of the Subscription in the dd/mm/yyyy format
subscriptions[].billing_day_chargeTotal 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 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.renewal_amountAmount of funds that is required for topping up the Account Balance to renew a Subscription in the automatic mode
subscription_postpay.credit_limitValue of the subscription debt, above which the postpaid Subscription will be stopped
subscription_postpay.current_debtSubscription debt that is calculated as the total amount of all blocked Charges for the 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

The following Placeholders are available for the Subscriptions for the Plans delegated from Vendor Portal:

PlaceholderDescription
application.subscription_attribute_{attribute_key}

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}

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.