For the complete documentation index, see llms.txt. This page is also available as Markdown.

Klaviyo Member Notification Metrics and Their Template Variables

Membership Custom Properties

The following profile variables are available for all Inveterate customer notification metrics sent to Klaviyo:

Name
Description
Examples
Syntax

Inveterate: Credits

Number of credits available

24.99, 25

{{ person | lookup:'Inveterate: Credits' | default:'0' }}

Inveterate: Date Joined

Date customer joined membership program. Format options

March 14, 2023

{{ person | lookup:'Inveterate: Date Joined' | format_date_string|date:'F d, o' }}

Inveterate: Referrals Count

Number of times customer has been credited for program referral

2

{{ person | lookup:'Inveterate: Referrals Count' | default:'0' }}

Inveterate: Subscription Status

Status of membership

CANCELLED, ACTIVE, PENDING_CANCELLATION

{{ person | lookup:'Inveterate: Subscription Status' | default:'' }}

Inveterate: Tier Name

Tier name

Acme Plus

{{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }}

If you wanted to use these in a template, here is an example:

You joined {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }} 
on {{ person | lookup:'Inveterate: Date Joined' | format_date_string|date:'F d, o' }}.

You have referred {{ person | lookup:'Inveterate: Referrals Count' | default:'0' }} 
other members to the program.

You have ${{ person | lookup:'Inveterate: Credits' | default:'0' }} credits available.

Your current subscription status is {{ person|lookup:'Inveterate: Subscription Status' | lower | default:'active' }}.

Additional template variables like {{ first_name }} are likely available through your Klaviyo account - you can view Klaviyo's official docs here and here.

"Inveterate: Welcome" Metric

Triggered when a customer first purchases your subscription product. Is not retriggered when a member renews their subscription after cancellation.

Event Properties

None

Template Example

"Inveterate: Credits Redeemed" Metric

Triggered when a customer completes an order that used redeemed credits.

Event Properties

Name
Description
Example
Syntax

creditsRedeemed

Number of credits used in order

24.99, 25

{{ event.creditsRedeemed | default:'0' }}

newCreditsBalance

Credits member now has left

0.99, 1

{{ event.newCreditsBalance | default:'0' }}

Template Example

"Inveterate: Signup Discount" Metric

Triggered when a customer first purchases a membership product, if you have the "Sign Up Discounts" benefit enabled.

Event Properties

Name
Description
Example
Syntax

discountCode

Unique sign up discount code created for each member

VIP_123

{{ event.discountCode | default:'' }}

isPercentage

Is the discount a percent amount off a future order

true or blank

isFixed

Is the discount a fixed dollar amount

true or blank

{% if event.isFixed %}${% endif %}

discountAmount

How much off an order is the discount

10, 9.99

{{ event.discountAmount | default:'0' }}

isOneTimeUse

Is the discount disabled after 1 use, or can it be used multiple times

true or blank

expirationDate

If the discount code expires, when

August 9, 2023 or blank

Template Example

"Inveterate: Credits Awarded" Metric

Triggered when a member is awarded credits from the "Credits for Orders" benefit, and from the "Recurring Store Credits" benefit.

Name
Description
Example
Syntax

creditsAwarded

Amount of new credits awarded

10, 9.99

{{ event.creditsAwarded | default:'0' }}

newCreditsBalance

Balance after credits awarded.

10, 9.99

{{ event.newCreditsBalance | default:'0' }}

Template Example

"Inveterate: Credits Expiring" Metric

Triggered N days before some credits of a customer's expire, where N is determined by the settings under the "Reminders" tab of the Messaging Settings Page in your merchant dashboard.

Event Properties

Name
Description
Example
Syntax

creditsExpiring

Amount of credits expiring

$23.32

{{ event.creditsExpiring | default:'' }}

daysLeft

Days until credits expire

15 days

{{ event.daysLeft | default:'a few days' }}

Template Example

"Inveterate: Referral Completed" Metric

Triggered when a new member is referred by the member receiving this email.

Event Properties

