Placeholder for the Subscription entity
The following Placeholders are used for the Subscription entity.
Placeholder | Description |
---|---|
subscription.id | an ID of the subscription |
subscription.name | a subscriptions name |
subscription.status | a subscriptions status |
subscription.start_date | an activation date of the subscription |
subscription.expiration_date | an expiration date of the subscription (see Setting the Expiration Date of a Subscription) |
subscription.auto_renewal | boolean; the option for activating the automatic subscription renewal (see Auto-Renewing a Subscription) |
subscription.days_left | a number of days until the expiration date of the subscription |
subscription.days_passed | the number of days that have passed since the expiration date of the subscription |
subscription.trial | boolean; subscription available only for the testing period |
subscription.account | a name of the account, which ordered the subscription |
subscription.plan_class | a name of the plan class (see Managing Plan Classes) |
subscription.plansubscription.plan_class | a general information about the plan class: id, name, description, status, etc. (data will be separated by ";") |
subscription.plan_period | a 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 | a download link to the receipt (this link is used in the notification about the expiration of the subscription) |
subscription.trial.status | a 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' | a 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.
|
subscriptions | an array of the Account Subscriptions |
subscriptions[].billing_type | a billing type of the Subscription |
subscriptions[].billing_day | a day of the month, which is set as a Subscription Billing day |
subscriptions[].billing_day_date | a date of the nearest Billing day of the Subscription in the dd/mm/yyyy format |
subscriptions[].billing_day_charge | a sum of opened Charges for the active (not deleted) Subscriptions with the G-Suite, CSP monthly, Pay in Full billing types that will be closed or blocked on the Billing day that causes the Notification event occurring |
The following Placeholders are available for the Subscriptions for the Plans delegated from Vendor Portal:
Placeholder | Description |
---|---|
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. |