Placeholders used in notification templates for specific event handlers

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

host

The reseller domain

Agreement updated

All placeholders for the Account, User, Reseller

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

Invoice closed

The Invoice was approved

The Invoice was revoked

All placeholders for the Account, Invoice entities

See

,

Password reset request

All placeholders for the User entity

See

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

Request for quote changed

All placeholders for the Account, User, Reseller, Manager, Quote entities

See

,

, 

,

, 

User invitation

inviter.short_name

The first and last name of the contract person — the account representative (see

)

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

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

See Placeholders for the Manager entity

token

The 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_active

The multi-factor authentication (MFA) status of a manager (see

):

• true — the MFA status is Active.

• false — the MFA status is Inactive.

security_setting.mfa_mandatory

The status of the Mandatory use setting in the MFA settings of the reseller (see

):

• true — the Mandatory use setting is On.

• false — the Mandatory use setting is Off.

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 changed (previously — Payment has been received)

Postpay payment created

Payment due date is coming

Payment due date has come

All placeholders for the Account entity

See

Placeholders for the Payment entity

See Placeholders for the Payment and Guaranteed payment entities

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 (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 entities

See 

, 

, 

subscriptions_plan_category_keys

The 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

DAYS_PASSED

The number of days passed after the subscription expiration date

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

See Placeholders for the Reseller entity

Before account's postpaid subscriptions expiration

Placeholders for the Account, Reseller, Subscription, Product (upgrade-to products) entities

See

,

,

, 

Order changed

Order created

Resend the order

Order completed (immediate)

Orders completed (by period) 

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

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

,

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

Placeholders for the Subscription Resource entity

See 

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

subscription.id

The subscription ID

subscription.name

The subscription name

subscription.plan.name

The plan name for a subscription

operation.id

The manual operation ID (see

)

operation.name

The manual operation type (see

). 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:

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

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

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

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

• 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_number

The 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:

• For a prepaid subscription — the subscription credit limit set in the account class (see Creating an account class).

• For a postpaid subscription — the subscription credit limit set on the subscription details page (see Viewing and updating subscription's details).

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 all billing types, the current debt of a subscription equals the total amount of its charges in the Blocked and Closed statuses for the current billing period.

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.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

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 Subscription entity

See Placeholders for the Subscription entity

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

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 completed

Only placeholders for the Reseller entity

See

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 detection

Placeholders for the Account, User, Subscription entities

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

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 Generated

subscription.id

The subscription ID

subscription.name

The 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

)

Microsoft pending PO document

All placeholders for the Order, Account, Reseller, Subscription entities

See

,

,

,

,

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

start_date

The start date of a period

end_date

The 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

No PEC for AzurePlan subscription

pec_status

The PEC status for a Microsoft Azure Plan subscription — indicates the presence of PEC in the previous day's consumption data. Possible values:

• yes

• partially

• no

For details, see in ActivePlatform. Services. Operator documentation

pec_coverage

The PEC coverage for a Microsoft Azure Plan subscription — the percentage of the total consumption amount covered by PEC for a billing period.
For details, see in ActivePlatform. Services. Operator documentation

pec_period

The billing period (month, year) for the PEC check. For details, see  in ActivePlatform. Services. Operator documentation

All placeholders for the Account, Reseller, Subscription entities

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