Skip to main content

Billing Merge Fields

Josh
  • Updated

Overview

Merge fields, also known as tokens, can be used to pull dynamic information from contacts in Finalsite Enrollment into various parts of the system. To learn more about the various uses for merge fields, click here.

The merge fields described in this article are specifically for clients using the Finalsite Enrollment Billing module. For information about Contract Merge Fields that can be used with the Enrollment module, click here.

Merge fields can be added to a template through the Merge Field Picker or by typing/copying them directly into the body of the template. Learn more in our 'How to Pull in Dynamic Information' section here. Below are some of the key billing-related merge fields available to you.

Please Note

Some of these merge fields use the Contact category, while others use the Recipient category. Merge tokens that begin with Statement will only work within the billing email templates, i.e. they will not work in custom email templates.

Autopay Merge Tokens

{{recipient.billing_autopay_enabled}}

Displays a value of true (yes) or false (no) depending on whether autopay is enabled for the parent/guardian's billing account. You will need to use the Recipient category for this merge token since Autopay is set per billing account, not per student.

{{statement.autopay_dates}}, {{recipient.autopay_billing_days}}, and {{contact.autopay_billing_days}}

These all display the payer's Autopay dates.

{statement.formatted_next_autopay_amount}}

Displays the payer's next Autopay amount due.

{{statement.next_autopay_date}}

Displays the payer's next Autopay date.

{{ statement.autopay_convenience_fee_disclaimer }}

Displays a message that informs the recipient of the convenience fee associated with their charge:

Note: There is an additional convenience fee associated with your enrolled autopay payment method of $X.XX. This amount will be added to the amount processed.

Within the above statement, certain words are pulled from what you have set up on your Payment Setup page.  

  • The words "convenience fee" are based on what you have recorded as the Fee Description within the Payment Setup page.

  • The amount that will be displayed within the message is based on the fees established on the Payment Setup page. 

The merge token automatically adjusts based on the recipient. For example, if they have a Credit Card set to autopay and receive an email with the merge token, they'll see the Fee description you have set for credit cards and the fee amount (either percentage, flat rate, or both) you have set up for credit cards. 

Additional notes:

  • If the associated payment doesn't incur any convenience fee, that merge token will not display anything within the recipient's email.

  • Because this token begins with "statement", it will only work within Billing email templates and it's only intended for use in emails that go out before a payment is made (like Upcoming Payment) and will not work the same in emails that occur after payment (like the Payment Received email.)

  • We recommend including the token in the following Billing emails:
    • Auto Payment Failure
    • Retry Upcoming Auto Payment
    • Upcoming Statement
    • Upcoming Payment
    • Upcoming Auto Payment

{{ statement.formatted_autopay_convenience_fee_amount }}

Displays the amount of the convenience fee associated with the recipient's charge. This displays only the amount of the convenience fee (no other text.) 

Example: If the charge is $275 and the Credit Card convenience fee is 3.05%, $8.38 would display.

Important notes:

  • If no convenience fee is applicable, $0.0 will be displayed.

  • Because this token begins with "statement", it will only work within Billing email templates and it's only intended for use in emails that go out before a payment is made (like Upcoming Payment) and will not work the same in emails that occur after payment (like the Payment Received email.)

Student Overdue

Displays a value of true (yes) or false (no) depending on if the student (contact) is currently overdue.

  • Merge Field: {{contact.billing_contact_overdue}}

  • Example: true

Account Overdue

Displays a value of true (yes) or false (no) depending on whether the billing account is currently overdue.

  • Merge Field: {{recipient.billing_overdue}}

  • Example: true

Account Overdue Date

Displays the date on which the billing account is overdue. Formatted as MM/DD/YYYY or DD/MM/YYYY, depending on localization settings.

  • Merge Field: {{recipient.billing_overdue_at}}

  • Example: 05/01/2020

Billing Payment Method

Displays the billing payment method on file (for autopay only).

  • Merge Field: {{recipient.billing_payment_method}}

  • Example: Credit Card

Current Account Balance

Displays the current remaining balance for the billing account. Formatted with decimal points but no currency sign.

  • Merge Field: {{recipient.current_account_balance}}

  • Example: 8100.00

Current Student Balance

Displays the current remaining balance for the student (contact). Formatted with decimal points but no currency sign.

  • Merge Field: {{contact.current_contact_balance}}

  • Example: 8100.00

Next Account Balance

Displays the next balance due for the billing account. Formatted with decimal points but no currency sign.

  • Merge Field: {{recipient.next_account_balance}}

  • Example: 8100.00

Next Student Balance

Displays the next balance due for the student (contact). Formatted with decimal points but no currency sign.

  • Merge Field: {{contact.next_contact_balance}}

  • Example: 8100.00

Next Account Billing Date

Displays the next billing date for the billing account. Formatted as MM/DD/YYYY or DD/MM/YYYY, depending on localization settings.

  • Merge Field: {{recipient.next_account_billing_date}}

  • Example: 06/01/2020

Total Account Balance

Displays the total balance due for the billing account. Formatted with decimal points but no currency sign.

  • Merge Field: {{recipient.total_account_balance}}

  • Example: 8100.00

Total Student Balance

Displays the total balance due for the contact (student). Formatted with decimal points but no currency sign.

  • Merge Field: {{contact.total_contact_balance}}

  • Example: 8100.00

Related articles

Comments

0 comments

Article is closed for comments.