Name
Description
Example
Syntax

referralEmail

Email of referred customer

test@gmail.com

{{ event.referralEmail | default:'' }}

creditsAwarded

Amount of new credits awarded

42

{{ event.creditsAwarded | default:'' }}

newCreditsBalance

Updated total credits to spend

110.25

{{ event.newCreditsBalance | default:'' }}

Template Example

"Inveterate: Rebill Notice" Metric

Sent to member a few days before they are recharged for their membership.

Event Properties

Name
Description
Example(s)
Syntax

rebillDate

Date of upcoming charge.

03-10-2024

{{ event.rebillDate | default:'' }}

rebillDateIso

Works with formatting filters.

{{ event.rebillDateIso | format_date_string | date: "%B %d, %Y" }}

rebillPrice

Cost of upcoming charge

9.99

{{ event.rebillPrice | default:'' }}

rebillFrequency

How often does member fee recur

monthly, quarterly

{{ event.rebillFrequency | default:'' }}

supportEmail

Your customer support email, set here

"help@acme.com" or blank

{{ event.supportEmail | default:'' }}

cancellationPolicy

Merchant's policy on whether benefits cease immediately after cancel, or at end of cycle

END_OF_BILLING_CYCLE, IMMEDIATELY

{{ event.cancellationPolicy | default:'' }}

Template Example

"Inveterate: Anniversary Credits" Metric

Email triggered when a member has been part of the program for 12 months.

Event Properties

Name
Description
Examples
Syntax

creditsAwarded

Amount of new credits awarded

20, 19.99

{{ event.creditsAwarded | default:'' }}

newCreditsBalance

Updated total credits to spend

20, 19.99

{{ event.newCreditsBalance | default:'' }}

Template Example

"Inveterate: Cancellation Notice" Metric (legacy)

Email triggered when a request to cancel a customer's membership is pending or effective. We recommend using the newer "Inveterate: Cancellation Pending" and "Inveterate: Cancellation Effective" metrics instead.

Event Properties

Name
Description
Example
Syntax

cancellationPolicy

Determines whether customer loses benefits immediately after cancellation.

END_OF_BILLING_CYCLE, IMMEDIATELY

cancellationDate

The effective cancellation date - when benefits stop working.

February 10, 2024

{{ event.cancellationDate | default:'in a few days' }}

tierName

Tier name

Acme Gold

