Placeholders used in notification templates for specific event handlers

See also Using placeholders for event handlers.

If you need a date placeholder to display the previous day's date, use a modifier date: "%s" | minus : 86400. For example: {{ invoice.to_date | date: "%s" | minus : 86400 | date: "%d.%m.%Y" }}

The table lists the placeholders that can be used in notification templates only for specific event handlers (see Creating an event handler):

Event HandlerPlaceholderDescription

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 account.owner_reset_password_url and account.owner_generate_password_url placeholders can be used with the Account created event only.

hostThe reseller domain

Invoice closed


The Invoice was approved


The Invoice was revoked

All placeholders for the Account, Invoice entitiesSee Placeholders for the Account entity, Placeholders for the Invoice entity
Password reset requestAll placeholders for the User entitySee Placeholders for the User entity
tokenThe unique security code used for authentication
urlA link for resetting the password
localeThe language of the UI selected during the user registration
User invitationinviter.short_nameThe first and last name of the contract person — the account representative (see Viewing and updating account's details)
inviter.first_nameThe first name of the contract person — the account representative
inviter.last_nameThe last name of the contract person — the account representative
inviter.nameThe account name for the invitation
inviter.idThe account ID for the invitation
invite_urlA link that allows the invited person to go to the Customer Control Panel
tokenThe unique token for inviting a new user
hostThe reseller domain
Verify emailAll placeholders for the User entity

See Placeholders for the User entity

The user.middle_name placeholder is always empty because the middle name is not specified during the user registration (see Quick registration).

confirmation_urla link for confirmation of an email that was specified during registration in the Customer Control Panel
tokenThe unique security code used for authentication
localeThe language of the UI selected during the user registration
hostThe reseller domain
Manager password reset requestAll placeholders for the Manager entity

See Placeholders for the Manager entity

tokenThe unique security code used for authentication

MFA status for your account has been changed


MFA setting has been changed on the Reseller's side

manager.mfa_activeThe multi-factor authentication (MFA) status of a manager (see Viewing and updating manager's information):
  • true — the MFA status is Active.
  • false — the MFA status is Inactive.
security_setting.mfa_mandatoryThe status of the Mandatory use setting in the MFA settings of the reseller (see Manager settings):
  • true — the Mandatory use setting is On.
  • false — the Mandatory use setting is Off.
Upload CSP net costscsp_price_file.accepted_atThe date when the new base prices for Microsoft Office 365 plans were applied
Net cost has been changedprice_changed_totalThe total amount of plans, for which the net cost has been changed
price_changed_timeThe date and time of net cost changing in plans
plans[].nameThe names of plans, for which the net cost has been changed
plans[].idThe IDs of plans, for which the net cost has been changed
plans[].linkLinks to plans, for which the net cost has been changed
price_list.linkA link to the price list section

Payment has been changed (previously — Payment has been received)


Postpay payment created


Payment due date is coming


Payment due date has come

All placeholders for the Account entitySee 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:

  • payment.status.was

  • payment.panel_link

  • payment.plan_custom_attributes.item

  • payment.plan_resources_custom_attributes.item

Billing day for manager's subscriptions has come

(former Billing day has come)

previous_billing_period_start_dayThe start day of the previous billing period regarding the billing day triggered the event (DD.MM.YYYY)
previous_billing_period_end_dayThe end day of the previous billing period regarding the billing day triggered the event (DD.MM.YYYY)
manager_accountsAccounts of the manager
manager_accounts[].idThe account ID
manager_accounts[].primary_nameThe account primary name
manager_accounts[].type_keyThe account type key
manager_accounts[].class_keyThe account class key
manager_accounts[].balanceThe 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[].idThe subscription ID
manager_accounts[].subscriptions[].nameThe subscription name
manager_accounts[].subscriptions[].payment_modelThe payment model: prepay or postpay
manager_accounts[].subscriptions[].payment_model_parameters[]

The postpaid subscription parameters (payment_model = postpay).

  • "credit_limit" — the subscription credit limit.
  • "current_debt" — the current debt for the subscription.

(see Viewing and updating subscription's details)

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
Placeholders for the Subscription Resource, Manager, Reseller entitiesSee Placeholders for the Subscription Resource entity, Placeholders for the Manager entity, Placeholders for the Reseller entity
subscriptions_plan_category_keysThe plan category keys to check whether a manager has at least one account with a subscription in any status, except for Deleted, within the specified plan categories

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, Subscription Resource entities

See Placeholders for the Account entity, Placeholders for the Subscription entity, Placeholders for the Product entity, Placeholders for the Subscription Resource entity

For the After subscription switched from trial to no-trial event, the subscription.payment_model placeholder can be used with the prepay value only since the event itself is implemented for the Prepay model only.

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.nameThe first and last name of the manager or the account user who created a sales order for a subscription
reseller.managers_admin_emails

See Placeholders for the Reseller entity

Before account's postpaid subscriptions expirationPlaceholders for the Account, Reseller, Subscription, Product (upgrade-to products) entitiesSee Placeholders for the Account entity, Placeholders for the Reseller entity, Placeholders for the Subscription entity, Placeholders for the Product entity

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 order.days_passed placeholder can be used with the Resend the order event only.

billing_day_dateThe date of the billing day when the event occurs
hostThe URL of the installation

Guaranteed payment created


Guaranteed payment changed


Guaranteed payment will expire

All placeholders for the Account, Guaranteed payment entitiesSee Placeholders for the Account entity, Placeholders for the Payment and Guaranteed payment entities
Billing day is comingnext_billing_period_start_dayThe first day of the next billing period regarding the billing day triggered the event
next_billing_period_end_dayThe last day of the next billing period regarding the billing day triggered the event
Placeholders for the Subscription Resource entitySee Placeholders for the Subscription Resource entity
Manual OperationAll 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 account.owner_reset_password_url placeholder cannot be used with the Manual Operation event.

subscription.id

The subscription ID

subscription.nameThe subscription name
subscription.plan.nameThe plan name for a subscription
operation.idThe manual operation ID (see Manual operations)
operation.nameThe 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 plugin_slug:

plugin_slugPlugin name
office365Office365
microsoft_csp_productsMicrosoftCspProducts
vendor_serviceVendor Service Plugin (VSP)
manual_provisioningManual Provisioning

PlaceholderDescription
subscription.application_attributes.office365.user_manualSubscription activation instruction

subscription.application_attributes.vendor_service.user_manual
subscription.application_attributes.microsoft_csp_products.user_manual
subscription.application_attributes.vendor_service.external_idSubscription External ID
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.linkA link to the manual operation in the reseller's domain
shopping_cart_item

Information about a sales order that requires approval. Only for manual operations with operation.type = "postpay_subscription_verify" (see Postpaid orders and manual operations)

PlaceholderDescription
shopping_cart_item.plan_idThe plan ID
shopping_cart_item.plan_nameThe plan name
shopping_cart_item.period_idThe plan period ID
shopping_cart_item.period_duration_valueThe plan period duration
shopping_cart_item.period_duration_typeThe plan period duration type
shopping_cart_item.totalThe 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
  • The name of a resource in the sales order for a service based on the Manual Provisioning plugin
  • The current name of a resource in the subscription for a service based on the Manual Provisioning plugin
resource.count
  • The amount of a resource in the sales order for a service based on the Manual Provisioning plugin
  • The current amount of a resource in the subscription for a service based on the Manual Provisioning plugin
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:

  • ProvisioningItem::Upgrade — increasing the amount of the resource
  • ProvisioningItem::Downgrade — reducing the amount of the resource
resource.operation_value
  • The difference between the current and new amount of a resource in the change order for a service based on the Manual Provisioning plugin
param.name
  • The name of the additional attribute of the subscription (the name of the parameter of the application template applied to the application) for a service based on the Manual Provisioning plugin
  • The name of the additional attribute of a resource (the name of the parameter of the application template applied to a resource) for a service based on the Manual Provisioning plugin

For the specifics of parameters of an application template based on the Manual Provisioning plugin, see Managing connector parameters.

param.resource_nameThe 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
  • The value of the additional attribute of the subscription (the value of the parameter of the application template applied to the application) for a service based on the Manual Provisioning plugin
  • The value of the additional attribute of a resource (the value of the parameter of the application template applied to a resource) for a service based on the Manual Provisioning plugin
payment_document_numberThe number of a payment for a sales order, renewal order, or change order linked to a manual operation
subscription_postpay.credit_limit

The value of the subscription debt above which a postpaid subscription will be blocked:

subscription.credit_limit
subscription_postpay.current_debt

The current consumption for a subscription calculated as on the subscription details page (see Viewing and updating subscription's details):

  • For the Monthly Prolongation, Monthly Commitment, and Pay as you go (external) billing types, the current debt equals the total amount of charges in the Blocked and New statuses of a subscription only for the current billing period.
  • For other billing types, the current debt equals the total amount of all charges in the Blocked and New statuses of a subscription.

subscription.current_debt

The total amount of all blocked charges of a subscription for the current billing period

Joined payment created


Resend the joined payment

account.idThe account ID
account.nameThe account name

account.balance

including {{ account.balance | format_as_currency }}

The account balance
payment.idThe payment ID

payment.total

including {{ payment.total | format_as_currency }}

The total amount of the payment
payment.document_numberThe payment number
payment.linkA 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.subscriptionsThe iterator that allows displaying the array of the subscriptions linked to the payment (see the example above)

subscription.idThe ID of a subscription from the array of subscriptions linked to the payment. It is used with the payment.subscriptions iterator

subscription.nameThe 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 payment.days_passed placeholder can be used with the Resend the joined payment event only.

Manager createdmanager.emailThe manager's email used as the login
manager.nameThe manager's name
reseller.domainThe domain name of the manager's reseller
tokenThe unique key for setting the manager's password on the first signing in
Billing day for account's subscription has comepast_billing_period_start_dayThe 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_dayThe end day of the previous Billing period regarding the Billing day triggered the Event (DD.MM.YYYY)
All placeholders for the Account entitySee 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:

  • first_subscription

  • subscription.csp

  • subscription.renewal_payment.receipt_url

  • subscription.days_passed

  • subscription.days_left

  • subscriptions[]

  • subscriptions[].billing_type

  • subscriptions[].billing_day

  • subscriptions[].billing_day_date

  • subscriptions[].billing_day_charge

  • subscriptions[].payment_model

  • subscription['resources'][RESOURCE_PRIORITY].include

  • subscription['resources'][RESOURCE_PRIORITY].additional

  • subscription.responsible_managers_by_product_id[PRODUCT_ID]['KEY_MANAGER_ROLE']['name']

  • subscription.responsible_managers_by_product_id[PRODUCT_ID]['KEY_MANAGER_ROLE']['email']

Paid amount has been received from external system

All placeholders for the Account, Correction, Manager, External transaction entities

See Placeholders for the Account entity, Placeholders for the Correction entity, Placeholders for the Manager entity, Placeholders for the External transaction entity

Placeholders for the Payment entity

See Placeholders for the Payment and Guaranteed payment entities

Only the following placeholders for the Payment entity are supported by the event:

  • payment.id
  • payment.payment_method
  • payment.document_number
  • payment.total
  • payment.currency
  • payment.created_at
  • payment.expiration_date
  • payment.days_left
  • payment.status
  • payment.comment
Correction approved

All placeholders for the Account, Correction

See Placeholders for the Account entity, Placeholders for the Correction entity

Data processing for Azure Plan subscriptions completedOnly placeholders for the Reseller entitySee 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:

  • To specify the recipients of a notification, use the placeholder subscription.recipients.emails.
  • To display the subscription consumption, use the placeholders subscription.current_debt or subscription_postpay.current_debt.
  • The spending budget details (Subscription entity) are displayed in the default language of the Customer Control Panel (see Managing language settings).
Unexpected consumption increase detectionPlaceholders for the Account, User, Subscription entities

See Placeholders for the Account entity, Placeholders for the User entity, Placeholders for the Subscription entity

Only the following placeholders for the Subscription entity are supported by the event:

  • subscription.id

  • subscription.name

  • subscription_postpay.current_debt

  • subscription.current_debt

  • subscription.unexpected_consumptions

An example of a link to the subscription analytics in the new Customer Control Panel with placeholders: https://{{ reseller.custom_attributes['vendor_ccp'] }}/client/subscriptions/{{subscription.id}}/analytics?account_id={{account.id}}&filter[details]=day&filter[billing-period]=current

AppSource Activation Link Generatedsubscription.idThe subscription ID
subscription.nameThe subscription name
application['first_subscription']Check whether it is the first Microsoft subscription of an account
application['login']A login to access Microsoft admin portal
application['password']A temporary password to access Microsoft admin portal for the first time
application['activation_link']A link to activate the service on the vendor side (see Creating a notification template for the Microsoft AppSource service activation)
Microsoft pending PO documentAll placeholders for the Order, Account, Reseller, Subscription entitiesSee 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
Microsoft rejected PO document
Closing documents generated
All placeholders for the Account, Owner, Reseller, Closing document entities

See Placeholders for the Account entity, A common set of placeholders for all events, Placeholders for the Reseller entity, Placeholders for the Closing document entity

The account.owner_reset_password_url and account.owner_generate_password_url placeholders cannot be used with this event.

start_dateThe start date of a period
end_dateThe end date of a period
The report with daily consumptions of pay-as-you-go subscriptions is ready
Placeholders for the Account, User, Consumption report entities

See Placeholders for the Account entity, Placeholders for the User entity, Placeholders for the Consumption report entity

Only the following placeholders for the Account entity are supported by the event:

  • account.name
  • account.id
  • account.first_name
  • account.middle_name
  • account.last_name