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 Placeholder | ||||||||
| host | URL of the installation | |||||||||
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 | Unique security code used for authentication | |||||||||
| url | Link for resetting the password | |||||||||
| locale | Language of the UI for the User | |||||||||
| User invitation | inviter.short_name | Name of a User that has sent the invitation | ||||||||
| invite_url | Link that allows the invited person to go to Customer Control Panel | |||||||||
| Verify email | All Placeholders for the User entity | See Placeholders for the User entity
| ||||||||
| confirmation_url | Link for confirmation of an email that was specified during registration in Customer Control Panel | |||||||||
| token | Unique security code used for authentication | |||||||||
| locale | Language of the UI for the User | |||||||||
| Manager password reset request | All Placeholders for the Manager entity | |||||||||
| token | Unique security code used for authentication | |||||||||
| After subscription expiration | DAYS_PASSED | Number of days passed after the Subscription has expired | ||||||||
| subscription.payment_model | Displays information about a Subscription with the specified payment model:
Only | |||||||||
| Upload CSP net costs | csp_price_file.accepted_at | Date when the new base prices for Microsoft Office 365 Plans were applied | ||||||||
| After subscription switched from trial to non-trial | subscription.payment_model | Displays information about a Subscription with the specified payment model:
| ||||||||
| Subscription changed | subscription['notification_settings']['office365']['password'] | Automatically generated password to the Microsoft Office 365 control panel, which is sent to customer after the first order of Microsoft Azure or Microsoft Office 365 Subscription | ||||||||
| subscription['notification_settings']['office365']['login'] | Customer login to Microsoft Office 365 control panel | |||||||||
| 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.payment_model | Displays information about a Subscription with the specified payment model:
| |||||||||
| sales_order_creator.email | Email of the Manager or the Account's User who created the Sales Order for the Subscription Specified in the To field of an Email Template | |||||||||
| sales_order_creator.name | First and last name of the Manager or the Account's User who created the Sales Order for the Subscription | |||||||||
| subscription.application_attributes.'plugin_slug'.'attribute_key' | 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
| |||||||||
| reseller.managers_admin_emails | 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 | |||||||||
| Net cost has been changed | price_changed_total | Total amount of Plans, for which the net cost has been changed | ||||||||
price_changed_time | Date and time of net cost changing in Plans | |||||||||
| plans[].name | Names of Plans, for which the net cost has been changed | |||||||||
| plans[].id | 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 | Link to Price list section | |||||||||
| Payment due date is coming | payment.days_left | Number of days prior to the end of the Payment expiration period | ||||||||
| payment.id | Payment ID | |||||||||
| payment.total | Total amount of Payment for the Invoice including discount and Corrections (see Viewing details of the Invoice for the Postpay charging model) | |||||||||
| payment.expiration_date | Payment due date | |||||||||
| payment.created_at | Payment creation date | |||||||||
| payment.status | Payment current status | |||||||||
| payment.comment | Additional information about the Payment | |||||||||
| payment.subscriptions | Iterator that allows to display an array of Subscriptions that are related to the Payment | |||||||||
| subscription.id | ID of the Subscription from the array of the Subscriptions related to the Payment (see Paying for the Subscriptions that are linked to the Invoice for the Postpay charging model). It is used along with the payment.subscriptions iterator (see the example above) | |||||||||
| subscription.name | Name of the Subscription from the array of the Subscriptions related to the Payment. It is used along with the payment.subscriptions iterator (see the example above) | |||||||||
| subscription.status | Status of the Subscription from the array of the Subscriptions related to the Payment. It is used along with the payment.subscriptions iterator (see the example above) | |||||||||
| payment.invoice_from_date | Start date of the period of the postpaid Invoice linked to the Payment (DD.MM.YYYY) | |||||||||
| payment.invoice_to_date | End date of the period of the postpaid Invoice linked to the Payment (DD.MM.YYYY) | |||||||||
| payment.link | Link to the Payments section of the Customer Control Payment filtered by the Payment number (for example, https://{{domain}}/accounts/{{account_id}}/payments?document_id=AP000000834) | |||||||||
| payment.invoice_document_number | Invoice number linked to the Payment | |||||||||
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 | Account ID | |||||||||
| manager_accounts[].primary_name | Account primary name | |||||||||
| manager_accounts[].type_key | Account type key | |||||||||
| manager_accounts[].class_key | Account class key | |||||||||
| manager_accounts[].balance | Account Balance | |||||||||
| manager_accounts[].financial_blocking_threshold | 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 | Subscription ID | |||||||||
| manager_accounts[].subscriptions[].name | Subscription name | |||||||||
| manager_accounts[].subscriptions[].payment_model | Payment model: prepay or postpay | |||||||||
| manager_accounts[].subscriptions[].payment_model_parameters[] | Postpaid Subscription parameters (payment_model = postpay).
| |||||||||
| manager_accounts[].subscriptions[].plan_category_key | Plan Category key that is used for the 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 the Subscription for the previous Billing period | |||||||||
| Before subscription expiration | payment.link | Link to the Customer Control Panel, the Payment section, with the prefilled Payment number filter for the Payment related to the Order | ||||||||
| billing_day_date | The date of the billing day when the Event occurs | |||||||||
| account.balance | Account balance | |||||||||
| account.id | Account ID | |||||||||
| account.name | Account name | |||||||||
| subscription.name | Subscription name | |||||||||
| subscription.payment_model | Displays information about a Subscription with the specified payment model:
| |||||||||
| 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 | |||||||||
| sales_order_creator.email | Email of the Manager or the Account's User who created the Sales Order for the Subscription Specified in the To field of an Email Template | |||||||||
| sales_order_creator.name | First and last name of the Manager or the Account's User who created the Sales Order for the Subscription | |||||||||
| reseller.managers_admin_emails | 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 created Resend the order | payment.link | Link to the Customer Control Panel, the Payment section, with the prefilled Payment number filter for the Payment related to the Order | ||||||||
| billing_day_date | Date of the Billing day when the Event occurs | |||||||||
| account.balance | Account balance | |||||||||
| account.id | Account ID | |||||||||
| account.name | Account name | |||||||||
| subscription.name | Subscription name | |||||||||
| order.total | The total amount of an Order in the Reseller currency. The Placeholder can be used to display the amount with the Reseller currency units {{ order.total | format_as_currency }} | |||||||||
| order.total_in_original_currency | The total amount of an Order in the Plan currency with the Plan currency units. Does not require specifying the format_as_currency modifier | |||||||||
| reseller.managers_admin_emails | List of emails of all Managers with the System administrator role (see Managers' Roles) of the Reseller linked to the Account and Order Specified in the To field of an Email Template | |||||||||
| order.days_passed | Number of days passed after creating the Order Used for the Resend the order Event only | |||||||||
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 Placeholder | ||||||||
| subscription.id | Subscription ID | |||||||||
| subscription.name | Subscription name | |||||||||
| operation.id | Manual Operation ID (see Manual Operations) | |||||||||
| operation.name | Manual Operation type (see Viewing the List of Manual Operations). Example: manual_provisioning_plugin_application_install | |||||||||
| order_resources (array: target_id, target_type, type, operation_value, description) | Ordered items as an arrray. 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) | 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) | Previous configuration of a Subscription as an array | |||||||||
| manual_operation.link | Link to the Manual Operation in the Reseller's domain | |||||||||
| shopping_cart_item.plan_id | Plan ID in the Order that requires approve (see Ordering a postpaid Subscription to a commercial period) | |||||||||
| shopping_cart_item.plan_name | Plan name in the Order that requires approve | |||||||||
| shopping_cart_item.period_id | Plan period ID in the Order that requires approve | |||||||||
| shopping_cart_item.period_duration_value | Plan period duration in the Order that requires approve | |||||||||
| shopping_cart_item.period_duration_type | Plan period duration type in the Order that requires approve (year, month, day) | |||||||||
| shopping_cart_item.total | 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 |
| |||||||||
| Postpay payment created | account.id | Account ID | ||||||||
| account.name | Account name | |||||||||
account.balance including {{ account.balance | format_as_currency }} | Account balance | |||||||||
billing_day_date including {{ billing_day_date | format_as_date:'long' }} | The date of the billing day when the Event occurs | |||||||||
| payment.link | Link to the Payments section of the Customer Control Payment filtered by the Payment number (for example, https://{{domain}}/accounts/{{account_id}}/payments?document_id=AP000000834) | |||||||||
| payment.id | Payment ID | |||||||||
| payment.total | Total amount of Payment for the Invoice including discount and Corrections (see Viewing details of the Invoice for the Postpay charging model) | |||||||||
| payment.status | Payment current status | |||||||||
| payment.created_at | Payment creation date | |||||||||
| payment.expiration_date | Payment due date | |||||||||
| payment.comment | Additional information about the Payment | |||||||||
| payment.document_number | Payment number | |||||||||
| payment.days_left | Number of days prior to the end of the Payment expiration period | |||||||||
| payment.subscriptions | Iterator that allows to display an array of Subscriptions that are related to the Payment | |||||||||
| subscription.id | ID of the Subscription from the array of the Subscriptions related to the Payment (see Paying for the Subscriptions that are linked to the Invoice for the Postpay charging model). It is used along with the payment.subscriptions iterator (see the example above) | |||||||||
| subscription.name | Name of the Subscription from the array of the Subscriptions related to the Payment. It is used along with the payment.subscriptions iterator (see the example above) | |||||||||
| subscription.status | Status of the Subscription from the array of the Subscriptions related to the Payment. It is used along with the payment.subscriptions iterator (see the example above) | |||||||||
| payment.invoice_from_date | Start date of the period of the postpaid Invoice linked to the Payment | |||||||||
| payment.invoice_to_date | End date of the period of the postpaid Invoice linked to the Payment | |||||||||
| Payment has been received | payment.invoice_document_number | Invoice number linked to the Payment | ||||||||
Joined payment created Resend the joined payment | account.id | Account ID | ||||||||
| account.name | Account name | |||||||||
account.balance including {{ account.balance | format_as_currency }} | Account balance | |||||||||
| payment.id | Payment ID | |||||||||
payment.total including {{ payment.total | format_as_currency }} | Total amount of the Payment | |||||||||
| payment.document_number | Payment number | |||||||||
| payment.link | Link to the Payments section of the Customer Control Payment 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 the Charges linked to the Payment | |||||||||
| payment.subscriptions | Iterator that allows displaying the array of the Subscriptions linked to the Payment (see the example above) | |||||||||
| subscription.id | ID of the Subscription from the array of the Subscriptions linked to the Payment. It is used with the payment.subscriptions iterator | |||||||||
| subscription.name | Name of the Subscription from the array of the Subscriptions linked to the Payment. It is used with the payment.subscriptions iterator | |||||||||
| payment.days_passed | Number of days passed after creating the joined Payment The | |||||||||
| Manager created | manager.email | Manager's email which will be used as the login | ||||||||
| manager.name | Manager's name | |||||||||
| reseller.domain | Domain name of the Manager's Reseller | |||||||||
| token | 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:
| |||||||||