Using placeholders for event handlers

For all events

owner.status

The status of the Owner of an account

string

owner.status = "active"

owner.country

The Owner's address: the two-letter ISO code

 of the country

string

owner.country = "BY"

owner.city

The Owner's address: city

string

owner.city = "Minsk"

current_date

The current date

date

current_date

Account credit hold is coming

Account changed

Account created

Financial blocking threshold was changed

Account manager changed

Low balance

Closing documents generated

Create instance

Reset instance password

account.balance

The current value of the account balance (see Viewing the list of charges)

number

account.balance = 1000

account.balance.was

The previous value of the account balance (see Viewing the list of charges)

number

account.balance.was = 100

account.city

The account address: city

string

account.city = "Minsk"

account.class_id

The account class ID (see

)

integer

account.class_id = 1

account.class_key

The account class key (see

)

string

account.class_key = "manual"

account.country

The account address: the two-letter ISO code

 of the country

string

account.country = "BY"

account.financial_blocking_threshold

The limit within which the account balance can be negative without moving the account to the Credit hold status during the subzero period

number

account.financial_blocking_threshold = 100

account.has_endless_trial_subscriptions

Indicates whether an account has at least one commercial subscription with the endless period

boolean

account.has_endless_trial_subscriptions = true

account.has_manager

Indicates whether an account is linked to a manager

boolean

account.has_manager = true

account.regular_sending

• If account.regular_sending = true, the notification is sent only during the billing process.

• If account.regular_sending = false, the notification is sent only when the balance changes.

• If not specified, the notification is sent in all cases: during the billing processes and when the balance changes.

boolean

account.regular_sending = true

account.status

The current status of an account

string

account.status = "inactive"

account.status.was

The previous status of an account

string

account.status.was = "inactive"

account.subscription_credit_limit

The value of the subscription credit limit of an account

number

account.subscription_credit_limit = 100

account.type_id

The account type ID

integer

account.type_id = 1

account.type_key

The account type key

string

account.type_key = "business"

account.owner_reset_password_url

A one-time link to set the Owner's password

string

account.owner_reset_password_url = "http://example.com/password/edit?reset_password_token=1q2w3e"

Agreement updated

account.class_key

The account class key (see Account classes)

string

account.class_key = "postpay"

account.status

The account status

string

account.status = "active"

request_type

Type of agreement update request (see Requesting agreement update):

• automatically — requested automatically on a schedule.

• manually — requested manually.

string

request_type = "automatically"

agreement_status

Agreement status:

• waiting_for_accept — an update to the agreement has been requested.

string

agreement_status = "waiting_for_accept"

agreement_type

Agreement type (see Agreements):

• privacy_notice_and_policy_agreement — Privacy Notice and Privacy Policy

• microsoft_customer_agreement — Microsoft Customer Agreement

• terms_and_conditions — Terms and Conditions

string

agreement_type = "terms_and_conditions"

days_passed

Number of days since the agreement update was requested

integer

days_passed = 0

Invoice closed

The Invoice was approved

invoice.status

The status of an invoice

string

invoice.status = "open"

invoice.has_attached

Indicates whether a third-party invoice is attached to a payment for an approved postpaid invoice with external management (see

)

boolean

invoice.has_attached = true

account.type.key

The account type key

string

account.type_key = "business"

Manual Operation

operation.id

The manual operation ID (see

)

integer

operation.id = 1

operation.status

The manual operation

string

operation.status = "approval_required"

operation.status = "declined"

operation.type

The manual operation type. For example, when a subscription stops:

• operation.type = "manual_provisioning_plugin_application_stop" — for a subscription based on the Manual Provisioning plugin.

• operation.type = "subscription_stop" — for any other subscriptions.

string

operation.type = "postpay_subscription_verify"

operation.type = "manual_provisioning_plugin_application_install"

operation.type = "subscription_stop"

product.id

The product ID

integer

product.id = 1

product.name

The product name

string

product.name = "ESET"

product_category.id

The product category ID

integer

product_category.id = 1

plan.id

The plan ID

integer

plan.id = 1

plan_category.key

The plan category ID

string

plan_category.key = "default"

subscription.id

The subscription ID

integer

subscription.id = 1

subscription.status.was

The previous status of a subscription

string

subscription.status.was="installing"

subscription.status

