How to create the Merge(variable) fields in Chargebee?

Scope

How to create a custom payment update URL in Chargebee?

Can I use the mail merge fields with the API?

How to define conditions using Mail merge fields?

Summary

Chargebee allows you to personalize the content that is customer-facing like Email Notifications, Checkout and Portal, Invoices, and Credit Notes using the Mail Merge Fields.

Solution

Displayed below are the images that guide you on where you can configure the Merge Fields in the UI,

1. **Email Notifications:**To use Merge Fields for your Email Notifications, Go to Configure Chargebee > Email Notifications > Select the template > Click on View all Merge Fields and select one notification to obtain the merge field.

2. Checkout & Portal: To display the Return Variables after Checkout you can use the Show/Hide Mergevars option from the Hosted page Redirect URLs when you create a plan or use the Edit Plan option to make changes to an existing plan.

3. Customize Invoices, Credit Notes, and Quotes:

To customize payment instructions for Quotes, Invoices, and Credit Notes Go to Configure Chargebee > Settings > Customize Invoices, Credit Notes, and Quotes and add the payment details for the mode of payment

Mail Merge Usage Conditions

Display Content when Field has a Value

If the field contains a value, then the content inside the block will be displayed. '#' indicates that the condition to be checked has to be true. '/' indicates the end of the field block.

Dear Customer, `#plan.setup_cost` Your setup cost is `plan.setup_cost`. `/plan.setup_cost` Thank you for your purchase.

If the mail merge field does NOT contain a value, the content will be ignored. For instance, on the above example if the plan.setup_cost does not contain a value, then "Your setup cost is $12.50." will be completely ignored.

Display Content when the Field Has a Specific Value

If the field contains a value, then the content entered within the block is displayed, like plan name, addon name, etc. Else it will be ignored.

{{#plan.id = PREMIUM-USD-Monthly}} Since you are in basic plan you have only email support. {{/plan.id = PREMIUM-USD-Monthly}}

Display Content when the Field Does not Have a Specific Value

If the field is empty or does not have a specific value, the content entered within the block is displayed. " ^ " indicates that the condition specified has to be false.

To display content when a field does not have the specified value:

`^plan.name = enterprise` Upgrade to the enterprise plan and enjoy 24/7 phone support. `/plan.name = enterprise`

Enumerated String

Enumerated string refers to values, like subscription statuses (active, canceled, trial...), invoice statuses (paid, not paid...), etc.

SAMPLE #1

`#card.status = expiring` Your card is about to expire. `/card.status = expiring`

List Values

Used to display a list of items (objects that may have multiple entries in the subscription) such as addons, coupons, etc.

`#addons` Addon Name : `addon.name` Addon Price : `addon.price` `/addons`

Reformat Date and Time Values

You can use 'format' and 'timezone' attributes along with the timestamp fields, such as subscription.trial_end to change the default format of the date and time or convert it to a specific timezone. Click here for more details.

You signed up for your subscription on `subscription.created_at | format : dd-MMM-yyyy hh:mm:ss z`

To access all lists of Mergevar fields use this sample format link: https://yoursite/notifications/mergevars. The yoursite is your Chargebee site name, for example, https://flipbook-test/notifications/mergevars. Note that, you will be able to access this link only if you have logged in to your site.