Email Template Merge Fields
You can add email template merge fields to your email templates to customize your notification emails.
When creating or editing an email template, you must select a related event to select merge fields for use in your templates. Related events are mapped to a data source and the fields in the data source are available for use as merge fields.
Some related events continue to include legacy merge fields. The related events that exclusively use legacy merge fields are called out in the table below. For a listing of all legacy merge fields, see Email Template Legacy Merge Fields.
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 |
| 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 |
System Merge Fields
The following merge fields are available to all event categories.
| Field | Tag | Description |
|---|---|---|
| EventCategory | <Event.Category> | The Event Category. For example, Invoice Posted, New Subscription Created, or Upcoming Renewal. |
| EventDate | <Event.Date> | Date, in tenant's time zone, on which the event occurred. |
| EventTimestamp | <Event.Timestamp> | Time and date when the event occurred, using the time zone set for your tenant. |
| TenantID | <Tenant.ID> | Id of the Zuora tenant. |
| TenantName | <Tenant.Name> | Name of the Zuora tenant. |
| EntityID | <Entity.ID> |
Id of the entity. This merge field is only available when the Multi-Entity tenant setting is turned on. |
| EntityName | <Entity.Name> |
Name of the entity. This merge field is only available when the Multi-Entity tenant setting is turned on. |
| FunctionsToday | <Functions.Today> |
Date, in tenant's time zone, on which the notification email sending out. |