The current status of a subscription

string

subscription.status.was="active"

account.type_key

The account type key (see

)

string

account.type_key = "personal"

account.class_key

The account class key (see

)

string

account.class_key = "default"

Payment due date has come

payment.due_date_passed

The number of days after a payment gets the Expired status

integer

payment.due_date_passed = 1

User invitation

-

-

-

-

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

account.type_key

The account type key (see

)

string

account.type_key = "business"

account.class_key

The account class key (see

)

string

account.class_key = "manual"

account.billing_day

The billing day (see Managing service terms).

integer

account.billing_day = 30

account.financial_blocking_threshold

The limit within which the account balance can be negative without moving the account to the Credit hold status during the subzero period

integer

account.financial_blocking_threshold = 100

account.balance

The current value of the account balance (see

)

integer

account.balance = 1000

account.status

The current status of an account

string

account.status = "inactive"

account.country

The account address: the two-letter ISO code

 of the country

string

account.country = "BY"

account.city

The account address: city

string

account.city = "Minsk"

payment.total

The payment amount

integer

payment.total = 100

payment.status

The payment status

string

payment.status = "completed"

Password reset request

Verify email

user.id

The user ID

integer

user.id = 1

Request for quote changed

account.class_id

The account class ID (see

)

integer

account.class_id = 1

account.class_key

The account class key (see

)

string

account.class_key = "manual"

quote.status

The status of a request for a quote (see Quotes):

• pending

• waiting_for_approval

• declined

• approved

• expired

• cancelled

string

quote.status = "pending"

Manager password reset request

manager.id

The manager ID

integer

manager.id = 1

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

account.balance

The current value of the account balance (see

)

number

account.balance = 1000

account.status

The current status of an account

string

account.status = "inactive"

account.type_key

The account type key (see Account types)

string

account.type_key = "business"

account.class_key

The account class key (see

)

string

account.class_key = "manual"

account.financial_blocking_threshold

The limit within which the account balance can be negative without moving the account to the Credit hold status during the subzero period

number

account.financial_blocking_threshold = 100

account.subscription_credit_limit

The value of the subscription credit limit of an account

number

account.subscription_credit_limit = 100

account.country

The account address: the two-letter ISO code

 of the country

string

account.country = "BY"

account.city

The account address: city

string

account.city = "Minsk"

plan.auto_renewal_disabled

Indicates whether the Disable the Auto-renew option option of the linked plan is active

boolean

plan.auto_renewal_disabled = false

plan.id

The plan ID

integer

plan.id = 1

plan.status

The plan status

string

plan.status = "completed"

plan_period.duration_value

The plan period duration

integer

plan_period.duration_value = 30

plan_period.duration_type

The units of the plan period (year, month, day)

string

plan_period.duration_type = "months"

plan_period.trial

Indicated whether the plan period is trial

string ("boolean")

plan_period.trial = "false"

plan_period.setup_fee

The setup fee of the plan period

number

plan_period.setup_fee = 100

plan_period.recurring_fee

The recurring fee of the plan period

number

plan_period.recurring_fee = 100

plan_period.renewal_fee

The renewal fee of the plan period

number

plan_period.renewal_fee = 100

plan_category.key

The plan category key (see Managing plan categories)

string

plan_category.key = "streaming"

plan_category.id

The plan category ID

integer

plan_category.id= 1

subscription.id

The subscription ID

integer

subscription.id = 1

subscription.csp

Indicated whether a subscription belongs to the Microsoft CSP program

boolean

subscription.csp = true

subscription.individual_price

Indicated whether a subscription is ordered at the individual prices (see

)

boolean

subscription.individual_price = true

subscription.status

The current status of a subscription

string

subscription.status = "active"

subscription.status.was

The previous status of a subscription

string

subscription.status.was="installing"

subscription.auto_renewal

Indicated whether the Auto-renew option of a subscription is active

boolean

subscription.auto_renewal = true

subscription.auto_renewal_disabled

Indicated whether the Disable the Auto-renew option option of a subscription is active

boolean

subscription.auto_renewal_disabled = false

subscription.auto_renewal.was

The previous status of the Auto-renew option of a subscription

boolean

subscription.auto_renewal.was = true

subscription.days_left

The number of days before the expiration day of a subscription

integer

subscription.days_left = 7

