> For the complete documentation index, see [llms.txt](https://help.inveterate.com/help-center/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.inveterate.com/help-center/advanced-guides/replace-inveterate-emails-in-klaviyo/klaviyo-member-notification-metrics-and-their-template-variables.md).

# 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](https://help.klaviyo.com/hc/en-us/articles/115005257788)                                                                                 | 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](https://help.inveterate.com/help-center/guides/program-setup/benefits/credit-based-benefits/store-credits-for-purchase-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:

```liquid
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](https://help.klaviyo.com/hc/en-us/articles/4408802648731#01FJZ2P71QFT79P9A6ZRV4FF3C) and [here](https://developers.klaviyo.com/en/v1-2/docs/django-message-design).

## "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

```
Welcome to {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }}.

In order to access all your membership benefits, please take a moment to login or create your account.

If you have any questions, reach out to our customer support team at help@acme.com.
```

## "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

```liquid
You just redeemed ${{ event.creditsRedeemed | default:'0' }} in credit with your recent order.

You now have ${{ event.newCreditsBalance | default:'0' }} remaining in your account.

Thanks for being a part of {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }},

Acme Incorporated
```

## "Inveterate: Signup Discount" Metric

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

#### Event Properties

<table><thead><tr><th>Name</th><th>Description</th><th>Example</th><th>Syntax</th></tr></thead><tbody><tr><td>discountCode</td><td>Unique sign up discount code created for each member</td><td>VIP_123</td><td>{{ event.discountCode | default:'' }}</td></tr><tr><td>isPercentage</td><td>Is the discount a percent amount off a future order</td><td><code>true</code> or blank</td><td><pre><code>{% if event.isPercentage %} percent {% endif %}
</code></pre></td></tr><tr><td>isFixed</td><td>Is the discount a fixed dollar amount</td><td><code>true</code> or blank</td><td>{% if event.isFixed %}${% endif %}</td></tr><tr><td>discountAmount</td><td>How much off an order is the discount</td><td>10, 9.99</td><td>{{ event.discountAmount | default:'0' }}</td></tr><tr><td>isOneTimeUse</td><td>Is the discount disabled after 1 use, or can it be used multiple times</td><td><code>true</code> or blank</td><td><pre><code>{% if event.isOneTimeUse %} One time use. {% endif %}
</code></pre></td></tr><tr><td>expirationDate</td><td>If the discount code expires, when</td><td>August 9, 2023 or blank</td><td><pre><code>{{ event.expirationDate | default:'soon' }}
</code></pre></td></tr></tbody></table>

#### Template Example

```liquid
Here is your member signup discount code, {{ first_name }}!

As a valued member of {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }}, we’ve created a personal discount code just for you! 

{% if event.isPercentage %}
Get {{ event.discountAmount | default:'0' }}% off when you use code {{ event.discountCode | default:'' }} at checkout.
{% else %}
Get ${{ event.discountAmount | default:'0' }} off when you use code {{ event.discountCode | default:'' }} at checkout.
{% endif %}

{% if event.isOneTimeUse %}
One time use.
{% endif %}

{% if event.expirationDate %}
Expires {{ event.expirationDate | default:'soon' }}.
{% endif %}
```

## "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

```
You've just received ${{ event.creditsAwarded | default:'0' }} in store credit.
You now have a total of ${{ event.newCreditsBalance | default:'0' }} 
that you can redeem for purchases since you’re a member of {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }}.
```

## "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](https://dashboard.inveterate.com/messaging/settings) 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

```
Hey {{ first_name }}, we just wanted to send you a reminder.

You have {{ event.creditsExpiring | default:'0' }} in store credit that 
expire in {{ event.daysLeft | default:'a few days' }}.
```

## "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

```
{{ event.referralEmail | default:'' }} just joined Acme Premier because you referred them!
As a thank you, we've added {{ event.creditsAwarded | default:'' }} into your account.

