Skip to main content

Email Template Data Source Merge Fields

Zuora

Email Template Data Source Merge Fields

Most events that email templates relate to are mapped to a data source. You can use fields from the data source as merge fields in email templates to customize your notification emails.

For more information about using merge fields in email templates, see Merge field syntax for email templates.

Merge Field Data Sources

The following list shows the data source related to each event category.

Event Category Data Source
Account Account
Amendment

Subscription

Note: For notifications triggered by custom events, merge fields are rendered for only amendment completed events where Amendment.Status == 'Completed'.

AmendmentProcessed Subscription
Aqua Legacy merge fields are used for this event category.
Bill Run Bill Run
Bill Run Completion Bill Run
Credit Balance Refund Processed Refund
Datasource Legacy merge fields are used for this event category.
Gateway Reconciliation Job Completion Legacy merge fields are used for this event category.
Import Import
ImportProcessed Import
Invoice Invoice
Invoice Due Invoice
Invoice Posted Invoice
Invoices Past Due, Account Summary Account
Journal Run Completion Journal Run
Key Date(s) Subscription
Manual Email For Invoice Invoice
Manual Email for Payment Payment
New Subscription Created Subscription
Payment Legacy merge fields are used for this event category.
Payment Declined Payment
Payment Method Legacy merge fields are used for this event category.
Payment Method Closed PaymentMethod
Payment Method Expiration Legacy merge fields are used for this event category.
Payment Method Updated PaymentMethod
Payment Method Updater Legacy merge fields are used for this event category.
Payment Method Updater Completed Legacy merge fields are used for this event category.
Payment Method Updater Started Legacy merge fields are used for this event category.
Payment Processed Payment
Payment Refund Processed Refund
Payment Run Completion Legacy merge fields are used for this event category.
Refund Refund
Subscription Legacy merge fields are used for this event category.
Trial Balance Completion Accounting Period
Upcoming Renewal Legacy merge fields are used for this event category.

Credit memo and debit memo event categories

This feature is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memos, and Invoice Item Settlement. If you want to have access to the feature, see Invoice Settlement Enablement and Checklist Guide for more information.

Credit Memo Created Credit Memo
Credit Memo Posted Credit Memo
Debit Memo Created Debit Memo
Debit Memo Posted Debit Memo
Email Credit Memo Credit Memo
Email Debit Memo Debit Memo

To find out the available fields of each data source, see Data source reference.