Email variables
Notification Emails glossary
Breakdown of all the notification emails, variables they contain, and required variables.
| Variables | Required | |
|---|---|---|
| All Emails | "site.name", "site.website", "member.first_name", "member.last_name", "member.email" | |
| Default Email Layout | "email_content" | "email_content" |
| Member Invite | "plan.paid?", "plan.name", "confirmation_link", "plan.description | html_safe" | "confirmation_link" |
| Member Approval | "login_link", "login_url", "plan.name", "plan.description | html_safe" | "login_link OR login_url" |
| Member Denial | ||
| Password Reset | "password_reset_link", "password_reset_url", "requested_on" | "password_reset_link" OR "password_reset_url" |
| Email Change | "confirmation_link", "confirmation_url" | "confirmation_link" OR "confirmation_url" |
| Plan Expiring Soon | "expiration_date", "plan_name" | "expiration_date", "plan_name" |
| Plan Expired | "plan_name", "expiration_date" | "plan_name", "expiration_date" |
| Trial Is Starting | "amount", "interval", "plan | plan_description: member: member", "plan.name", "plan_cancelation_url", "trial_end_date" | "amount", "interval", "plan.name", "plan_cancelation_url", "trial_end_date" |
| Trial Is Ending | "plan.price", "member.card_last4", "member.card_brand", "plan.name", "plan.description | html_safe" | "member.card_last4", "member.card_brand" |
| Abandoned Signup - 1st Attempt | "purchase_link", "purchase_url" | |
| Abandoned Signup - 2nd Attempt | "purchase_link", "purchase_url" | |
| Successful Charge Receipt | "amount", "invoice_link", "invoice_url" | "invoice_link" OR "invoice_url" |
| Cancelation Email | "plan.name", "plan.price", "plan.type", "plan | plan_description" | "plan.name" |
| Failed Payment - Attempt 1 | "update_card_url", "amount_due" | "update_card_url", "amount_due" |
| Failed Payment - Attempt 2 | "update_card_url", "amount_due" | "update_card_url", "amount_due" |
| Failed Payment - Attempt 3 | "update_card_url", "amount_due" | "update_card_url" |
| Failed Payment - Plan Canceled | "update_card_url", "amount_due" | "update_card_url", "amount_due" |
| Failed Payment Incomplete (EU customers only) | "confirm_payment_url", "amount_due" | "confirm_payment_url", "amount_due" |
| Requires Authorization (EU customers only) | "confirm_payment_url" | "confirm_payment_url" |
| Payment Renewal Reminder | "amount_due", "days_until_due", "member.card_last4", "member.card_brand", "plan.description | html_safe" | "amount_due", "days_until_due", "member.card_last4", "member.card_brand" |
| Welcome Email | "coupon.discount", "coupon.id", "interval", "period_start_date", "plan | plan_description: member: member", "plan.name", "plan.price", "plan.type", "plan_cancelation_url" |
Variables glossary
This is a list of all the variables found in our Notification Emails and their purpose
| Variable Name | Definition |
|---|---|
| amount | Payment amount charged |
| amount_due | Payment amount |
| confirm_payment_url | Payment confirmation for specified emails |
| confirmation_link | Text link to confirm specified action (accept invite, change email) |
| confirmation_url | URL to confirm specified action (accept invite, change email) |
| coupon.discount | Discount provided |
| coupon.id | Name of coupon |
| days_until_due | Time left until payment is owed |
| email_content | Custom content within 'Default layout' that applies in every email |
| expiration_date | Date of member plan expiration |
| interval | How often member is billed |
| invoice_link | Invoice text link |
| invoice_url | Invoice full URL |
| login_link | Login text link |
| login_url | Login full URL |
| member.card_brand | Credit card company (Visa, Amex, Mastercard, etc) |
| member.card_last4 | Last 4 digits of card on file |
| member.email | Member email address |
| member.first_name | Member first name |
| member.last_name | Member last name |
| password_reset_link | Password reset text link |
| password_reset_url | Password reset full URL |
| period_start_date | Month/Day/Year when billing cycle begins |
| plan | plan_description | Name of member plan and the plan description |
| plan | plan_description: member: member | Member plan description |
| plan_cancelation_url | Text link to cancel subscription |
| plan.name | Name of member plan |
| plan.paid? | If invited to a paid plan |
| plan.price | Full price of member plan |
| plan.type | Type of member plan (subscription, one time, free) |
| purchase_link | Unique text link that leads to payment form |
| purchase_url | Unique URL that leads to payment form |
| requested_on | Month/Day/Year/Time/Timezone email was delivered |
| site.name | Name of website |
| site.website | Website URL |
| trial_end_date | Month/Day/Year trial period ends |