Skip to main content

Billing Merge Fields

Josh
  • Updated
Not yet followed by anyone

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.

In this Article

Upcoming Billing Date and Payment Method Merge Tokens

Billing Payment Method

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

  • Merge Field: {{recipient.billing_payment_method}}

  • Example: Credit Card

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

Autopay Merge Tokens

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.

  • Merge Field: {{recipient.billing_autopay_enabled}}
  • Example: false

Autopay Date(s)

These all display the payer's Autopay dates.

  • Merge Fields: {{statement.autopay_dates}}, {{recipient.autopay_billing_days}}, and {{contact.autopay_billing_days}}
  • Example: 1st

Next Autopay Amount

Displays the payer's next Autopay amount due.

  • Merge Field: {statement.formatted_next_autopay_amount}}
  • Example: $230.00

Next Autopay Date

Displays the payer's next Autopay date.

  • Merge Field: {{statement.next_autopay_date}}
  • Example: 04/01/2025

Autopay Convenience Fee Disclaimer

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

  • Merge Field: {{ statement.autopay_convenience_fee_disclaimer }}
  • Example: 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

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.) 

  • Merge Field: {{ statement.formatted_autopay_convenience_fee_amount }}
  • 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.)

Overdue Merge Tokens

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

Balance Merge Tokens

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

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

Convenience Fee Merge Tokens

A couple of notes

Bulleted Lists of Convenience Fees

  • These tokens display only the payment methods that have been enabled. Any type of payment method that has been disabled in one of the areas (application, deposit, billing, custom forms) will not display when the merge token is used.
    • I.E. if you've disabled the possibility for parents to pay the Application fee by check (on the Application Fee page), the "Check" bullet point will not display if you use the {{system.convenience_fee_descriptions_application}} merge token.
  • If there is no convenience fee for an enabled payment method, the token will still display and will display $0.00, as seen in the table above.

Application Convenience Fees

List of convenience fees for all payment methods enabled for applications.

  • Merge Field: {{system.convenience_fee_descriptions_application}} 

  • Example:

    • Check Convenience Fee: $0.00

    • Wire Transfer Convenience Fee: $0.00

    • Credit Card convenience fee: 3.05%

    • Electronic Check convenience fee: $2.50

Deposit Convenience Fees

List of convenience fees for all payment methods enabled for deposits.

  • Merge Field:{{system.convenience_fee_descriptions_deposit}}

  • Example: 

    • Check Convenience Fee: $0.00

    • Wire Transfer Convenience Fee: $0.00

    • Credit Card convenience fee: 3.05%

    • Electronic Check convenience fee: $2.50

Billing Portal Convenience Fees

List of convenience fees for all payment methods available in the Billing Management portal.

Please note:

  • This token is specific to the options that parents can utilize in the Billing Management tab of their Parent portal account.
  • Within the parent portal, parents only have access to Credit Card and Electronic Check (ACH) payment options. This is the only area of the site that you do not have access to define which methods are available. In all other instances (Application Fee, Deposit, and Custom Form payments) you can enable/disable the payment methods available.

  • Merge Field:{{system.convenience_fee_descriptions_billing}}

  • Example: 

    • Credit Card convenience fee: 3.05%

    • Electronic Check convenience fee: $2.50

Adhoc (Custom Form) Convenience Fees

List of convenience fees for all payment methods applicable for custom forms.

  • Merge Field: {{system.convenience_fee_descriptions_ad_hoc_form}}

  • Example: 

    • Credit Card convenience fee: 3.05%

    • Electronic Check convenience fee: $2.50

    • Check Convenience Fee: $0.00

Individual Convenience Fees

These tokens only display the fee amount (or percentage.) They do not include the payment method type. (As seen in the Example Display column above.)

Please note:

  • The information pulled into these tokens populates from the information on your Payment Setup page. The amounts listed are the amounts you have set as the convenience fee to pass to parents.
  • If there is no convenience fee for an enabled payment method, the token will still display and will display $0.00, as seen in the table above.

Credit Card Convenience Fee

Fee associated with Credit Card payments.

  • Merge Field: {{system.convenience_fee_description_credit_card}}

  • Example: 3.05%

Electronic Check Convenience Fee

Fee associated with ACH payments.

  • Merge Field:{{system.convenience_fee_description_electronic_check}}

  • Example: $2.50

Check (paper check) Convenience Fee

Fee associated with Check payments.

  • Merge Field:{{system.convenience_fee_description_check}}

  • Example: $0.00

Custom Payment Method Convenience Fee

Fee associated with Custom payment methods.

  • Merge Field: {{system.convenience_fee_description_custom}}

  • Example: $0.00

Related articles

Comments

0 comments

Article is closed for comments.