Skip to main content

Merge Fields

Corey Syrnyk
  • Updated

Account Information

The account information is your business information that can be used to tell the customer who the message is coming from.  
 

Merge Field

Message Type

%Account.CompanyName%

All

%Account.Address1%

All

%Account.Address2%

All

%Account.City%

All

%Account.State%

All

%Account.Country%

All

%Account.Zip%

All

%Account.SupportEmail%

All

%Account.SupportPhone%

All

%Account.BillingEmail%

All

%Account.BillingPhone%

All

%Account.WebsiteLabel%

All

%Account.WebsiteUrl%

All

%Account.Fax%

All

%Account.Logo%

All
 

Customer Contact Information

The customer contact information is data about the customer to personalize messaging to a specific customer.

 

Merge Field

Message Type

Description

%Customer.StaxbillID%

All

 

%Customer.FirstName%

All

 

%Customer.MiddleName%

All

 

%Customer.LastName%

All

 

%Customer.CompanyName%

All

 

%Customer.Suffix%

All

 

%Customer.PrimaryEmail%

All

 

%Customer.PrimaryPhone%

All

 

%Customer.SecondaryEmail%

All

 

%Customer.SecondaryPhone%

All

 

%Customer.Title%

All

 
 

Customer Address

Merge Field

Message Type

Description

%CustomerBillingAddress.CompanyName%

All

 

%CustomerBillingAddress.Address1%

All

 

%CustomerBillingAddress.Address2%

All

 

%CustomerBillingAddress.City%

All

 

%CustomerBillingAddress.State%

All

 

%CustomerBillingAddress.Country%

All

 

%CustomerBillingAddress.Zip%

All

 

%CustomerShippingAddress.CompanyName%

All

 

%CustomerShippingAddress.Address1%

All

 

%CustomerShippingAddress.Address2%

All

 

%CustomerShippingAddress.City%

All

 

%CustomerShippingAddress.State%

All

 

%CustomerShippingAddress.Country%

All

 

%CustomerShippingAddress.Zip%

All

 

%CustomerShippingAddress.ContactName%

All

 

%CustomerShippingAddress.ShippingNotes%

All

 
 

Stax Bill Customer Information

Merge Field

Message Type 

Description

%Customer.StaxbillId%

All

 

%Customer.CustomerId%

All

 

%Customer.Status%

All

 

%Customer.AvailableFunds%

All

 

%Customer.CurrentBalance%

All

Displays balance and currency.

%Customer.SimpleBalance% 

All

Displays only the balance.

%Customer.BalanceDirection%

All

Displays either owing or on deposit.

%CustomerCredential.PortalLink%

Customer Credential Create

 

%CustomerCredential.Username%

All

 

%CustomerCredential.RenewalLink%

Expiry Renewal Notice

 

*%CustomerCredential.HomeLink%

All except Customer Credential Create and Password Reset

 

*%CustomerCredential.InvoiceLink%

All except Customer Credential Create and Password Reset

 

*%CustomerCredential.InvoiceDetailsLink%

Invoice Posted and Invoice Overdue only

 

*%CustomerCredential.PaymentMethodLink%

All except Customer Credential Create and Password Reset

 

*%CustomerCredential.SubscriptionLink%

All except Customer Credential Create and Password Reset

 

*%CustomerCredential.SubscriptionDetailsLink%

Subscription Activation and Expiry Renewal Notice only

 

*%CustomerCredential.StatementLink%

All except Customer Credential Create and Password Reset

 

*These Customer Credential merge fields provide links to pages within a Stax Bill hosted Self-Service Portal (SSP). The name of the merge field indicates the page the customer will be directed to. If you have not configured a Stax Bill SSP, the merge fields will have no effect. The customer can only click the link once, after which it will expire. You can include multiple merge fields inside the body of an email notification; however, only the first link clicked will take the customer to the expected page. All subsequent attempts will take the customer to the login page of your Stax Bill SSP.

 

Invoice/Payment Detail

Merge Field

Message Type

Description

%Invoice.AmountDue%

Invoice Posted

 

%Invoice.Terms%

Invoice Posted

 

%Invoice.PaymentSchedule%

Invoice Posted

 

%Invoice.Number%

Invoice Posted and Invoice Overdue

 

%Payment.InvoicesPaid%

Payment Received, Payment Failed

 

%Payment.Amount%

Payment Received, Payment Failed

 

%Payment.SimpleAmount%

Payment Received, Payment Failed

Displays the payment amount without currency

%Payment.Id%

Payment Received, Payment Failed

 

%Payment.ErrorReason%

Payment Received, Payment Failed

 

%Refund.Amount%

Refund

 

%Credit.Amount%

Credit Added to Account

 

%CreditCard.CardType%

Payment Received, Payment Failed, Upcoming Billing Notification, Refund

 

%CreditCard.CardHolderName%

Payment Received, Payment Failed, Upcoming Billing Notification, Refund

 

%CreditCard.MaskedCardNumber%

Payment Received, Payment Failed, Upcoming Billing Notification, Refund

 

%CreditCard.ExpirationMonth%

Payment Received, Payment Failed, Upcoming Billing Notification, Refund

 

%CreditCard.ExpirationYear%

Payment Received, Payment Failed, Upcoming Billing Notification, Refund

 

 

Surcharging

 

%Payment.Surchargeamount%

Payment Received and Payment Refund 

Surcharge amount in dollars.

%Payment.FullAmount%

Payment Received and Payment Refund

Payment and surcharge amount.
 

Statement

Merge Field

Message Type

%Statement.FromDate%

Statement Notification

%Statement.ToDate%

Statement Notification
 

Subscription

Merge Field

Message Type

%Subscription.Name%

Subscription Activation, Subscription Cancellation, Expiry Renewal Notice

%Subscription.Description%

Subscription Activation, Subscription Cancellation, Expiry Renewal Notice

%Subscription.RechargeFrequency%

Subscription Activation, Subscription Cancellation, Expiry Renewal Notice

%Subscription.NextRechargeDate%

Subscription Activation, Subscription Cancellation, Expiry Renewal Notice

%Subscription.ExpiryDate%

Subscription Activation, Subscription Cancellation, Expiry Renewal Notice
 

Reference and Tracking

Merge Field

Message Type

%Customer.Reference.Reference1%

All

%Customer.Reference.Reference2%

All

%Customer.Reference.Reference3%

All

%Customer.Acquisition.AdContent%

All

%Customer.Acquisition.Campaign%

All

%Customer.Acquisition.Keyword%

All

%Customer.Acquisition.LandingPage%

All

%Customer.Acquisition.Medium%

All

%Customer.Acquisition.Source%

All

*%Customer.Reference.SalesTrackingCode1.Code%

All

*%Customer.Reference.SalesTrackingCode1.Name%

All

*%Customer.Reference.SalesTrackingCode1.Description%

All

*%Customer.Reference.SalesTrackingCode1.Email%

All

*For Sales Tracking Code merge fields, replace the 1 with the appropriate sales tracking code number (1 through 5) for the information you wish to include. 

 

Projected Invoice

Merge Field

Message Type

%ProjectedInvoice.AmountDue%

Upcoming Billing Notification

%ProjectedInvoice.EstimatedDaysBeforeBillingDate%

Upcoming Billing Notification

%ProjectedInvoice.EstimatedBillingDate%

Upcoming Billing Notification
 

System Merge

Merge Fields

Message Type

%Today%

All

Related articles