Placeholders for UI templates

You can use the Liquid code in UI templates. See more at https://shopify.github.io/liquid/basics/introduction/.

In this article:

General placeholders for UI templates

Placeholder

Description

reseller.logo

The links to the reseller's logos (see Uploading reseller's logos):

  • reseller.logo — the main logo,

  • reseller.inverted_logo — the inverted logo,

  • reseller.short_logo — the short logo,

  • reseller.favicon — the favicon.

For example, reseller.logo returns /images/system_setting/logo/1/logo.png

reseller.inverted_logo

reseller.short_logo

reseller.favicon

Placeholders for Invoice/Prepay and Invoice/Postpay UI templates

Placeholder

Description

invoice.charges

List of charges

invoice.charges[].has_taxes

Bool; indicates whether an invoice item has taxes

invoice.charges[].taxes_amount

The sum of all taxes in an invoice

invoice.charges[].taxes[]

The array of taxes included in an invoice

invoice.charges[].tax[].id

The ID of a tax

invoice.charges[].tax[].name

The name of a tax

invoice.charges[].tax[].code

The code of a tax

invoice.charges[].tax[].amount

The amount of a tax

invoice.order_charges

List of grouped order charges

invoice.corrections

List of approved corrections

invoice.id

Invoice ID

invoice.document_number

Document number

invoice.created_at

Invoice creation date (MM.DD.YYYY)

invoice.from_date

Invoice start date

invoice.to_date

Invoice end date

invoice.total_in_words

Invoice total amount in words

invoice.total

Invoice total amount

invoice.status

Invoice status

invoice.from_date_human

Localized start date

invoice.to_date_human

Localized end date (one day before to_date)

invoice.date_today

Localized current date

invoice.account_address

Formatted account address

invoice.account_building

Account's building

invoice.account_street

Account's street

invoice.account_zip

Account's ZIP code

invoice.account_city

Account's city

invoice.account_region

Account's region

invoice.account_country_name

Account's country (full name)

invoice.account_country

Account's country code

invoice.account_phone

Account's phone number

invoice.account_email

Account's email

invoice.account_name

Account's name

invoice.account_id

Account's ID

invoice.account_type_key

Account's type key

invoice.subscriptions

List of subscriptions. For Invoice/Postpay only

invoice.payments

List of payments. For Invoice/Postpay only

invoice.charges_total_amount

Sum of charge amounts. For Invoice/Postpay only

Placeholders for Certificate/Completed Order UI templates

General placeholders

Placeholder

Description

account.name

Account name

account.street

Account address: street

account.building

Account address: building number

account.office

Account address: office number

account.city

Account address: city

account.zip

Account address: postal code

account.country

Account address: country code

account.country_name

Account address: country name

account.phone

Account contact: phone number

account.custom_attributes

Account custom attributes

account.contract_person_first_name

First name of the person authorized to sign the contract

account.contract_person_middle_name

Middle name of the person authorized to sign the contract

account.contract_person_last_name

Last name of the person authorized to sign the contract

account.contract_person_email

Email of the person authorized to sign the contract

owner.email

Account owner email

owner.first_name

Account owner first name

owner.last_name

Account owner last name

reseller.name

Reseller name

reseller.custom_attributes

Reseller custom attributes

reseller.stamp

Reseller stamp image URL

order.number

Linked order number

order.charges

List of charges related to the order, for use with iterator {% for charge in order.charges %} ... {% endfor %}. If there are no charges, this section will be empty

charge.description

Description of the related charge

charge.quantity

Quantity of the resource or service in the charge

charge.unit_price

Unit price of the resource or service in the charge

charge.period

Period covered by charge

charge.amount

Charge amount

charge.name

Resource name, subscription name, and paid period in the format from {DD.MM.YYYY} to {DD.MM.YYYY}

Placeholders for Order completed (immediate) event

Placeholder

Description

subscription.resources

List of resources in the subscription for use with the iterator

HTML
{% for resource in subscription.resources %}
  <tr>
    <td>{{ subscription.plan.vendor_name }}</td>
    <td>{{ plan.sku }}</td>
    <td>{{ subscription.id }}</td>
    <td>{{ resource.additional }}</td>
    <td>{{ subscription.notification_settings['microsoft_csp_products']['external_id'] }}</td>
     <td>{{ subscription.period }}</td>
  </tr>
{% endfor %}

subscription.plan.vendor_name

Vendor name. Can be used as a condition for displaying static information

plan.sku

Plan SKU

plan.name

Plan name

resource.additional

Additional quantity of the resource ordered in the subscription

subscription.id

Subscription ID

subscription.notification_settings['microsoft_csp_products']['external_id']

Microsoft external subscription ID

subscription.name

Subscription name

subscription.start_date

Subscription start date

subscription.expiration_date

Subscription expiration date

subscription.period

Subscription period

Placeholders for Order completed (by period) event

Placeholder

Description

order.subscription_name

Information about subscriptions related to orders: subscription name

HTML
{% for order in orders %}
order.subscription_name
order.subscription_start_date
order.subscription_expiration_date
{% endfor %}

order.subscription_start_date

Information about subscriptions related to orders: subscription start date

order.subscription_expiration_date

Information about subscriptions related to orders: subscription expiration date

order.subscription.plan.vendor_name

Information about subscriptions related to orders: vendor name. Can be used as a condition for displaying static information

order.subscription.plan.sku

Information about subscriptions related to orders: plan SKU

order.subscription.id

Information about subscriptions related to orders: subscription ID

order.subscription.notification_settings['microsoft_csp_products']['external_id']

Information about subscriptions related to orders: Microsoft external subscription ID

order.subscription.resources

Information about subscriptions related to orders: additional quantity of the resource ordered in the subscription

HTML
{% for resource in order.subscription.resources %}
{{ resource.additional }}
{% endfor %}

order.subscription.period

Information about subscriptions related to orders: subscription period

order.provisioning_items

Information about subscriptions related to orders: quantity and amount of order items.

Used for subscriptions without charges

HTML
{% for item in order.provisioning_items %}
{ % if item.resource? %}
{{ item.quantity }}
{{ item.amount }}
{% endif %}
{% endfor %}