Breadcrumbs

Placeholders for the Product entity

The following placeholders are used for the Product entity.

Placeholder

Description

product.id

The product ID (available for the following events: Before subscription expiration, After subscription expiration, After subscription switched from trial to non-trial, Subscription changed, Order changed, Order created, see

Creating an event handler

)

product.name

The product name (available for the following events: Before subscription expiration, After subscription expiration, After subscription switched from trial to non-trial, Subscription changed, Order changed, Order created, see

Creating an event handler

)

product_ids

An array of the product IDs of the plans with active subscriptions (available only for the following event: Billing day is coming, see

Creating an event handler

)

product_names

An array of the product names of the plans with active subscriptions (available only for the following event: Billing day is coming, see

Creating an event handler

)

product.featured_products[]

For a Subscription changed event — an array of featured products from the recommendation service for a subscription's product (see Product recommendations), except for the following:

  • Unpublished featured products.

  • Featured products where the account has a subscription in any of these statuses:Active.Delivered.Graced.Installing.Activating.Renewing.Updating.Stopping.Switching.Waiting for manual approve.

XML
{% for featured_product in product.featured_products %}
<br>Featured product ID: {{featured_product.id}}.
<br>
<br>Featured product logo:
<br><img src="{{featured_product.logo}}" width="250" height="52" align="center" border="0" alt="" style="margin:0">
<br>
<br>Featured product name: {{featured_product.name}}.
<br>
<br>Brief description of a featured product: {{featured_product.brief_description}}.
<br>
<br>Full description of a featured product: {{featured_product.description}}.
<br>
<br>Name of the vendor who owns a featured product: {{featured_product.vendor_name}}.
<br>
<br>Featured product priority: {{featured_product.priority}}.
{% endfor %}

subscription.upgrade_to_products[]

For Before account's postpaid subscriptions expiration and Before subscription expiration events — an array of upgrade-to products (see Product recommendations) generated as follows:

  1. For a subscription's plan, all active public switchable plans with the Immediate attribute are found (see Managing switchable plans).

  2. All unique public products associated with the found switchable plans are selected.

  3. The subscription's product is excluded from the list.

  4. The products are sorted by descending priority in the recommendation service, if no priority — by descending ID.

XML
{% for subscription in subscriptions %}
{% for upgrade_to_product in subscription.upgrade_to_products %}
<br>Upgrade-to product ID: {{uprgade_to_product.id}}.
<br>
<br>Upgrade-to product logo:
<br><img src="{{uprgade_to_product.logo}}" width="250" height="52" align="center" border="0" alt="" style="margin:0">
<br>
<br>Upgrade-to product name: {{uprgade_to_product.name}}.
<br>
<br>Brief description of an upgrade-to product: {{uprgade_to_product.brief_description}}.
<br>
<br>Full description of an upgrade-to product: {{uprgade_to_product.description}}.
<br>
<br>Name of the vendor who owns an upgrade-to product: {{uprgade_to_product.vendor_name}}.
<br>
<br>Upgrade-to product priority: {{uprgade_to_product.priority}}.
{% endfor %}
{% endfor %}
XML
{% for upgrade_to_product in subscription.upgrade_to_products %}
<br>Upgrade-to product ID: {{uprgade_to_product.id}}.
<br>
<br>Upgrade-to product logo:
<br><img src="{{uprgade_to_product.logo}}" width="250" height="52" align="center" border="0" alt="" style="margin:0">
<br>
<br>Upgrade-to product name: {{uprgade_to_product.name}}.
<br>
<br>Brief description of an upgrade-to product: {{uprgade_to_product.brief_description}}.
<br>
<br>Full description of an upgrade-to product: {{uprgade_to_product.description}}.
<br>
<br>Name of the vendor who owns an upgrade-to product: {{uprgade_to_product.vendor_name}}.
<br>
<br>Upgrade-to product priority: {{uprgade_to_product.priority}}.
{% endfor %}