Our Platform. Your Vision.

Search

Replacement Field Reference

Replacement fields let you automatically insert customer, facility, contract, payment, and other information into your templates.

For example:

{{first_name}}

When the template is generated, Redpoint replaces the field with the appropriate value for the customer or record being used.

Using Replacement Fields

Enter the exact replacement field, including the double braces:

{{first_name}}

Replacement field names are case-sensitive.

The fields available depend on the type of template you're creating. For example, contract fields require a contract, while invoice fields require an invoice.

Some additional things to keep in mind:

  • Fields ending in _long use the long date format.
  • Fields ending in _short use the short date format.
  • Facility dates and times use the active facility's timezone.
  • Missing or open-ended dates may display as —.
  • Monetary values are automatically formatted as currency.
  • Some fields generate formatted content, images, links, or other markup rather than plain text.

 

A Note About Availability

Not every replacement field is available in every template.

The available fields depend on the record associated with the content being generated. For example:

  • Contract fields require a contract.
  • Session fields require a session.
  • Invoice fields require an invoice.
  • Payment fields require a payment.
  • Gift card fields require a gift card.
  • Customer fields require an associated customer.
  • Facility fields require an active facility.

If the required information isn't available in the current context, the replacement field may be blank or display a fallback value.

General Fields

These fields are available in standard template contexts.

Replacement Field Description
{{initials}} Initials field used when completing supported documents.
{{signature}} Signature field used when completing supported documents.
{{checkbox}} Agreement checkbox used when completing supported documents.
{{first_name}} Customer's first name.
{{last_name}} Customer's last name.
{{customer_id}} Customer ID.
{{customer_first_name}} Customer's first name.
{{customer_last_name}} Customer's last name.
{{customer_address_line}} Customer's address displayed on one line.
{{customer_address_block}} Customer's address displayed as a formatted address block.
{{primary_guardian_first_name}} Primary guardian's first name. Falls back to the customer if no guardian exists.
{{primary_guardian_last_name}} Primary guardian's last name. Falls back to the customer if no guardian exists.
{{customer_default_credit_card}} Customer's default stored card brand and masked account number.
{{customer_default_payment_method}} Customer's default stored payment method and masked account information.
{{customer_default_credit_card_expiry}} Expiration date of the customer's default card.
{{organization_name_long}} Organization's full name.
{{organization_name_short}} Organization's short name.
{{facility_current_date_long}} Current date at the facility in long format.
{{facility_current_date_short}} Current date at the facility in short format.
{{facility_current_time}} Current time at the facility.
{{facility_name_long}} Facility's full name.
{{facility_name_short}} Facility's short name.
{{facility_address}} Facility's address.
{{facility_phone}} Facility's phone number.
{{facility_email}} Facility's email address.
{{standard_header}} Standard header assigned to the facility.
{{standard_footer}} Standard footer assigned to the facility.
{{required_unsubscribe_link}} Email unsubscribe link.

Customer Billing

Replacement Field Description
{{customer_recurring_contracts_billing_summary}} Formatted summary of the customer's active recurring contracts, including billing information and contract start date.

Contract and Course Fields

These fields are available when the template has a contract or course context 

(ie, New Contract email, enabled in the customer notifications plan congifuration spoke and all contract related template emails in Build > Notifications > Templates)

