Placeholders used in notification templates for specific event handlers
See also Using placeholders for event handlers.
The table lists the placeholders that can be used in notification templates only for specific event handlers (see Creating an event handler):
| Event Handler | Placeholder | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Account credit hold is coming Account changed Account created Financial blocking threshold was changed Account manager changed Low balance | All placeholders for the Account, Owner, Reseller entities | See Placeholders for the Account entity, A common set of placeholders for all events, Placeholders for the Reseller entity The | ||||||||||
| host | The reseller domain | |||||||||||
Invoice closed The Invoice was approved | All placeholders for the Account, Invoice entities | See Placeholders for the Account entity, Placeholders for the Invoice entity | ||||||||||
| Password reset request | All placeholders for the User entity | See Placeholders for the User entity | ||||||||||
| token | The unique security code used for authentication | |||||||||||
| url | A link for resetting the password | |||||||||||
| locale | The language of the UI selected during the user registration | |||||||||||
| User invitation | inviter.short_name | The first and last name of the contract person — the account representative (see Viewing and updating account's details) | ||||||||||
| inviter.first_name | The first name of the contract person — the account representative | |||||||||||
| inviter.last_name | The last name of the contract person — the account representative | |||||||||||
| inviter.name | The account name for the invitation | |||||||||||
| inviter.id | The account ID for the invitation | |||||||||||
| invite_url | A link that allows the invited person to go to the Customer Control Panel | |||||||||||
| token | The unique token for inviting a new user | |||||||||||
| host | The reseller domain | |||||||||||
| Verify email | All placeholders for the User entity | See Placeholders for the User entity The | ||||||||||
| confirmation_url | a link for confirmation of an email that was specified during registration in the Customer Control Panel | |||||||||||
| token | The unique security code used for authentication | |||||||||||
| locale | The language of the UI selected during the user registration | |||||||||||
| host | The reseller domain | |||||||||||
| Manager password reset request | All placeholders for the Manager entity | |||||||||||
| token | The unique security code used for authentication | |||||||||||
| Upload CSP net costs | csp_price_file.accepted_at | The date when the new base prices for Microsoft Office 365 plans were applied | ||||||||||
| Net cost has been changed | price_changed_total | The total amount of plans, for which the net cost has been changed | ||||||||||
| price_changed_time | The date and time of net cost changing in plans | |||||||||||
| plans[].name | The names of plans, for which the net cost has been changed | |||||||||||
| plans[].id | The IDs of plans, for which the net cost has been changed | |||||||||||
| plans[].link | Links to plans, for which the net cost has been changed | |||||||||||
| price_list.link | A link to the price list section | |||||||||||
Payment has been received Postpay payment created Payment due date is coming | All placeholders for the Account entity | See Placeholders for the Account entity | ||||||||||
| Placeholders for the Payment entity | See Placeholders for the Payment and Guaranteed payment entities The following placeholders for the Payment entity are not supported by the events:
| |||||||||||
Billing day for manager's subscriptions has come (former Billing day has come) | previous_billing_period_start_day | The start day of the previous billing period regarding the billing day triggered the event (DD.MM.YYYY) | ||||||||||
| previous_billing_period_end_day | The end day of the previous billing period regarding the billing day triggered the event (DD.MM.YYYY) | |||||||||||
| manager_accounts | Accounts of the manager | |||||||||||
| manager_accounts[].id | The account ID | |||||||||||
| manager_accounts[].primary_name | The account primary name | |||||||||||
| manager_accounts[].type_key | The account type key | |||||||||||
| manager_accounts[].class_key | The account class key | |||||||||||
| manager_accounts[].balance | The account balance | |||||||||||
| manager_accounts[].financial_blocking_threshold | The value of the financial blocking threshold that is set in the account class or redefined on the account level | |||||||||||
| manager_accounts[].subscriptions[] | Subscriptions of the account | |||||||||||
| manager_accounts[].subscriptions[].id | The subscription ID | |||||||||||
| manager_accounts[].subscriptions[].name | The subscription name | |||||||||||
| manager_accounts[].subscriptions[].payment_model | The payment model: prepay or postpay | |||||||||||
| manager_accounts[].subscriptions[].payment_model_parameters[] | The postpaid subscription parameters (
| |||||||||||
| manager_accounts[].subscriptions[].plan_category_key | The plan category key used to check whether the account has non-deleted subscriptions within the specified plan category | |||||||||||
| manager_accounts[]. subscriptions[].closed_charges_amount | The amount of closed charges for a subscription for the previous billing period | |||||||||||
Before subscription expiration After subscription expiration After subscription switched from trial to no-trial Subscription changed Credit limit for postpaid subscription was changed Credit limit for postpaid subscription is approaching | All placeholders for the Account, Subscription, Product entities | See Placeholders for the Account entity, Placeholders for the Subscription entity, Placeholders for the Product entity For the After subscription switched from trial to no-trial event, the | ||||||||||
| DAYS_PASSED | The number of days passed after the subscription expiration date The placeholder can be used with the After subscription expiration event only. | |||||||||||
| sales_order_creator.email | The email of the manager or the account user who created a sales order for a subscription Specified in the To field of an email template | |||||||||||
| sales_order_creator.name | The first and last name of the manager or the account user who created a sales order for a subscription | |||||||||||
| reseller.managers_admin_emails | The list of emails of all managers with the System administrator role (see Managers' roles) of the reseller linked to the account and subscription Specified in the To field of an email template | |||||||||||
Order changed Order created Resend the order | All placeholders for the Order, Account, Owner, Reseller, Subscription, Product, Payment entities | See Placeholders for the Order and Charge entities, Placeholders for the Account entity, A common set of placeholders for all events, Placeholders for the Reseller entity, Placeholders for the Subscription entity, Placeholders for the Product entity, Placeholders for the Payment and Guaranteed payment entities The | ||||||||||
| billing_day_date | The date of the billing day when the event occurs | |||||||||||
| host | The URL of the installation | |||||||||||
Guaranteed payment created Guaranteed payment changed Guaranteed payment will expire | All placeholders for the Account, Guaranteed payment entities | See Placeholders for the Account entity, Placeholders for the Payment and Guaranteed payment entities | ||||||||||
| Billing day is coming | next_billing_period_start_day | The first day of the next billing period regarding the billing day triggered the event | ||||||||||
| next_billing_period_end_day | The last day of the next billing period regarding the billing day triggered the event | |||||||||||
| Manual Operation | All placeholders for the Account, Owner, Reseller entities | See Placeholders for the Account entity, A common set of placeholders for all events, Placeholders for the Reseller entity The | ||||||||||
| subscription.id | The subscription ID | |||||||||||
| subscription.name | The subscription name | |||||||||||
| operation.id | The manual operation ID (see Manual operations) | |||||||||||
| operation.name | The manual operation type (see Viewing the list of manual operations). Example: manual_provisioning_plugin_application_install | |||||||||||
| 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
| |||||||||||
| order_resources (array: target_id, target_type, type, operation_value, description) | Ordered items as an array. Example: {"target_id"=>3008674, "target_type"=>"Subscription", "type"=>"ProvisioningItem::New", "operation_value"=>1, "description"=>"CSPMonthly"}{"target_id"=>39874, "target_type"=>"SubscriptionResource", "type"=>"ProvisioningItem::Upgrade", "operation_value"=>2, "description"=>"Licenses"} | |||||||||||
| order_subscription_params (array: name, key, value) | Additional attributes of a subscription in a sales order as an array | |||||||||||
| subscription_resources (array: id, name, count) | The target configuration of a subscription as an array. Example: {"id"=>39871, "name"=>"vRAM", "count"=>0}{"id"=>39872, "name"=>"Storage", "count"=>0}{"id"=>39873, "name"=>"CPU", "count"=>0}{"id"=>39874, "name"=>"Licenses", "count"=>4} | |||||||||||
| subscription_resources_was (array: name, count) | The previous configuration of a subscription as an array | |||||||||||
| manual_operation.link | A link to the manual operation in the reseller's domain | |||||||||||
| shopping_cart_item.plan_id | The plan ID in the order that requires approval (see Ordering a postpaid subscription to a commercial period) | |||||||||||
| shopping_cart_item.plan_name | The plan name in the order that requires approval | |||||||||||
| shopping_cart_item.period_id | The plan period ID in the order that requires approval | |||||||||||
| shopping_cart_item.period_duration_value | The plan period duration in the order that requires approval | |||||||||||
| shopping_cart_item.period_duration_type | The plan period duration type in the order that requires approval (year, month, day) | |||||||||||
| shopping_cart_item.total | The total amount of the sales order in the plan currency. If the reseller and plan currencies match, the placeholder can be used to display the order amount with the reseller currency units {{ shopping_cart_item.total | format_as_currency }} | |||||||||||
| resource.name |
| |||||||||||
| resource.count |
| |||||||||||
| resource.description | The name of a resource in the change order for a service based on the Manual Provisioning plugin | |||||||||||
| resource.type | The operation type for a resource in the change order for a service based on the Manual Provisioning plugin:
| |||||||||||
| resource.operation_value |
| |||||||||||
| param.name |
For the specifics of parameters of an application template based on the Manual Provisioning plugin, see Managing parameters of an application template. | |||||||||||
| param.resource_name | The name of a resource that has an additional attribute (a parameter of the application template applied to a resource) for a service based on the Manual Provisioning plugin | |||||||||||
| param.value |
| |||||||||||
Joined payment created Resend the joined payment | account.id | The account ID | ||||||||||
| account.name | The account name | |||||||||||
account.balance including {{ account.balance | format_as_currency }} | The account balance | |||||||||||
| payment.id | The payment ID | |||||||||||
payment.total including {{ payment.total | format_as_currency }} | The total amount of the payment | |||||||||||
| payment.document_number | The payment number | |||||||||||
| payment.link | A link to the payments section of the Customer Control Panel filtered by the payment number (for example, https://{{domain}}/accounts/{{account_id}}/payments?document_id=AP000000834) | |||||||||||
payment.earliest_charge_from_date including {{ payment.earliest_charge_from_date | format_as_date }} | The earliest from date in charges linked to the payment | |||||||||||
| payment.subscriptions | The iterator that allows displaying the array of the subscriptions linked to the payment (see the example above) | |||||||||||
| subscription.id | The ID of a subscription from the array of subscriptions linked to the payment. It is used with the payment.subscriptions iterator | |||||||||||
| subscription.name | The name of a subscription from the array of subscriptions linked to the payment. It is used with the payment.subscriptions iterator | |||||||||||
| payment.days_passed | The number of days passed after creating the joined payment The | |||||||||||
| Manager created | manager.email | The manager's email used as the login | ||||||||||
| manager.name | The manager's name | |||||||||||
| reseller.domain | The domain name of the manager's reseller | |||||||||||
| token | The unique key for setting the manager's password on the first signing in | |||||||||||
| Billing day for account's subscription has come | past_billing_period_start_day | The start day of the previous billing period regarding the billing day triggered the event (DD.MM.YYYY or MM/DD/YYYY) The "%m %Y" parameter is supported as follows: {{ past_billing_period_start_day | date: "%m %Y" }} | ||||||||||
| past_billing_period_end_day | The end day of the previous Billing period regarding the Billing day triggered the Event (DD.MM.YYYY) | |||||||||||
| All placeholders for the Account entity | See Placeholders for the Account entity | |||||||||||
| Placeholders for the Subscription entity | See Placeholders for the Subscription entity The following placeholders for the Subscription entity are not supported by the event:
| |||||||||||
| Correction approved | All placeholders for the Account, Correction entities | |||||||||||
| Data processing for Azure Plan subscriptions completed | Only placeholders for the Reseller entity | See Placeholders for the Reseller entity | ||||||||||
Spending budget for a period is approaching Spending budget has been reached | Placeholders for the Account, User, Subscription entities | See Placeholders for the Account entity, Placeholders for the User entity, Placeholders for the Subscription entity:
| ||||||||||