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 changed | account.human_status_name | Current status of the Account | |
Password reset request | token | Unique security code used for authentication | |
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 | confirmation_url | Link for confirmation of an email that was specified during registration in Customer Control Panel | |
Manager password reset request | manager.name | Name of the Manager, who requested the password resetting | |
host | URL of the Reseller installation, the Manager of which requested the password resetting | ||
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 price | 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:
| ||
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 has come | previous_billing_period_start_day | The start day of the previous Billing period with respect to the Billing period for which the Event is occurred (DD.MM.YYYY) | |
previous_billing_period_end_day | The end day of the previous Billing period with respect to the Billing period for which the Event is occurred (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:
| ||
Order created | 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 | ||
Billing day is coming | next_billing_period_start_day | The first day of the next Billing period with reference to the Billing day triggered the Event | |
next_billing_period_end_day | The last day of the next Billing period with reference to the Billing day triggered the Event | ||
The Invoice was approved | invoice.attached.name | File name of the third-party invoice attached to a Payment for a postpaid Invoice with external management (see Managing Invoices for the Postpay model by a third-party ERP system) | |
invoice.attached.url | Link to the file of the third-party invoice attached to a Payment for a postpaid Invoice with external management | ||
invoice.document_number | Number of the third-party invoice attached to a Payment for a postpaid Invoice with external management | ||
invoice.due_date | Due date set for a Payment after approving the linked postpaid Invoice with external management | ||
Manual Operation | manual_operation.link | Link to the Manual Operation | |
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 Order displayed on the confirmation page. The Placeholder supports displaying the Reseller currency {{ 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 |