Replacement Field Description
{{plan_title}} Customer-facing plan title.
{{contract_label}} Appropriate label for the contract, such as contract, booking, agreement, or pass.
{{contract_signed_date_long}} Contract booking/signing date in long format.
{{contract_signed_date_short}} Contract booking/signing date in short format.
{{contract_start_date_long}} Contract start date in long format.
{{contract_start_date_short}} Contract start date in short format.
{{contract_end_date_long}} Contract end date in long format.
{{contract_end_date_short}} Contract end date in short format.
{{course_start_date_long}} Course start date in long format.
{{course_start_date_short}} Course start date in short format.
{{course_end_date_long}} Course end date in long format.
{{course_end_date_short}} Course end date in short format.
{{course_start_time}} Course start time.
{{course_end_time}} Course end time.
{{course_session_count}} Number of sessions in the course.
{{contract_enrollment_count}} Number of enrollments on the contract.
{{enrollments_comma_separated}} Names of enrolled customers displayed as a comma-separated list.
{{enrollments_list}} Names of enrolled customers displayed as a formatted list.
{{contract_startup_price}} Total startup price.
{{contract_balance_due}} Outstanding contract balance.
{{contract_recurring_dues_price}} Recurring dues after discounts.
{{contract_recurring_dues_undiscounted_price}} Recurring dues before discounts.
{{contract_status}} Current contract status.
{{contract_holder_first_name}} Contract holder's first name.
{{contract_holder_last_name}} Contract holder's last name.
{{contract_holder_date_of_birth}} Contract holder's date of birth.
{{contract_holder_age}} Contract holder's age.
{{contract_details}} Formatted contract details.
{{contract_last_bill_date_long}} Most recent billing date in long format.
{{contract_last_bill_date_short}} Most recent billing date in short format.
{{contract_next_bill_date_long}} Next billing date in long format.
{{contract_next_bill_date_short}} Next billing date in short format.
{{contract_next_bill_second_date_long}} Second upcoming billing date in long format.
{{contract_next_bill_second_date_short}} Second upcoming billing date in short format.
{{contract_next_bill_third_date_long}} Third upcoming billing date in long format.
{{contract_next_bill_third_date_short}} Third upcoming billing date in short format.
{{contract_min_termination_date_short}} Earliest permitted termination date in short format. May display Prepaid or Not Allowed when applicable.
{{contract_min_termination_date_long}} Earliest permitted termination date in long format. May display Prepaid or Not Allowed when applicable.
{{new_contract_attachment_link}} Link to the new contract attachment when supported by the delivery process.

Session Fields

Replacement Field Description
{{course_session_number}} Session's sequence number within the course.
{{session_start_date_long}} Session start date in long format.
{{session_start_date_short}} Session start date in short format.
{{session_end_date_long}} Session end date in long format.
{{session_end_date_short}} Session end date in short format.
{{session_start_time}} Session start time.
{{session_end_time}} Session end time.

Enrollment Status Fields

Replacement Field Description
{{status_activation_date_long}} Date the enrollment status takes effect in long format.
{{status_activation_date_short}} Date the enrollment status takes effect in short format.
{{status_freeze_end_date_long}} Freeze end date in long format.
{{status_freeze_end_date_short}} Freeze end date in short format.
{{status_requested_date_long}} Date the status change was requested in long format.
{{status_requested_date_short}} Date the status change was requested in short format.
{{status_customer_first_name}} First name of the customer whose enrollment status is changing.
{{status_customer_last_name}} Last name of the customer whose enrollment status is changing.
{{status_customer_name}} Name of the customer whose enrollment status is changing.

Enrollment Fields

These fields can be used within sections that repeat for individual enrollments.

Replacement Field Description
{{looping_enrollment_first_name}} Enrolled customer's first name.
{{looping_enrollment_last_name}} Enrolled customer's last name.
{{looping_enrollment_type_singular}} Singular name of the enrollment type.
{{looping_enrollment_type_plural}} Plural name of the enrollment type.
{{looping_enrollment_date_of_birth}} Enrolled customer's date of birth.
{{looping_enrollment_age}} Enrolled customer's age.

Invoice Fields

Replacement Field Description
{{invoice_details}} Formatted invoice details.
{{receipt_details}} Invoice details formatted for a receipt.
{{invoice_gift_details}} Gift information associated with the invoice.
{{invoice_date_short}} Invoice date in short format.
{{invoice_date_long}} Invoice date in long format.
{{invoice_time}} Invoice posting time.
{{invoice_number}} Invoice reference number.
{{invoice_barcode}} Barcode representing the invoice number.
{{invoice_customer_name}} Paying customer's name.
{{invoice_for_customer_name}} Name of the customer the invoice is for.

Payment Fields