You now have a total of {{ event.newCreditsBalance | default:'' }} that you can redeem for purchases since you’re a member of Premier.
```

## "Inveterate: Rebill Notice" Metric

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

#### Event Properties

<table><thead><tr><th>Name</th><th>Description</th><th>Example(s)</th><th>Syntax</th></tr></thead><tbody><tr><td>rebillDate</td><td>Date of upcoming charge. </td><td>03-10-2024</td><td>{{ event.rebillDate | default:'' }}</td></tr><tr><td>rebillDateIso</td><td>Works with formatting filters.</td><td><pre><code>2024-03-02T00:07:05.389Z
</code></pre></td><td>{{ event.rebillDateIso | format_date_string | date: "%B %d, %Y" }}</td></tr><tr><td>rebillPrice</td><td>Cost of upcoming charge</td><td>9.99</td><td>{{ event.rebillPrice | default:'' }}</td></tr><tr><td>rebillFrequency</td><td>How often does member fee recur</td><td>monthly, quarterly</td><td>{{ event.rebillFrequency | default:'' }}</td></tr><tr><td>supportEmail</td><td>Your customer support email, set <a href="https://dashboard.inveterate.com/messaging/settings">here</a></td><td>"help@acme.com" or blank </td><td>{{ event.supportEmail | default:'' }}</td></tr><tr><td>cancellationPolicy</td><td>Merchant's policy on whether benefits cease immediately after cancel, or at end of cycle</td><td>END_OF_BILLING_CYCLE, IMMEDIATELY</td><td>{{ event.cancellationPolicy | default:'' }}</td></tr></tbody></table>

#### Template Example

```
Your renewal for {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }}
Hi {{first_name}},

Thank you for your continued participation in our exclusive membership program! 
As a reminder, your membership is set to renew {{ event.rebillDate | default:'in the next few days' }} 
for a total of ${{ event.rebillPrice | default:'' }}.

If you need to update your billing details, you can do so within your account on our site.

If you no longer wish to receive your exclusive, member-only benefits, you can change your membership settings on our membership portal.
```

## "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

```
Happy anniversary, {{ first_name }}!

You have been a loyal member of {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }} for a year! 

To show our appreciation, we've awarded you ${{ event.creditsAwarded | default:'' }} in store credits.

You now have ${{ event.newCreditsBalance | default:'' }} in store credits to spend. 
Your credits can be accessed at any time from your member portal.

Thanks for being a part of {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }},

Acme
```

## "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

<table><thead><tr><th>Name</th><th>Description</th><th>Example</th><th>Syntax</th></tr></thead><tbody><tr><td>cancellationPolicy</td><td>Determines whether customer loses benefits immediately after cancellation.</td><td>END_OF_BILLING_CYCLE,  IMMEDIATELY</td><td><pre><code>{% if event.cancellationPolicy == 'END_OF_BILLING_CYCLE' %}
</code></pre></td></tr><tr><td>cancellationDate</td><td>The effective cancellation date - when benefits stop working.</td><td>February 10, 2024</td><td>{{ event.cancellationDate | default:'in a few days' }}</td></tr><tr><td>tierName</td><td>Tier name</td><td>Acme Gold</td><td>{{ event.tierName | default:'membership' }</td></tr></tbody></table>

#### Template Example

```
{{ first_name }}, your {{ event.tierName | default:'membership' }} has been cancelled.

{% if event.cancellationPolicy == 'END_OF_BILLING_CYCLE' %}
The cancellation will be effective {{ event.cancellationDate | default:'in a few days' }}, 
at the end of your billing period, at which points you no longer have access to your membership benefits.
{% else %}
The cancellation will be effective immediately. You are no longer able to use your old membership benefits.
{% endif %}
```

## "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

```
{{ first_name }}, your {{ event.tierName | default:'membership' }} has been cancelled.

The cancellation will be effective immediately. You are no longer able to use your membership benefits.
```

## "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

```
{{ first_name }}, your {{ event.tierName | default:'membership' }} has been cancelled.

The cancellation will be effective {{ event.cancellationDate | default:'in a few days' }}, 
at the end of your billing period, at which points you no longer have access to your membership benefits.
```

## "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

```
Your membership has been {{ event.tierGradeChange | default:'change' }}d to 
{{ event.newTierName | default:'a new tier' }}. 

