Merge Tags

All emails sent from ChargeOver are customizable, and can contain "merge tags" which are replaced by values from data with ChargeOver before the email is sent.

Tags can also be used to build basic IF/THEN statements and loops into your ChargeOver emails.

Tags

ChargeOver merge tags are documented below.

Admin Users

Customers

Contacts

Invoices

Invoice Line Items

Note that for merge tags for line items, the number in brackets in the merge tag corresponds to which line the item is on the invoice, quote, or subscription.

For example, if you want to see the name of the first line item on an invoice, you would use {{invoice.line_items[0].item_name}}.

If you wanted to see the name of the second line item, you would use the merge tag {{invoice.line_items[1].item_name}}.

Quotes

Quote Line Items

Note that for merge tags for line items, the number in brackets in the merge tag corresponds to which line the item is on the invoice, quote, or subscription.

For example, if you want to see the name of the first line item on a quote, you would use {{quote.line_items[0].item_name}}.

If you wanted to see the name of the second line item, you would use the merge tag {{quote.line_items[1].item_name}}

Subscriptions (Packages)

Subscription Line Items

Note that for merge tags for line items, the number in brackets in the merge tag corresponds to which line it is on the invoice, quote, or subscription.

For example, if you want to see the name of the first line item on a subscription, you would use {{package.line_items[0].item_name}}.

If you wanted to see the name of the second line item, you would use the merge tag {{package.line_items[1].item_name}}

Transactions

Credit Cards

ACH/eCheck Accounts

Tokenized Pay Methods

Brand

Parent Customers

Formatting

There are many formatting options available to you to format data.

abs

The abs filter returns the absolute value.

{# number = -5 #}
{{ number|abs }}

{# outputs 5 #}

date

The date filter formats a date.

{# the_date = "2016-11-28" #}
{{ the_date|date("m/d/Y") }}

{# outputs 11/28/2018 #}

You can use any of the following formatters:

• d – Day of the month, 2 digits with leading zeros, 01 to 31
• D – A textual representation of a day, three letters, Mon through Sun
• j – Day of the month without leading, zeros 1 to 31
• l – (lowercase ‘L’) A full textual representation of the day of the week, Sunday through Saturday
• S – English ordinal suffix for the day of the month, 2 characters st, nd, rd or th. Works well with j.
• F – A full textual representation of a month, such as January or March, January through December
• m – Numeric representation of a month, with leading zeros, 01 through 12
• M – A short textual representation of a month, three letters, Jan through Dec
• n – Numeric representation of a month, without leading zeros, 1 through 12
• t – Number of days in the given month, 28 through 31
• Y – A full numeric representation of a year, 4 digits. Examples: 1999 or 2003
• y – A two digit representation of a year. Examples: 99 or 03
• a – Lowercase Ante meridiem and Post meridiem, am or pm
• A – Uppercase Ante meridiem and Post meridiem, AM or PM
• g – 12-hour format of an hour without leading zeros, 1 through 12
• G – 24-hour format of an hour without leading zeros, 0 through 23
• h – 12-hour format of an hour with leading zeros, 01 through 12
• H – 24-hour format of an hour with leading zeros, 00 through 23
• O – Difference to Greenwich time (GMT) in hours. Example: +0200
• P – Difference to Greenwich time (GMT) with colon between hours and minutes. Example: +02:00
• T – Timezone abbreviation. Examples: EST, MDT ...
• c – ISO 8601 date. Example: 2004-02-12T15:19:21+00:00
• r – RFC 2822 formatted date. Example: Thu, 21 Dec 2000 16:01:07 +0200

date_modify

The date_modify filter allows you to modify a date by adding or subtracting days, months etc.

For example, if you wanted to generate an invoice ahead of time for a customer in May 2017, but the period of service it covers is June, you could put in the item description:

Service for {{invoice.date|date_modify("+1 month")|date("F Y") }}

This will print "Service for June 2017"

default

The default filter will set a default value for a value that is undefined or empty.

{{ var|default('var is not defined') }}

{{ var.foo|default('foo item on var is not defined') }}

{{var['foo']|default('foo item on var is not defined') }}

{{ ''|default('passed var is empty') }}

lower

The lower filter converts a value to lowercase.

{{ 'CHARGEOVER'|lower }}

Will print "chargeover"

number_format

The number_format filter formats numbers.

You can control the number of decimal places, decimal point, and thousands separator using the additional arguments.

If no formatting options are provided then the default formatting options are:

• 0 decimal places.
• . as the decimal point.
• , as the thousands separator.

{{ 2345.353|number_format }}
// Will print 2,345

{{ 2345.353|number_format(2) }}
// Will print 2,345.35

replace

The replace filter will format a given string by replacing placeholders.

For example, if you had a string like the one below, and the customer.company name you were referencing was 'John Doe':

{{"I like %this%."|replace({'%this%': customer.company})}}

will print "I like John Doe."

A common use example of the replace filter is:

|replace("American Express", "AMEX")

will print "AMEX" in place of American Express.

round

The round filter rounds a number to a specified precision.

{{ 10.5678|round }}
 will print 11

{{ 10.5678|round(1) }}
 will print 10.6 

{{ 10.5678|round(2) }}
 will print 10.57

{{ 10.5678|round(3) }}
 will print 10.568

1. common rounds either up or down (rounds the value up when it is halfway or more to the next whole number, rounds the value down when it is less than half way)

2. ceil always rounds up

3. floor always rounds down

1. {{ 10.56|round }}
    will print 11

  {{ 10.44|round }}
   will print 10

2.{{ 10.44|round(1,'ceil') }}
   will print 10.5

3.{{ 10.789|round(1,'floor') }}
   will print 10.7

upper

The upper filter converts a value to uppercase.

{{ 'chargeover'|upper }}

Will print "CHARGEOVER"

Template Logic

ChargeOver supports a simple template syntax to allow you to build IF/ELSE statements (and more) into your emails.

Feel free to reach out to our support team for more assistance with templating.

IF/ELSE blocks

You can use IF/ELSE statements to implement logic within your templates.

A common example is customizing language depending on how overdue an invoice is.

{% if invoice.days_overdue > 90 %}
  Your invoice is really, REALLY overdue!
{% else %}
  Your invoice is overdue.
{% endif %}

FOR loops

You can use loops to iterate through collections of objects.

A common example is looping through the list of line items on an invoice.

{% for line in invoice.line_items %}
	Product: {{ line.item_name }}
	Rate: {{invoice.currency_symbol}}{{ line.line_rate }}
	Quantity: {{ line.line_quantity }}
{% endfor %}

Logic / Math

Expressions can be used to do math and logic directly within templates.

Math

+ Adds two objects together (the operands are casted to numbers). {{ 1 + 1 }} is 2
- Subtracts the second number from the first one. {{ 3 - 2 }} is 1
/ Divides two numbers. The returned value will be a floating point number. {{ 1 / 2 }} is 0.5
* Multiplies the left operand with the right one. {{ 2 * 2 }} would return 4

Logic

and Returns true if the left and the right operands are both true.
or Returns true if the left or the right operand is true.
not Negates a statement.
(expr) Groups an expression.