{{ event.tierName | default:'membership' }

Template Example

"Inveterate: Cancellation Effective" Metric

Email triggered when a customer's membership is effectively cancelled, and they lose access to their benefits.

Event Properties

Name
Description
Example
Syntax

tierName

Tier name

Acme Gold

{{ event.tierName | default:'membership' }

Template Example

"Inveterate: Cancellation Pending" Metric

Email triggered when a request to cancel a customer's membership is submitted, but they will not lose their benefits until the end of the billing cycle.

Event Properties

Name
Description
Example
Syntax

cancellationDate

The effective cancellation date - when benefits stop working.

February 10, 2024

{{ event.cancellationDate | default:'in a few days' }}

tierName

Tier name

Acme Gold

{{ event.tierName | default:'membership' }

Template Example

"Inveterate: Membership Change" Metric

Email triggered when a customer upgrades or downgrades their membership plan.

Event Properties

Name
Description
Examples
Syntax

newTierName

Tier name

"Acme Gold"

{{ event.newTierName | default:'' }}

newTierPrice

Tier price

39.99, 20

{{ event.newTierPrice | default:'' }}

tierGradeChange

Upgrade or downgrade?

"upgrade", "downgrade"

{{ event.tierGradeChange | default:'' }}

Template Example

"Inveterate: Payment Failure" Metric

Email triggered after customer’s payment method fails.

Event Properties

Name
Description
Example
Syntax

lastAttemptDate

Date of upcoming final billing attempt before membership is cancelled.

February 10, 2024

{{ event.lastAttemptDate | default:'the final attempt day' }}

Template Example

"Inveterate: Free Trial Notice" Metric

Triggered when a customer starts their free trial.

Event Properties

Name
Description
Example
Syntax

tierPrice

What is subscription price of tier customer is trialing

"0", "1", "0.90", "19.99"

{{ event.tierPrice | default:'' }}

billingFrequency

How often is the tierPrice charged

"month", "quarter", "semester", "year", "one time"

{{ event.billingFrequency | default:'' }}

billProse

Price and frequency string as it would be used in a sentence

"$5 a month", "$9.99 twice a year", "$20 every 3 months", "$99.99 one time"

{{ event.billProse | default:'' }}

trialEndDate

On what day and time does the trial end

March 14, 2023 at 11:37 AM

{{ event.trialEndDate | default:'' }}

tierName

Name of tier customer is trialing

"Acme Gold"

{{ event.tierName | default:'' }}

Template Example

"Inveterate: Free Trial Cancelled" Metric

Triggered when a member cancels their free trial.

Event Properties

Name
Description
Example
Syntax

tierName

Name of tier customer is trialing

"Acme Gold"

{{ event.tierName | default:'' }}

Template Example

"Inveterate: Free Trial Ends Soon" Metric

Triggered a few days before a customer's free trial ends.

Event Properties

Name
Description
Example
Syntax

tierPrice

What is subscription price of tier customer is trialing

"0", "1", "0.90", "19.99"

{{ event.tierPrice | default:'' }}

billingFrequency

How often is the tierPrice charged

"month", "quarter", "semester", "year", "one time"

{{ event.billingFrequency | default:'' }}

billProse

Price and frequency string as it would be used in a sentence

"$5 a month", "$9.99 twice a year", "$20 every 3 months", "$99.99 one time"

{{ event.billProse | default:'' }}

trialEndDate

On what day and time does the trial end

March 14, 2023 at 11:37 AM

{{ event.trialEndDate | default:'' }}

tierName

Name of tier customer is trialing

"Acme Gold"

{{ event.tierName | default:'' }}

Template Example

"Inveterate: Free Trial Ended" Metric

Triggered when a customer's free trial ends.

Event Properties

Name
Description
Example
Syntax

tierPrice

What is subscription price of tier customer is trialing

"0", "1", "0.90", "19.99"

{{ event.tierPrice | default:'' }}

billingFrequency

How often is the tierPrice charged

"month", "quarter", "semester", "year", "one time"

{{ event.billingFrequency | default:'' }}

billProse

Price and frequency string as it would be used in a sentence

"$5 a month", "$9.99 twice a year", "$20 every 3 months", "$99.99 one time"

{{ event.billProse | default:'' }}

tierName

Name of tier customer is trialing

"Acme Gold"

{{ event.tierName | default:'' }}

Template Example

"Inveterate: Birthday Credits" Metric

Triggered when a member is awarded credits from the "Birthday Credits" benefit, on their birth date.

Event Properties

Name
Description
Example
Syntax

creditsAwarded

Amount of new credits awarded

"0", "1", "0.90", "19.99"

{{ event.creditsAwarded | default:'0' }}

newCreditsBalance

Balance after credits awarded.

"0", "1", "0.90", "19.99"

{{ event.newCreditsBalance | default:'0' }}

Template Example

"Inveterate: Lookback CFO Credits" Metric

Triggered when a non-member places an order and is eligible to receive credits retroactively if they purchase a membership within the Lookback Credits window.

Event Properties

Name
Description
Example
Syntax

tierName

Name of the tier used to calculate the potential credits

Gold, VIP

{{ event.tierName | default:'' }}

potentialCredits

Amount of credits the customer would receive upon joining

20, 24.99

{{ event.potentialCredits | default:'0' }}

orderTotal

Order total used to calculate the potential credits

100, 249.95

{{ event.orderTotal | default:'0' }}

lookbackCreditsDay or lookbackCreditsDays

Number of days (or day) the customer has to join and receive the credits

1, 7, 14

{{ event.lookbackCreditsDays | default:'0' }}

Template Example

Last updated

Was this helpful?