Replacement Field Description
{{payment_details}} Formatted payment details.
{{payment_receipt_details}} Payment details formatted for a receipt.
{{payment_amount}} Payment amount.
{{payment_date_short}} Payment date in short format.
{{payment_date_long}} Payment date in long format.
{{payment_time}} Payment posting time.
{{payment_status}} Payment status.
{{payment_number}} Payment reference number.
{{payment_customer_name}} Customer associated with the payment.

Gift Card Fields

Use in Build > Notifications > Templates > Gift Card Certificate

Replacement Field Description
{{gift_card_recipient_email}} Recipient's email address.
{{gift_card_recipient_first_name}} Recipient's first name.
{{gift_card_recipient_last_name}} Recipient's last name.
{{gift_card_recipient_message}} Message entered for the recipient.
{{gift_card_issue_date}} Gift card issue date.
{{gift_card_initial_balance}} Original gift card balance.
{{gift_card_current_balance}} Current remaining gift card balance.
{{gift_card_code}} Gift card redemption code.
{{gift_card_barcode}} Barcode representing the gift card code.

Ticket Fields

Used in Build > Notifications > Templates > Contact Us Ticket Received

Replacement Field Description
{{ticket_comment_body}} Current ticket comment.
{{ticket_replies_body}} Previous replies in the ticket.
{{ticket_update_date}} Date and time of the ticket update.
{{ticket_subject}} Ticket subject.
{{ticket_update_author}} Person who made the current update.
{{ticket_submitter}} Ticket submitter.
{{ticket_requester}} Ticket requester.
{{ticket_assignee}} Staff member assigned to the ticket.
{{ticket_comment_action_subject}} Short description of the current ticket action.
{{ticket_comment_action_body}} Detailed description of the current ticket action.
{{ticket_private_url}} Staff-facing link to the ticket.
{{ticket_project}} Ticket project name.
{{ticket_number}} Ticket reference number.

Promotion Fields

Promotion replacement fields can automatically generate unique promotion codes.

Promotion Code

{{promo_<code-name>_code}}

Generates a promotion code for the applicable promotion.

For example, if the promotion's code name is WELCOME:

{{promo_WELCOME_code}}

Promotion Barcode

{{promo_<code-name>_barcode}}

Generates a barcode containing the same promotion code.

For example:

{{promo_WELCOME_barcode}}

Promotion fields are available for eligible generated-code promotions. 

Custom Replacement Fields

Organizations can also create reusable custom replacement content.
Build these  in  Manage > Organization & Facility Settings > Custom Replacement Fields.

Email Content

{{email:<name>}}

Inserts the published custom email replacement content.

Document Content

{{document:<name>}}

Inserts the published custom document replacement content.

Storefront Fields

Storefront replacement fields provide information about the facility associated with the storefront.

Use these in Build > Storefronts > Web and Kiosk storefront markup AND in Build > Plans > Presentation spoke text

Replacement Field Description
{{storefront_facility_name}} Facility's full name.
{{storefront_facility_address}} Facility's address.
{{storefront_facility_phone}} Facility's phone number.
{{storefront_facility_email}} Facility's email address.

These fields are specifically for supported storefront content. 

 

SQL Report Fields

These replacement fields are used in SQL reports and report conditions. They are not content-template replacement fields.

Replacement Field Description
{{currentDateLocal}} Current local date.
{{nowLocal}} Current local date and time.
{{dateFromUtc}} Beginning of the selected date range in UTC.
{{dateToUtc}} End of the selected date range in UTC.
{{dateFromLocal}} Beginning of the selected date range in local time.
{{dateToLocal}} End of the selected date range in local time.
{{facilityIdList}} List of selected facility IDs.
{{planIdList}} List of IDs matching the selected plans.
{{productVariantIdList}} Selection of matching product variant IDs.
{{dateLocal}} Selected report date/time in local time.
{{dateUtc}} Selected report date/time in UTC.
{{badgeIdList}} List of selected badge IDs.
{{gateIdList}} List of selected gate IDs.
{{now_utc}} Current UTC date and time.

When using date or time replacement fields directly inside SQL, surround scalar values with quotes when the SQL expression requires a string value. List fields already provide the appropriate list structure. 

 

Related to