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

PlaceholderDescription
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

PlaceholderDescription
invoice.chargesList of charges
invoice.charges[].has_taxesBool; indicates whether an invoice item has taxes
invoice.charges[].taxes_amountThe sum of all taxes in an invoice
invoice.charges[].taxes[]The array of taxes included in an invoice
invoice.charges[].tax[].idThe ID of a tax
invoice.charges[].tax[].nameThe name of a tax
invoice.charges[].tax[].codeThe code of a tax
invoice.charges[].tax[].amountThe amount of a tax
invoice.order_chargesList of grouped order charges
invoice.correctionsList of approved corrections
invoice.idInvoice ID
invoice.document_numberDocument number
invoice.created_atInvoice creation date (MM.DD.YYYY)
invoice.from_dateInvoice start date
invoice.to_dateInvoice end date
invoice.total_in_wordsInvoice total amount in words
invoice.totalInvoice total amount
invoice.statusInvoice status
invoice.from_date_humanLocalized start date
invoice.to_date_humanLocalized end date (one day before to_date)
invoice.date_todayLocalized current date
invoice.account_addressFormatted account address
invoice.account_buildingAccount's building
invoice.account_streetAccount's street
invoice.account_zipAccount's ZIP code
invoice.account_cityAccount's city
invoice.account_regionAccount's region
invoice.account_country_nameAccount's country (full name)
invoice.account_countryAccount's country code
invoice.account_phoneAccount's phone number
invoice.account_emailAccount's email
invoice.account_nameAccount's name
invoice.account_idAccount's ID
invoice.account_type_keyAccount's type key
invoice.subscriptionsList of subscriptions. For Invoice/Postpay only
invoice.paymentsList of payments. For Invoice/Postpay only
invoice.charges_total_amountSum of charge amounts. For Invoice/Postpay only

Placeholders for Certificate/Completed Order UI templates

General placeholders

PlaceholderDescription
account.nameAccount name
account.street
Account address: street
account.buildingAccount address: building number
account.officeAccount address: office number
account.cityAccount address: city
account.zipAccount address: postal code
account.countryAccount address: country code
account.country_nameAccount address: country name
account.phoneAccount contact: phone number
account.custom_attributesAccount custom attributes
account.contract_person_first_name
First name of the person authorized to sign the contract
account.contract_person_middle_nameMiddle name of the person authorized to sign the contract
account.contract_person_last_nameLast name of the person authorized to sign the contract
account.contract_person_emailEmail of the person authorized to sign the contract
owner.emailAccount owner email
owner.first_nameAccount owner first name
owner.last_nameAccount owner last name
reseller.nameReseller name
reseller.custom_attributesReseller custom attributes
reseller.stampReseller stamp image URL
order.numberLinked 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.descriptionDescription of the related charge
charge.quantityQuantity of the resource or service in the charge
charge.unit_priceUnit price of the resource or service in the charge
charge.periodPeriod covered by charge
charge.amountCharge amount
charge.nameResource name, subscription name, and paid period in the format from {DD.MM.YYYY} to {DD.MM.YYYY}

Placeholders for Order completed (immediate) event

PlaceholderDescription
subscription.resources

List of resources in the subscription for use with the iterator

{% 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_nameVendor name. Can be used as a condition for displaying static information
plan.skuPlan SKU
plan.namePlan name
resource.additionalAdditional quantity of the resource ordered in the subscription
subscription.idSubscription ID
subscription.notification_settings['microsoft_csp_products']['external_id']Microsoft external subscription ID
subscription.nameSubscription name
subscription.start_dateSubscription start date
subscription.expiration_dateSubscription expiration date
subscription.periodSubscription period

Placeholders for Order completed (by period) event

PlaceholderDescription
order.subscription_name

Information about subscriptions related to orders: subscription name

{% for order in orders %}
order.subscription_name
order.subscription_start_date
order.subscription_expiration_date
{% endfor %}
order.subscription_start_dateInformation about subscriptions related to orders: subscription start date
order.subscription_expiration_dateInformation about subscriptions related to orders: subscription expiration date
order.subscription.plan.vendor_nameInformation about subscriptions related to orders: vendor name. Can be used as a condition for displaying static information
order.subscription.plan.skuInformation about subscriptions related to orders: plan SKU
order.subscription.idInformation 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

{% for resource in order.subscription.resources %}
{{ resource.additional }}
{% endfor %}
order.subscription.periodInformation 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

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