subscription.days_passed

The number of days after the creation day of a subscription

integer

subscription.days_passed = 15

subscription.plan_class

The name of a service term (see Managing service terms)

string

subscription.plan_class = "default"

subscription.plan_class_key

The key of a service term (see 

)

string

subscription.plan_class_key = "default"

subscription.payment_model

The payment model: prepay or postpay

string

subscription.payment_model = "postpay"

subscription_postpay.current_debt

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

number

subscription_postpay.current_debt = 100

subscription_postpay.credit_limit

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

number

subscription_postpay.credit_limit = 100

product.id

The product ID (see Editing general information about the plan)

integer

product.id = 1

product.name

The product name (see

)

integer

product.name = "Default"

order.type

The order type

string

order.type = "RenewalOrder"

Order changed

Order created

Resend the order

Order completed (immediate)

order.id

The order ID

integer

order.id = 1

order.plans_ids

The IDs of the ordered plans

integer

order.type = "SalesOrder" and (order.plans_ids include? 2000030)

order.status

The current status of an order

string

order.status = "waiting_for_payment"

order.status.was

The previous status of an order

string

order.status.was = "provisioning"

order.total

The total amount of an order

integer

order.total = 100

order.type

The order type

string

order.type = "RenewalOrder"

order.renewal_point