Your new membership price is ${{ event.newTierPrice | default:'' }}.
```

## "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

```
Your payment method failed. We'll try again for the next few days. 

To continue being a part of {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }}, please make sure your payment details are up to date.

If your payment isn’t successful on {{ event.lastAttemptDate | default:'the final attempt day' }}, your membership will be cancelled.
```

## "Inveterate: Free Trial Notice" Metric <a href="#inveterate-free-trial-notice-metric" id="inveterate-free-trial-notice-metric"></a>

Triggered when a customer starts their free trial.

### Event Properties <a href="#event-properties-8" id="event-properties-8"></a>

| 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 <a href="#template-example-8" id="template-example-8"></a>

```
Welcome! Enjoy your free trial.

After the trial ends on { event.trialEndDate | default:'' }} you will be charged { event.billProse | default:'' }}. Your subscription will automatically renew until you cancel.
```

## "Inveterate: Free Trial Cancelled" Metric <a href="#inveterate-free-trial-cancelled-metric" id="inveterate-free-trial-cancelled-metric"></a>

Triggered when a member cancels their free trial.

### Event Properties <a href="#event-properties-9" id="event-properties-9"></a>

| Name     | Description                       | Example       | Syntax                             |
| -------- | --------------------------------- | ------------- | ---------------------------------- |
| tierName | Name of tier customer is trialing | `"Acme Gold"` | {{ event.tierName \| default:'' }} |

### Template Example <a href="#template-example-9" id="template-example-9"></a>

```
Your free trial has been cancelled.

We're bummed to see you go. Your trial access ends today, but you can rejoin {{ event.tierName | default:'our membership program' }} at any time.
```

## "Inveterate: Free Trial Ends Soon" Metric <a href="#inveterate-free-trial-ends-soon-metric" id="inveterate-free-trial-ends-soon-metric"></a>

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

### Event Properties <a href="#event-properties-10" id="event-properties-10"></a>

| 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 <a href="#template-example-10" id="template-example-10"></a>

```
Your free trial expires soon on {{ event.trialEndDate | default:'' }}.

After the trial ends on you will be charged {{ event.billProse | default:'' }}. Your subscription will automatically renew until you cancel.
```

## "Inveterate: Free Trial Ended" Metric <a href="#inveterate-free-trial-ended-metric" id="inveterate-free-trial-ended-metric"></a>

Triggered when a customer's free trial ends.

### Event Properties <a href="#event-properties-11" id="event-properties-11"></a>

| 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 <a href="#template-example-11" id="template-example-11"></a>

```
Your trial has ended. Enjoy your full access from Acme! You will be charged {{ event.billProse | default:'' }}. Your subscription will automatically renew until you cancel.
```

## "Inveterate: Birthday Credits" Metric

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

### Event Properties <a href="#event-properties-11" id="event-properties-11"></a>

| 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 <a href="#template-example-11" id="template-example-11"></a>

```
Happy Birthday, {{ first_name }}!
We couldn’t let your special day pass without a little something from us. As a thank-you for being part of {{ person | lookup:'Inveterate: Tier Name' | default:'our membership program' }}, we’ve added ${{ event.creditsAwarded | default:'a reward' }} in store credits to your account!

You now have ${{ event.newCreditsBalance | default:'more' }} in store credits to spend. Treat yourself — your birthday gift is ready anytime in your member portal.
```

## "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 <a href="#event-properties-11" id="event-properties-11"></a>

| 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' }}`          |
| <p><code>lookbackCreditsDay</code><br>or<br><code>lookbackCreditsDays</code></p> | Number of days (or day) the customer has to join and receive the credits | 1, 7, 14    | `{{ event.lookbackCreditsDays \| default:'0' }}` |

### Template Example <a href="#template-example-11" id="template-example-11"></a>

```
You could receive ${{ event.potentialCredits | default:'0' }} in credits by joining our {{ event.tierName | default:'' }} membership.

Join within {{ event.lookbackCreditsDays | default:'0' }} day(s) to claim your credits.

Your recent order total was ${{ event.orderTotal | default:'0' }}.

Thanks,
Acme Incorporated
```