Merge Tags

Merge tags are the substitutions available to you when designing an email template. Depending on the entity model being given to an email template, you might see different fields available. Here's all the merge tags you have available to you.

Location Fields

Name	Entity Type Supported	Example
location_name	Booking, Invoice, Payment	Acme Inc - Exampletown
location_email	Booking, Invoice	[e-mail]
location_phone	Booking, Invoice	0123456789
location_website	Booking, Invoice	www.example.com
location_full_address	Booking, Invoice	1 Test St, Apt #13, Exampletown, CA, 90022, United States
location_address_line_1	Booking, Invoice	1 Test St
location_address_line_2	Booking, Invoice	Apt #13
location_city	Booking, Invoice	Exampletown
location_state	Booking, Invoice	CA
location_postcode	Booking, Invoice	90022
location_country	Booking, Invoice	United States
pickup_location_name	Booking	Acme Inc - Exampletown
pickup_location_email	Booking	[e-mail]
pickup_location_phone	Booking	0123456789
pickup_location_website	Booking	www.example.com
pickup_location_full_address	Booking	1 Test St, Apt #13, Exampletown, CA, 90022, United States
pickup_location_address_line_1	Booking	1 Test St
pickup_location_address_line_2	Booking	Apt #13
pickup_location_city	Booking	Exampletown
pickup_location_state	Booking	CA
pickup_location_postcode	Booking	90022
pickup_location_country	Booking	United States
dropoff_location_name	Booking	Acme Inc - Exampletown
dropoff_location_email	Booking	[e-mail]
dropoff_location_phone	Booking	0123456789
dropoff_location_website	Booking	www.example.com
dropoff_location_full_address	Booking	1 Test St, Apt #13, Exampletown, CA, 90022, United States
dropoff_location_address_line_1	Booking	1 Test St
dropoff_location_address_line_2	Booking	Apt #13
dropoff_location_city	Booking	Exampletown
dropoff_location_state	Booking	CA
dropoff_location_postcode	Booking	90022
dropoff_location_country	Booking	United States

Invoice Fields

Name	Entity Type Supported	Example
invoice_number	Invoice, Payment	INV123456
invoice_due_date	Invoice, Payment	21st Sept, 2025
invoice_outstanding_balance	Invoice	$123.45
invoice_service_period_start_date	Invoice	21st Sept, 2025
invoice_service_period_end_date	Invoice	22nd Sept, 2025
payment_charge_at	Payment	Wed, 18 Dec 02:36 pm AEDT/ No further attempt scheduled
payment_attempts	Invoice	Number of automated attempts made for payment.

Person/Company Fields

For people and companies, we still use the same field names, however, the values change. This is to make it easy to write one email template for both types.

Name	Entity Type Supported	Person Example	Company Example
payer_first_name	Booking, Invoice, Refund, CreditNote	John	Acme Inc
payer_middle_name	Booking, Invoice, Refund, CreditNote	Lewis	<blank>
payer_last_name	Booking, Invoice, Refund, CreditNote	Smith	<blank>
payer_full_name	Booking, Invoice, Refund, CreditNote	John Lewis Smith	Acme Inc
payer_email	Booking	[e-mail]	[e-mail]
owner_first_name	Booking, Payment, Document	John	Acme Inc
owner_middle_name	Booking, Payment, Document	Lewis	<blank>
owner_last_name	Booking, Payment, Document	Smith	<blank>
owner_full_name	Booking, Payment, Document	John Lewis Smith	Acme Inc
owner_email	Booking	[e-mail]	[e-mail]
owner_phone	Booking	012345678	012345678
primary_driver_first_name	Booking	John	<N/A>
primary_driver_middle_name	Booking	Lewis	<N/A>
primary_driver_last_name	Booking	Smith	<N/A>
primary_driver_full_name	Booking	John Lewis Smith	<N/A>

Asset Fields

Name	Entity Type Supported	Example
asset_name	Asset, Booking	Ford F-150 Lariat
asset_year	Asset, Booking	2023
asset_make	Asset, Booking	Ford
asset_model	Asset, Booking	F-150
asset_trim	Asset, Booking	Lariat
asset_licence_plate	Asset, Booking	ABC123
asset_category_name	Asset, Booking	Sedan

Package Fields

Name	Entity Type Supported	Example
package_name	Booking	Rental

Booking Fields

Name	Entity Type Supported	Example
booking_number	Booking	B000022
platform_link	Booking	Link to booking in platform
billing_frequency	Booking	Weekly
start_date	Booking	21st Sept, 2025
start_time	Booking	9:50 AM
end_date	Booking	28th Sept, 2025
end_time	Booking	9:50 AM
program_type_name	Booking	Rental/Subscription
next_invoice_date	Booking	21st Sept, 2025
payment_method_last_4_digits	Booking	1234
payment_method_type	Booking	Card, BECS Direct Debit, etc
payment_method_brand	Booking	Visa, Mastercard

Refund Fields

Name	Entity Type Supported	Example
refund_amount	Refund	$100.00
transaction_id	Refund	EX1234567890

CreditNote Fields

Name	Entity Type Supported	Example
credit_note_number	CreditNote	CN123456
credit_note_type	CreditNote	Adjustment/Refundable
credit_note_amount	CreditNote	$100.00

Contract Fields

Name	Entity Type Supported	Example
program_type_name	Contract	Rental/Subscription
view_sign_agreement_url	Contract	https://example.com/signature/agreement/123

PaymentMethod Fields

Name	Entity Type Supported	Example
card_brand	Payment	Visa/Master
card_last_4_digits	Payment	xxxx-xxxx-xxxx-1234

Document Fields

Name	Entity Type Supported	Example
document_type	Document	License/Passport/Insurance
document_number	Document	12345678
days_remaining_text	Document	expiring in 30 days, expring in 14 days, expring in 7 days, expired today
workspace_name	Document	xyz