Indicates whether the value in the Auto-renew point (days) field is set on the subscription details page (see Viewing and updating subscription's details)

boolean

order.renewal_point = true

order.renewal_is_positive

Indicates whether Auto-renew point (days) > 0 for a subscription (see Viewing and updating subscription's details)

boolean

order.renewal_is_positive = true

subscription.status

The status of a subscription 

string

subscription.status = "active"

product.id

The product ID included in an order (see

)

integer

product.id = 1

product.name

The product name included in an order (see

)

integer

product.name = "Default"

subscription.payment_model

The payment model: prepay or postpay

string

subscription.payment_model = "postpay"

plan_category.key

The plan category key

string

plan_category.key = "Default"

subscription.plan_class

The name of a service term (see Managing service terms)

string

subscription.plan_class = "default"

subscription.plan_class_key

The key of a service term (see 

)

string

subscription.plan_class_key = "default"

Orders completed (by period)

calendar_period 

The period for which orders are selected and notifications are sent:

• Month — sending every 1^st for orders with a completion date in the previous calendar month.

• Week — sending every Monday for orders with a completion date in the previous week.

• Day — sending daily for orders with a completion date yesterday.

string

calendar_period = "previous_week"

calendar_period = "previous_month"

calendar_period = "previous_day"

order.type

The order type

string

order.type = "RenewalOrder"

plan_category.key

The plan category key

string

plan_category.key = "plan_category_key"

subscription.payment_model

The payment model: prepay or postpay

string

subscription.payment_model = "postpay"

subscription.plan_class

The name of a service term (see

)

string

subscription.plan_class = "default"

subscription.plan_class_key

The key of a service term (see 

)

string

subscription.plan_class_key = "default"

Resend the order

order.days_passed

The number of days passed after creating an order

integer

order.days_passed = 5

Guaranteed payment created

Guaranteed payment changed

Guaranteed payment will expire

account.type_id

The account type ID (see

)

integer

account.type_id = 1

account.type_key

The account type key

string

account.type_key = "business"

account.class_id

The account class ID (see

)

integer

account.class_id = 1

account.class_key

The account class key

string

account.class_key = "manual"

guaranteed_payment.status.was

The previous status of a guaranteed payment (see )

string

guaranteed_payment.status.was = "provided"

guaranteed_payment.status

The current status of a guaranteed payment

string

guaranteed_payment.status = "revoked"

guaranteed_payment.days_left

The number of days before the expiration date of a guaranteed payment

integer

guaranteed_payment.days_left = 1

Billing day is coming

billing_day

The billing day date (see

)

integer

billing_day = 5

billing_day_left

The number of days left to the billing day caused the event to occur (see Creating an event handler)

integer

billing_day_left = 7

billing_day_open_charges_amount

The total amount of charges in the Open status that will be closed or blocked on the billing day caused the event to occur. Only subscriptions with Auto-renew point (days) = 0 are counted. If there are no open charges, preliminary charge generation for the next billing period is used for the calculation

number

billing_day_open_charges_amount = 120.1

plan_ids

A list of the plan IDs with active subscriptions of an account

array(int)

plan_ids include? 200023

product_ids

A list of the product IDs with active subscriptions of an account

array(int)

product_ids include? 100022

product_names

A list of the product names with active subscriptions of an account

array(str)

product_names include? "Default"

monthly_billing

Indicates whether an account has active subscriptions with any monthly billing type (for example, Monthly Prolongation or Monthly Commitment) and the billing day caused the event to occur

boolean

monthly_billing = true

account.type_key

The account type key (see

)

string

account.type_key = "personal"

account.class_key

The account class key (see

)

string

account.class_key = "default"

account.balance

The available account balance

number

account.balance = 58.5

account.financial_blocking_threshold

The limit within which the account balance can be negative without moving an account to the Credit hold status during the subzero period

number

account.financial_blocking_threshold = 10000

subscription.expiration_date

The subscription expiration date

date DD.MM.YYYY

01.01.2019

subscription.payment_model

The payment model: prepay or postpay

string

subscription.payment_model = "postpay"

Payment due date is coming

payment.days_left

The number of days before the latest date for completing a payment (see Due date in

) when a notification is sent

integer

payment.days_left = 5

Billing day for manager's subscriptions has come (former Billing day has come)

billing_day

The date of the billing day when the event occurs

integer

billing_day = 5

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

array

subscriptions_plan_category_keys include? "azure"

subscriptions_statuses

The subscription statuses to check whether a manager has at least one account with a subscription in any specified status

array

subscriptions_statuses include? "active"

Joined payment created

Resend the joined payment

account.class_id

The account class ID (see

)

integer

account.class_id = 1

account.class_key

The account class key (see

)

string

account.class_key = "manual"

payment.days_passed

The number of days passed after creating the joined payment

integer

payment.days_passed = 5

Billing day for account's subscription has come

billing_day_passed

The number of days passed after the billing day to trigger the event for the previous billing period

integer

billing_day_passed = 5

plan_category_key

The key of a plan category of a subscription to trigger the event

string

plan_category_key = "azure"

subscription_status

The status of a subscription to trigger the event

string

subscription_status = "active'

account_class_key

The key of an account class required for an account to trigger the event

string

account_class_key = "default"

total_amount

The total amount of charges in the Closed status for the previous billing period for the subscription

number

total_amount < 0

total_amount >= 0

Correction approved

correction.approved_manager_id

The list of IDs of managers who approved a correction to trigger the event

integer

correction.approved_manager_id = 221

Before account's postpaid subscriptions expiration

before_subscriptions_expirations

A list of days before a subscription expiration date

integer

before_subscriptions_expirations include? 1

subscription.status

The subscription status. The following values are supported:

• active

• graced

• stopped

• waiting_for_manual_approve

string

subscription.status = "active" OR
subscription.status = "graced"

Paid amount has been received from external system

payment_transaction.amount

The paid amount specified in a

 request body 

number

payment_transaction.amount = 15

payment.total

The payment amount in the platform

number

payment.total = 10

payment.status.was

The previous status of the payment

string

payment.status.was = "completed"

payment.status

The current status of the payment

string

payment.status = "completed"

VSP subscription created

VSP resources changed

plan.id

The ID of a plan linked to the subscription

integer

plan.id = 123

product.id

The ID of a product linked to the subscription

integer

product.id = 123

product.name

The name of a product linked to the subscription

string

product.name = "Product Name"

plan_category.id

The ID of a plan category linked to the subscription

integer

plan_category.id = 123

plan_category.key

The key of a plan category linked to the subscription

string

plan_category.key = "plan_category_key"

product_category.id

The ID of a product category linked to the subscription

integer

product_category.id = 123

product_category.key

The key of a product category linked to the subscription

string

product_category.key = "product_category_key"

subscription.payment_model

The payment model: prepay or postpay

string

subscription.payment_model = "postpay"

The report with daily consumptions of pay-as-you-go subscriptions is ready

consumption_report.status

The report status:

• failed — report generation error.

• completed — the report is ready.

string

consumption_report.status = "completed"

consumption_report.scheduled

Indicates whether it is a scheduled monthly report

boolean

consumption_report.scheduled = true

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.

string

pec_status = "yes"

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

.

number

pec_coverage = 100