Recharge metrics and properties in Klaviyo
Klaviyo V2 is a powerful third-party app that Recharge directly integrates with, allowing you to take your customer notifications to the next level. This guide covers building email flows using Recharge and Klaviyo.
- Recharge Checkout on BigCommerce
- Recharge Checkout on Shopify
- Shopify Checkout Integration
Build email flows
Create marketing flows in Klaviyo to grow your business, or you can create Transactional flows in Klaviyo that replace customer notifications in Recharge. These flows use Recharge metrics as a trigger and are sent out to customers when specific events happen on Recharge.
Metrics are used to identify specific events and provide line-item details around that event. For example, a customer going through the checkout is considered an event and the “Subscription started on ReCharge” metric is triggered. These metrics can then be used as triggers when building Klaviyo flows.
To use any of the property variables in your Klaviyo email, add
event. at the beginning of the syntax to the variable. The variable will not render in your email without this included. Here are some syntax examples:
- To use the cancellation_reason property in a Klaviyo email for the Subscription Started on Recharge metric, the needed format is
{{ event.cancellation_reason }}. - To add the schedule_at property in a Klaviyo email for the Order upcoming on ReCharge metric, the required formatting is
{{ event.scheduled_at }}.
Recharge metrics in Klaviyo
The following metrics are available in Klaviyo:
Recharge metric in Klaviyo |
Triggered by |
Example |
|
Started Checkout (available for the Recharge Checkout on Shopify or BigCommerce)
Note: Shopify Checkout Integration merchants can use the “Started Checkout” metric, which is managed by Shopify.
|
This metric is triggered as soon as a customer or potential customer enters their email at the checkout. This metric is typically used to create abandoned cart emails, although the metric is fired even if a customer successfully checks out. Refer to Klaviyo’s guide on setting up an abandoned cart flow for more information. |
A customer receives an email after they make it to the first page of the checkout, but do not complete their first order. This email may contain a discount encouraging the customer to finish their purchase. |
| This metric is triggered when a subscription is added to a customer’s account through the checkout or customer portal, via the API, or added to the account by you, the merchant. |
A customer is sent a “Welcome to the team” email after subscribing to a new product for the first time. |
|
|
This metric is triggered in Klaviyo a certain number of days before an upcoming charge. By default, the “Order upcoming on ReCharge” metric is sent to Klaviyo 3 days prior to a recurring charge. Contact the Recharge Support team if you wish to adjust this, or add a Time Delay to your flow if you would like the actual action to take place on the metric at a later date. |
A customer receives an email three days before their next subscription order, allowing them to still make changes if necessary.
|
|
|
This metric is triggered before a prepaid shipment subscription is about to be sent out. By default, this metric is triggered and the email notification is sent three days in advance of the order. Contact the Recharge Support team if you would like to change the time between notification and order. |
A customer is sent an upcoming order notification to let them know that they can skip their next order if they already have enough product. |
|
|
This metric is triggered when a subscription is canceled by you in the merchant admin, via the API, by the customer in the customer portal, or by the Recharge support team via our bulk cancelation tool. |
An email is sent to customers confirming that their cancelation was successful. |
|
|
This metric is triggered when a subscription expires after having been set to auto-expire. The “Subscription expired on ReCharge” metric is only sent to Klaviyo if the subscription expires after two or more charges. You can set a subscription rule to expire after a set number of charges, which auto-cancels the subscription for a customer. |
An email is sent to customers letting them know they completed their two required charges, and their subscription has been canceled. |
|
|
This metric is triggered when a customer reactivates a canceled subscription. |
An email is sent to customers once they reactive their subscription to welcome them back with a discount. |
|
|
This metric is triggered when a new bundle selection record is created. This occurs when a new bundle subscription is created and when new selections are created after an automatic reset. |
A confirmation email displaying the customer's bundle selections is sent after purchasing a bundle. |
|
|
This metric is triggered when an existing bundle select record is updated in the customer portal. |
A confirmation email displaying the customer's updated bundle selections is sent after updating a bundle in the customer portal. |
|
|
This metric is triggered whenever a credit adjustment is created on an associated credit account. |
A confirmation or SMS message displaying the customer's store credit balance after a credit adjustment is created on an associated credit account. |
|
|
This metric is triggered whenever a customer pauses their subscription. |
A confirmation email displaying the customer's subscription is paused. |
|
| This metric is triggered when a membership is added to a customer’s account through the checkout or customer portal, via the API, or the merchant portal. | A customer is sent a Welcome email after signing up for a membership. | |
| Membership expired on Recharge | This metric is triggered when a membership expires. | An email is sent to customers letting them know their membership has expired. |
| Membership cancelled on Recharge | This metric is triggered when a membership is canceled in the merchant admin, via the API, by the customer in the customer portal, or by the Recharge support team via our bulk cancelation tool. | An email is sent to customers confirming that their cancelation was successful. |
| Recharge membership reactivated | This metric is triggered when a customer reactivates a canceled membership. | An email is sent to customers once they reactive their membership to welcome them back. |
| Member pricing removed from subscription on Recharge | This metric is triggered when the member pricing discount is removed from a customer's recurring subscription because their membership expires. |
An email is sent to let a customer know that their member pricing has been removed from a subscription. Note: This notification will only be sent when member pricing is removed from an active subscription. |
| Charge processing failed on ReCharge | This metric is triggered when charge processing fails and addresses the specific reason for the failed payment. | An email is sent to let a customer know that their charge processing has failed due to an expired card. |
| Order placed successfully on Recharge | This metric is triggered when an order successfully processes through checkout and recurring orders. | An email is sent to let a customer know that their order was placed successfully. |
| Subscription SKU swapped on Recharge | This metric is triggered when a SKU is swapped on Recharge. | An email is sent to let a customer know that SKU was successfully swapped. |
| One-time product added on Recharge | This metric is triggered when a one-time product is added to an order. | An email is sent to let a customer know they successfully added a one-time product. |
| One-time product deleted on Recharge | This metric is triggered when a one-time product is removed from an order. | An email is sent to let a customer know the one-time product was removed from their order. |
| Subscription next charge date changed on Recharge |
This metric is triggered when an individual subscription's next charge date is rescheduled. If a customer updates multiple subscriptions charge dates, an individual metric will trigger for each subscription. |
An email is sent to let a customer know that their next charge date has changed. |
Recharge Quick Actions URLs can be included within specific Klaviyo flows when using Klaviyo V2. This allows you to send links to your customers and make it easier for them to perform actions on their subscriptions. See Setting up Quick Actions in Klaviyo for more information.
Data sync
Metrics only appear in Klaviyo once all three of the following events occur:
- You’ve gained access to the new feature
- Klaviyo has been integrated with Recharge
- The specific event has occurred on your store
For example, if a customer canceled their subscription before you integrated with Klaviyo, the "Subscription cancelled on ReCharge" metric would not be available in Klaviyo. The "Subscription cancelled on ReCharge" metric is only displayed if a customer cancels their subscription from the customer portal after integrating with Klaviyo.
Subscription started on ReCharge
The “Subscription started on ReCharge” metric is triggered when a customer successfully purchases a new subscription product saved on Recharge. This metric can be used to send subscription activation emails to customers.
The “Subscription started on ReCharge” metric contains the following properties:
Available properties
Property passed |
Value |
Notes |
Trigger filter availability |
| Subscription started on ReCharge Value |
Number Example: 27.0 |
Displays the dollar amount for the price of the subscription. | Not available |
|
cancellation_reason |
None |
Indicates that the subscription has not been canceled. |
Available |
| external_product_id |
A unique string of numbers Example: 3259148107881 |
Displays the product id as provided by your ecommerce platform. |
Available |
|
external_variant_id |
A unique string of numbers Example: 72935012501510 |
Displays the variant id as provided by your ecommerce platform. |
Available |
|
extra |
A unique string of numbers Example: 13252151 |
Displays the customer’s subscription ID. |
Not available |
| is_prepaid |
True or false |
Confirms if the customer purchased a prepaid subscription. | Available |
|
is_skippable |
True or false |
Confirms if the customer can skip their next charge. |
Available |
|
is_swappable |
True or false |
Confirms if the customer can swap the product on their next charge. |
Available |
| item |
Text Example: Coffee subscription |
Displays the subscription item. |
Available |
| next_charge_scheduled_at |
Date and time Example: March 27, 2021, at 11:11 PM |
Displays the date and time of the customer’s next scheduled charge. |
Available |
| order_interval_days | Number |
Displays the number of days in between charges. |
Available |
|
order_interval_frequency |
Number |
Displays the frequency in between charges. |
Available |
| order_interval_unit |
Day, week, or month |
Displays the subscription frequency type. |
Available |
| price |
Number Example: 27.0 |
Displays the subscription price. |
Available |
| product_id |
A unique string of numbers Example: 72935012501510 |
Displays the product ID assigned to the product by your ecommerce platform. |
Available |
|
product_title |
Text Example: Coffee subscription |
Displays the name of the subscription product purchased. | Available |
|
recharge_product_id |
A unique string of numbers Example: 25415152414 |
Displays the product ID assigned by Recharge. |
Available |
|
sku |
A unique string of numbers Example: 1324215215215 |
Displays the SKU assigned to the product in your ecommerce platform. | Available |
| status |
“ACTIVE” |
Displays that the subscription is active. |
Available |
|
subscription_id |
A unique string of numbers Example: 773736262 |
Displays the subscription ID assigned by Recharge. |
Available |
|
variant |
Text Example: Red |
Displays the variant title name for the product. |
Available |
|
variant_id |
A unique string of numbers Example: 773736262 |
Displays the variant ID assigned to the product by your ecommerce platform. |
Available |
| order_upcoming_number |
A unique string of numbers Example: 4 |
Displays the upcoming order number. |
Available |
| product_image_url_med |
The product image URL. Example: //cdn.shopify.com/s/files/1/0000/0001/t/1/assets/logo.png |
Displays the URL for the product image. |
Available |
|
is_bundle |
True or false |
Confirms if the subscription is a bundle. |
Available |
|
is_customizable |
True or false |
Confirms if the bundle is customizable. False indicates that the bundle is pre-set. |
Available |
|
currency_code_symbol |
Currency symbol Example: $ |
Displays the currency symbol. |
Not available |
|
customer_charge_currency |
Currency code Example: USD |
Displays the currency code. |
Not available |
Order upcoming on ReCharge and Order upcoming (prepaid) on ReCharge
The “Order upcoming on ReCharge” and the “Order upcoming (prepaid) on ReCharge” metrics are triggered when a queued order is created for a customer.
The following transactional emails can be created using the “Order upcoming on ReCharge and Order upcoming (prepaid) on ReCharge” metrics:
- Manage subscription: Remind customers to manage their subscription before their upcoming charge or provide customers with options to swap or skip their upcoming orders by leveraging Quick Actions URLs.
- Upsell offerings: Include options to add one-time products to an upcoming subscription.
Use the variable {{ event.scheduled_at }} to display the exact charge date in your notifications.
The “Order upcoming on ReCharge” and the “Order upcoming (prepaid) on ReCharge” metrics contains the following properties:
Available properties
Property passed |
Value |
Notes |
| charge_id |
A unique string of letters and numbers Example: 451df17e73c66527 |
Displays the specific charge_id that triggered the metric. |
|
created_at
|
Date and time Example: January 28, 2021 at 07:36 PM |
Displays the date and time for the order. |
|
line_items |
Combination of text and numbers. |
Displays the order information including:
|
|
scheduled_at |
Date and time Example: March 27, 2021, at 11:11 PM |
Displays the scheduled date and time for the upcoming charge. |
|
shipping_address |
Combination of text and numbers. |
Displays the customer’s shipping address. |
| shipping_lines |
Combination of text and numbers. |
Displays information related to the selected shipping method. |
|
status |
“QUEUED” |
Displays the queued status of the order. |
|
subtotal_price |
Number Example: 27.0 |
Displays the price. |
| total_discounts |
Number Example: 10.0 |
Displays any discounts applied to the upcoming order. |
|
total_line_items_price |
Number Example: 27.0 |
Displays the subscription item price before discounts are applied. In ReCharge this is referred to as the subtotal |
| total_price |
Number Example: 17.0 |
Displays the total price including discounts and shipping. |
|
total_tax |
Number Example: 7.0 |
Displays the tax price. |
|
transaction_id |
“NONE” |
No transaction ID available as the order is queued. |
| type |
“RECURRING” |
Displays the type of charge. |
|
updated_at |
Date and time Example: March 27, 2021, at 11:11 PM |
Displays the date when the queued charge was last updated. |
|
line_item_first
Note: Replace
first with any order upcoming number (ie. second or third) to apply the line_items property to an additional order. For example, use line_item_third to apply the property to the third upcoming order. |
|
Displays a list of line item properties related to the customer's upcoming order. Use the details provided with the line_item property to improve the messaging you use with customers. |
| order_upcoming_number |
A unique string of numbers Example: 4 |
Displays the upcoming order number in the customer's series of recurring orders. This is calculated by adding |
| total_unique_line_item_count |
A number Example: 3 |
Displays the number of unique line items in an order. Multiple orders of the exact same item are only counted once. |
| variant_ids |
A list of numbers Example: 132520615, 12391510, 1925105 |
Displays each variant ID that the customer is subscribed to. The variant ID is automatically assigned to a product by Shopify. |
| variant_ids_order_upcoming_number |
A list of numbers Example: 3, 2, 4, 5, 9 |
Displays the upcoming order number for each variant a customer is subscribed to if a next order were to occur. Use the variant_ids_order_upcoming_number property with the variant_id property to create custom flows based on where a customer is at within their subscription lifecycle. |
| has_bundles |
True or false |
Confirms if the order has bundles. |
| bundle_has_oos_selection |
True or false |
Confirms if an order containing a bundle has any out-of-stock bundle contents. The details on which products are out of stock can be found in the customer_selections property in line_items. |
|
currency_code_symbol |
Currency symbol Example: $ |
Displays the currency symbol. |
|
customer_charge_currency |
Currency code Example: USD |
Displays the currency code. |
Notifications using the order upcoming metrics are triggered depending on the date of the customer’s next upcoming charge. A time window is set so that the customer receives the notification and has enough time to manage their subscription before their upcoming charge.
- The date for an upcoming charge is equal to or less than the time window set for the notification
- The notification has not already been sent to the customer
Customers typically receive notifications within the time window set. For example, if a customer has a charge date set for January 30th, and your upcoming charge notifications are set to send to customers five days in advance, your customer would receive their charge notification on January 25th.
Customers may receive an upcoming notification outside of the time window set if the charge date, or the time window to send the notification, is changed.
For example, if a customer had a charge date set for January 30th, the expected upcoming order email would be sent on January 25th based on a five-day time window. If the customer decided on January 15th to change their charge date from January 25th to January 19th, they miss the time window to receive a notification.
To prevent the customer from missing a notification, Recharge checks that each customer within the time window has received a notification for their upcoming order. In this example, the customer would receive a notification on January 16th for their January 19th charge, even though the charge is only three days away.
{{scheduled_at}} in the subject line for upcoming order notifications, ie. “Your upcoming order will ship on {{scheduled_at}} date”, rather than counting down the number of days until the charge, ie. “Your charge is coming up in 5 days”. This prevents customers from receiving incorrect information as to when their next charge will be processed.Charge processing failed on ReCharge
This metric is triggered when charge processing fails and addresses the specific reason for the failed payment. For a list of all possible charge processing errors, see Error messages for charge processing.
This metric can be used to send personalized emails, reduce customer frustration, and increase retention rates.
Available properties
Property |
Value |
Notes |
| charge_attempts | Number | The number of times a payment processor tries to charge a customer’s payment method. |
| charge_id | A unique string of numbers | Displays the specific charge_id that triggered the metric. |
| created_at | Date and time |
Date and time the charge was initially created. This automatically converts to the timezone configured in your Klaviyo settings. |
| currency_code_symbol | Currency symbol | Currency code symbol for the charge presentment currency. |
| error_type | Text | Reason for charge processing failure. |
| line_item_first | The following values are passed:
|
Displays a list of line item properties related to the customer's upcoming order. Use the details provided with the line_item property to improve the messaging you use with customers. |
| line_items |
The following values are passed:
|
Displays the order information including the SKU, Product ID, weight, bundle properties, and title. |
| order_upcoming_number |
Number |
Displays the upcoming order number in the customer's series of recurring orders associated with the address ID the charge lives under. |
| retry_date |
Date and time |
The date the next charge attempt will take place. If blank, it is because the error_type isn’t automatically retried. This automatically converts to the timezone configured in your Klaviyo settings. |
| scheduled_at |
Date and time |
This automatically converts to the timezone configured in your Klaviyo settings. |
| shipping_address |
Text and numbers |
|
| shipping_lines |
Text |
Displays information related to the selected shipping method. |
| status |
Text |
Displays the status of the queued order. |
| total_discounts |
Text |
Displays any discounts applied to the upcoming order. |
| total_line_items_price |
Number |
Displays the subscription item price before discounts are applied. In Recharge, this is referred to as the subtotal. |
| total_price |
Number |
Displays the total price including discounts and shipping. |
| total_tax |
Number |
Displays the tax price. |
| total_unique_line_item_count |
Number |
Displays the number of unique line items in an order. Multiple orders of the exact same item are only counted once. |
| type |
Text |
Displays type of charge. |
| updated_at |
Date and time |
Displays the date when the queued charge was last updated. This automatically converts to the timezone configured in your Klaviyo settings. |
| variant_ids |
Unique string of numbers |
Displays each variant ID that is associated with this charge ID. The variant ID is automatically assigned to a product by Shopify. |
| variant_ids_order_upcoming_number |
Number |
Displays the upcoming order number for each variant a customer is subscribed to if a next order were to occur. Use the variant_ids_order_upcoming_number property with the variant_id property to create custom flows based on where a customer is at within their subscription lifecycle. |
Error messages for charge processing
When a charge processing failed metric is triggered due to an error, Recharge can send customer-related charge processing errors to Klaviyo. The error type can be used as a trigger filter in your Klaviyo flow to send customized emails to customers based on the error type. This will allow you to provide clarity and improve customer retention.
The following table contains possible error messages, a description of each, and whether or not the error message requires action:
Available error messages
Error message |
Description |
Action required |
| BILLING_ADDRESS_ERROR | The payment gateway informed us that the billing address didn’t match the billing address on file for this payment method. | Yes, we recommend sending a Quick Actions link to the payment methods page. |
| CARD_DECLINED | The payment gateway informed us that the customer’s payment method was declined, for reasons unknown to us. |
No, retried daily, regardless of the charge retry settings configured in the Recharge merchant portal. Optional - You can suggest the customer updates the payment method if they know why the card was declined. |
| CARD_EXPIRED | The payment gateway informed us that the customer’s payment method has expired and can no longer be used. The customer must replace it with a new, valid payment method. | Yes, we recommend sending a Quick Actions link to the payment methods page. |
| CARD_ZIPCODE_FAILED_VALIDATION | The payment gateway informed us the zipcode doesn’t match the billing zipcode on file for this payment method. | Yes, we recommend sending a Quick Actions link to the payment methods page. |
| CARDNUMBER_INCORRECT | The payment gateway informed us that the customer’s card number is incorrect and can no longer be used. The customer must replace it with a new, valid payment method. | Yes, we recommend sending a Quick Actions link to the payment methods page. |
| CUSTOMER_NEEDS_TO_UPDATE_CARD | The payment gateway informed us that the customer’s payment method can no longer be used. The customer must replace it with a new, valid payment method. | Yes, we recommend sending a Quick Actions link to the payment methods page. |
| EXPIRED_PAYMENT_METHOD | The payment gateway informed us that the customer’s credit card has expired and can no longer be used. The customer must replace it with a new, valid payment method. | Yes, we recommend sending a Quick Actions link to the payment methods page. |
| INSUFFICIENT_FUNDS | The payment gateway informed us that the customer's credit card has expired and can no longer be used. |
No, retried daily, regardless of the charge retry settings configured in the Recharge merchant portal. Optional - You can suggest the customer updates the payment method if they know why the card was declined. |
| INVALID_PAYMENT_METHOD | The payment gateway informed us that the payment method that was attempted is no longer valid. The customer must replace it with a new, valid payment method. |
Yes, we recommend sending a Quick Actions link to the payment methods page. |
| PAYMENT_METHOD_NOT_FOUND | The payment gateway informed us that the customer’s payment method is no longer available. The customer must replace it with a new, valid payment method. |
Yes, but actions may differ by Recharge platform:
|
| PURCHASE_TYPE_NOT_SUPPORTED_BY_CARD | The payment gateway informed us that the customer's payment method does not allow this type of purchase. The customer much reach out to their bank or use a different payment method. |
Yes, we recommend sending a Quick Actions link to the payment methods page. |
| CLOSED_MAX_RETRIES_REACHED | Recharge has attempted to charge the customer the maximum number of times. For more information, see Managing max retry order errors. The customer must provide a different payment method. Once a new payment method is added, the order will be automatically retried. |
Yes, we recommend sending a Quick Actions link to the payment methods page. |
Subscription cancelled on ReCharge
The “Subscription cancelled on ReCharge” metric is triggered when a customer cancels their subscription on Recharge. This metric can be used to create Winback messages and target customers who have canceled their subscriptions.
The “Subscription cancelled on ReCharge” metric contains the following properties:
Available properties
Property passed |
Value |
Notes |
Trigger filter availability |
| Subscription cancelled on ReCharge Value |
Number Example: 27.0 |
Displays the dollar amount for the price of the subscription. |
Not available
|
|
cancellation_reason |
None |
Indicates that the subscription has not been canceled. |
Available |
|
created_at |
Date and time Example: January 28, 2021 at 07:36 PM |
Displays the date and time the subscription was created. |
Not available |
| external_product_id |
A unique string of numbers Example: 3259148107881 |
Displays the product id as provided by your ecommerce platform. |
Available |
|
external_variant_id |
A unique string of numbers Example: 72935012501510 |
Displays the variant id as provided by your ecommerce platform. |
Available |
|
extra |
A unique string of numbers Example: 13252151 |
Displays the subscription ID assigned by Recharge. |
Not available |
| is_prepaid |
True or false |
Confirms if the customer purchased a prepaid subscription. | Available |
|
is_skippable |
True or false |
Confirms if the customer can skip their next charge. |
Available |
|
is_swappable |
True or false |
Confirms if the customer can swap the product on their next charge. |
Available |
| item |
Text Example: Coffee subscription |
Displays the subscription product purchased. |
Available |
| next_charge_scheduled_at |
None |
No next charge date to display as the charge is canceled. |
Available |
| order_interval_days | Number |
Displays the number of days in between charges. |
Available |
|
order_interval_frequency |
Number |
Displays the frequency in between charges. |
Available |
| order_interval_unit |
Day, week, or month |
Displays the subscription frequency type. |
Available |
| price |
Number Example: 27.0 |
Displays the subscription price. |
Available |
| product_id |
A unique string of numbers Example: 72935012501510 |
Displays the product ID assigned to the product by your ecommerce platform. |
Available |
|
product_title |
Text Example: Coffee subscription |
Displays the name of the subscription product purchased. | Available |
|
recharge_product_id |
A unique string of numbers Example: 25415152414 |
Displays the product ID assigned by Recharge. |
Available |
|
sku |
A unique string of numbers Example: 1324215215215 |
Displays the SKU assigned to the product in your ecommerce platform. | Available |
| status |
“CANCELLED” |
Displays that the subscription is active. |
Available |
|
subscription_id |
A unique string of numbers Example: 773736262 |
Displays the subscription ID assigned by Recharge. |
Available |
|
variant |
Text Example: Red |
Displays the variant title name for the product. |
Available |
|
variant_id |
A unique string of numbers Example: 773736262 |
Displays the variant ID assigned to the product by your ecommerce platform. |
Available |
| product_image_url_med |
The product image URL. Example: //cdn.shopify.com/s/logo.png |
Displays the URL for the product image. |
Not available |
| order_upcoming_number |
A unique string of numbers Example: 4 |
Displays the upcoming order number if a next order were to occur (ie. the customer reactivates). This is calculated by adding Use this property to send custom messages to customers who are reactivating after a set number of charges. For example, you may want to offer a discount to a customer who already had 20 orders processed in the past. |
Available |
| is_bundle |
True or false |
Confirms if the subscription is a bundle. |
Available |
| is_customizable |
True or false |
Confirms if the bundle is customizable. False indicates that the bundle is pre-set. |
Available |
|
customer_selections |
Combination of text and numbers including the quantity, ID, product, and variant for each bundle component |
Displays the bundle contents if they were selected by the customer. If the bundle is preset, this property is empty. If the customer makes selections, this property contains the bundle contents. |
Not available |
|
fallback_selections |
Combination of text and numbers including the quantity, ID, product, and variant for each bundle component |
Displays the fallback contents set for the bundle. If the bundle is preset, this property displays the preset bundle contents. If fallback settings are set and the customer does not make selections, this property contains the bundle contents. |
Not available |
| bundle_has_oos_selection |
True or false |
Confirms if an order containing a bundle has any out-of-stock bundle contents. The details on which products are out of stock can be found in the customer_selections property in line_items. |
Available |
|
currency_code_symbol |
Currency symbol Example: $ |
Displays the currency symbol. |
Not available |
|
customer_charge_currency |
Currency code Example: USD |
Displays the currency code. |
Not available |
Subscription expired on ReCharge
The “Subscription expired on ReCharge” metric is pushed to Klaviyo from Recharge when a customer’s subscription is cancelled due to expiration. While expired subscriptions are set to “cancelled” we pass a separate metric because these cancellations happen automatically due to a product rules setting.
Available properties
Property passed |
Value |
Notes |
Trigger filter availability |
|
Subscription expired on ReCharge Value |
Number Example: 27.0 |
Displays the dollar amount for the price of the subscription. |
Not available |
|
cancellation_reason |
None |
The value will always be none on expired subscriptions as it’s an automated cancellation. |
Available |
|
expire_after_specific_number_of_charges |
Number Example: 2 |
The value will always be 2 or more. Subscriptions that expire with less than 1 charge will not trigger this metric. |
Available |
|
external_product_id |
A unique string of numbers Example: 35626265151166 |
Displays the variant id as provided by your ecommerce platform. |
Available |
|
external_variant_id |
A unique string of numbers Example: 72935012501510
|
Displays the variant id as provided by your ecommerce platform. |
Not available |
| extra |
A unique string of numbers Example: 773736262 |
Displays the subscription ID assigned by Recharge. |
Not available |
|
is_prepaid |
True or false |
Confirms if the customer purchased a prepaid subscription. |
Available |
| is_skippable |
True or false |
Confirms if the customer can skip their next charge. |
Available |
|
is_swappable |
True or false |
Confirms if the customer can swap the product on their next charge. |
Available |
| item |
Text Example: Coffee subscription |
Displays the subscription product purchased. |
Available |
| next_charge_scheduled_at |
None |
No next charge date to display as the charge is canceled. |
Available |
| order_interval_days | Number |
Displays the number of days in between charges. |
Available |
|
order_interval_frequency |
Number |
Displays the frequency in between charges. |
Available |
| order_interval_unit |
Day, week, or month |
Displays the subscription frequency type. |
Available |
| price |
Number Example: 27.0 |
Displays the subscription price. |
Available |
| product_id |
A unique string of numbers Example: 72935012501510 |
Displays the product ID assigned to the product by your ecommerce platform. |
Available |
|
product_title |
Text Example: Coffee subscription |
Displays the name of the subscription product purchased. | Available |
|
recharge_product_id |
A unique string of numbers Example: 25415152414 |
Displays the product ID assigned by Recharge. |
Available |
|
sku |
A unique string of numbers Example: 1324215215215 |
Displays the SKU assigned to the product in your ecommerce platform. | Available |
| status |
“CANCELLED” |
Displays that the subscription is active. |
Available |
|
subscription_id |
A unique string of numbers Example: 773736262 |
Displays the subscription ID assigned by Recharge. |
Available |
|
variant |
Text Example: Red |
Displays the variant title name for the product. |
Available |
|
variant_id |
A unique string of numbers Example: 773736262 |
Displays the variant ID assigned to the product by your ecommerce platform. |
Available |
| product_image_url_med |
The product image URL. Example: //cdn.shopify.com/s/logo.png |
Displays the URL for the product image. |
Not available |
| order_upcoming_number |
A unique string of numbers Example: 4 |
Displays the upcoming order number if a next order were to occur (ie. the customer reactivates). This is calculated by adding Use this property to send custom messages to customers who are reactivating after a set number of charges. For example, you may want to offer a discount to a customer who already had 20 orders processed in the past. |
Available |
| is_bundle |
True or false |
Confirms if the subscription is a bundle. |
Available |
| is_customizable |
True or false |
Confirms if the bundle is customizable. False indicates that the bundle is pre-set. |
Available |
|
customer_selections |
Combination of text and numbers including the quantity, ID, product, and variant for each bundle component |
Displays the bundle contents if they were selected by the customer. If the bundle is preset, this property is empty. If the customer makes selections, this property contains the bundle contents. |
Not available |
|
fallback_selections |
Combination of text and numbers including the quantity, ID, product, and variant for each bundle component |
Displays the fallback contents set for the bundle. If the bundle is preset, this property displays the preset bundle contents. If fallback settings are set and the customer does not make selections, this property contains the bundle contents. |
Not available |
|
currency_code_symbol |
Currency symbol Example: $ |
Displays the currency symbol. |
Not available |
|
customer_charge_currency |
Currency code Example: USD |
Displays the currency code. |
Not available |
Subscription paused on ReCharge
This metric is triggered whenever a customer pauses their subscription and can be used to send paused subscription confirmation emails to customers. You must have the Pause subscriptions feature enabled to use this metric.
The “Subscription paused on ReCharge” metric contains the following properties:
Available properties
Property passed |
Value |
Notes |
Trigger filter availability |
| Subscription paused on ReCharge Value |
Number Example: 27.0 |
Displays the dollar amount for the price of the subscription. | Not available |
|
cancellation_reason |
None |
Indicates that the subscription has not been canceled. |
Available |
| external_product_id |
A unique string of numbers Example: 3259148107881 |
Displays the product id as provided by your ecommerce platform. |
Available |
|
external_variant_id |
A unique string of numbers Example: 72935012501510 |
Displays the variant id as provided by your ecommerce platform. |
Available |
|
extra |
A unique string of numbers Example: 13252151 |
Displays the customer’s subscription ID. |
Not available |
| is_prepaid |
True or false |
Confirms if the customer purchased a prepaid subscription. | Available |
|
is_skippable |
True or false |
Confirms if the customer can skip their next charge. |
Available |
|
is_swappable |
True or false |
Confirms if the customer can swap the product on their next charge. |
Available |
| item |
Text Example: Coffee subscription |
Displays the subscription product purchased. |
Available |
| next_charge_scheduled_at |
Date and time Example: March 27, 2021, at 11:11 PM |
Displays the date and time of the customer’s next scheduled charge. |
Available |
| order_interval_days | Number |
Displays the number of days in between charges. |
Available |
|
order_interval_frequency |
Number |
Displays the frequency in between charges. |
Available |
| order_interval_unit |
Day, week, or month |
Displays the subscription frequency type. |
Available |
| price |
Number Example: 27.0 |
Displays the subscription price. |
Available |
| product_id |
A unique string of numbers Example: 72935012501510 |
Displays the product ID assigned to the product by your ecommerce platform. |
Available |
|
product_title |
Text Example: Coffee subscription |
Displays the name of the subscription product purchased. | Available |
|
recharge_product_id |
A unique string of numbers Example: 25415152414 |
Displays the product ID assigned by Recharge. |
Available |
|
sku |
A unique string of numbers Example: 1324215215215 |
Displays the SKU assigned to the product in your ecommerce platform. | Available |
| status |
“ACTIVE” |
Displays that the subscription is active. |
Available |
|
subscription_id |
A unique string of numbers Example: 773736262 |
Displays the subscription ID assigned by Recharge. |
Available |
|
variant |
Text Example: Red |
Displays the variant title name for the product. |
Available |
|
variant_id |
A unique string of numbers Example: 773736262 |
Displays the variant ID assigned to the product by your ecommerce platform. |
Available |
| order_upcoming_number |
A unique string of numbers Example: 4 |
Displays the upcoming order number. |
Available |
| product_image_url_med |
The product image URL. Example: //cdn.shopify.com/s/files/1/0000/0001/t/1/assets/logo.png |
Displays the URL for the product image. |
Available |
|
is_bundle |
True or false |
Confirms if the subscription is a bundle. |
Available |
|
is_customizable |
True or false |
Confirms if the bundle is customizable. False indicates that the bundle is pre-set. |
Available |
|
currency_code_symbol |
Currency symbol Example: $ |
Displays the currency symbol. |
Not available |
|
customer_charge_currency |
Currency code Example: USD |
Displays the currency code. |
Not available |
|
next_charge_scheduled_at |
Date and time Example: March 27, 2021, at 11:11 PM |
Displays the date and time of the customer’s next scheduled charge. |
Not available |
Recharge subscription reactivated
The “Recharge subscription reactivated” metric is triggered when a customer reactivates their subscription on Recharge.
The “Recharge subscription reactivated” metric contains the following properties:
Available properties
Property passed |
Value |
Notes |
Trigger filter availability |
| Subscription cancelled on ReCharge Value |
Number Example: 27.0 |
Displays the dollar amount for the price of the subscription. |
Not available
|
|
cancellation_reason |
None |
Indicates that the subscription has not been canceled. |
Available |
| external_product_id |
A unique string of numbers Example: 3259148107881 |
Displays the product id as provided by your ecommerce platform. |
Available |
|
external_variant_id |
A unique string of numbers Example: 72935012501510 |
Displays the variant id as provided by your ecommerce platform. |
Available |
|
extra |
A unique string of numbers Example: 13252151 |
Displays the subscription ID assigned by Recharge. |
Not available |
| is_prepaid |
True or false |
Confirms if the customer purchased a prepaid subscription. | Available |
|
is_skippable |
True or false |
Confirms if the customer can skip their next charge. |
Available |
|
is_swappable |
True or false |
Confirms if the customer can swap the product on their next charge. |
Available |
| item |
Text Example: Coffee subscription |
Displays the subscription product purchased. |
Available |
| next_charge_scheduled_at |
None |
No next charge date to display as the charge is canceled. |
Available |
| order_interval_days | Number |
Displays the number of days in between charges. |
Available |
|
order_interval_frequency |
Number |
Displays the frequency in between charges. |
Available |
| order_interval_unit |
Day, week, or month |
Displays the subscription frequency type. |
Available |
| price |
Number Example: 27.0 |
Displays the subscription price. |
Available |
| product_id |
A unique string of numbers Example: 72935012501510 |
Displays the product ID assigned to the product by your ecommerce platform. |
Available |
|
product_title |
Text Example: Coffee subscription |
Displays the name of the subscription product purchased. | Available |
|
recharge_product_id |
A unique string of numbers Example: 25415152414 |
Displays the product ID assigned by Recharge. |
Available |
|
sku |
A unique string of numbers Example: 1324215215215 |
Displays the SKU assigned to the product in your ecommerce platform. | Available |
| status |
“CANCELLED” |
Displays that the subscription is active. |
Available |
|
subscription_id |
A unique string of numbers Example: 773736262 |
Displays the subscription ID assigned by Recharge. |
Available |
|
variant |
Text Example: Red |
Displays the variant title name for the product. |
Available |
|
variant_id |
A unique string of numbers Example: 773736262 |
Displays the variant ID assigned to the product by your ecommerce platform. |
Available |
| product_image_url_med |
The product image URL. Example: //cdn.shopify.com/s/logo.png |
Displays the URL for the product image. |
Not available |
| order_upcoming_number |
A unique string of numbers Example: 4 |
Displays the upcoming order number if a next order were to occur (ie. the customer reactivates). This is calculated by adding Use this property to send custom messages to customers who are reactivating after a set number of charges. For example, you may want to offer a discount to a customer who already had 20 orders processed in the past. |
Available |
| is_bundle |
True or false |
Confirms if the subscription is a bundle. |
Available |
| is_customizable |
True or false |
Confirms if the bundle is customizable. False indicates that the bundle is pre-set. |
Available |
|
customer_selections |
Combination of text and numbers including the quantity, ID, product, and variant for each bundle component |
Displays the bundle contents if they were selected by the customer. If the bundle is preset, this property is empty. If the customer makes selections, this property contains the bundle contents. |
Not available |
|
fallback_selections |
Combination of text and numbers including the quantity, ID, product, and variant for each bundle component |
Displays the fallback contents set for the bundle. If the bundle is preset, this property displays the preset bundle contents. If fallback settings are set and the customer does not make selections, this property contains the bundle contents. |
Not available |
| bundle_has_oos_selection |
True or false |
Confirms if an order containing a bundle has any out-of-stock bundle contents. The details on which products are out of stock can be found in the customer_selections property in line_items. |
Available |
|
currency_code_symbol |
Currency symbol Example: $ |
Displays the currency symbol. |
Not available |
|
customer_charge_currency |
Currency code Example: USD |
Displays the currency code. |
Not available |
Started Checkout
The "Started Checkout" metric is pushed to Klaviyo from Recharge when a customer accesses the Recharge checkout and enters his/her email address. Started Checkout events are synced in real-time.
The “Started Checkout” metric contains the following properties:
Available properties
Property passed |
Value |
Notes |
Trigger filter availability |
|
Started Checkout Value |
Dollar amount Example: 27.0 |
Displays the amount the customer would have spent if they completed their purchase. |
Not available |
|
ItemName |
Text |
Lists the items that the customer attempted to check out with. |
Available |
|
Items
|
Name: Name of the item SKU: SKU of the item Product URL: Link to the item's product page Quantity: Quantity of the item included ItemPrice: Price of the item RowTotal: Price of the item * the quantity included ImageURL: Link to the item's image |
Displays items in the checkout. |
Available |
Bundle Selection created on ReCharge
The "Bundle Selection created on ReCharge" metric s triggered when a new bundle selection record is created and when new selections are created after an automatic reset.
The "Bundle Selection created on ReCharge" metric contains the following properties:
Available properties
Property passed |
Value |
Notes |
Trigger filter availability |
| bundle_selection_id | Number, integer | Displays the ID of the bundle selection record. | Available |
| external_product_id | Number, integer | Displays the parent product ID as it appears in the external ecommerce platform. | Available |
| external_variant_id | Number, integer | Displays the parent product variant ID as it appears in the external ecommerce platform. | Available |
| product_handle | String | Displays the handle of the parent product as it appears in the external ecommerce platform. | Available |
| product_image | String |
Displays the image of the parent product as it appears in the external ecommerce platform. If multiple images exist, this displays the image with the oldest upload date. |
Not available |
| product_title | String |
Displays the title of the parent product as it appears in the external ecommerce platform. |
Available |
| subscription_id | Number, integer |
Displays the subscription ID of the bundle. |
Available |
| items | Combination of text and numbers |
Displays the items in the bundle including the product and variant IDs, quantity, inventory, image, product title, and handle. |
Not available |
Bundle Selection updated on ReCharge
The "Bundle Selection updated on ReCharge" metric is triggered when an existing bundle selection record is updated in the customer portal.
The "Bundle Selection updated on ReCharge" metric contains the following properties:
Available properties
Property passed |
Value |
Notes |
Trigger filter availability |
| bundle_selection_id | Number, integer | Displays the ID of the bundle selection record. | Available |
| external_product_id | Number, integer | Displays the parent product ID as it appears in the external ecommerce platform. | Available |
| external_variant_id | Number, integer | Displays the parent product variant ID as it appears in the external ecommerce platform. | Available |
| product_handle | String | Displays the handle of the parent product as it appears in the external ecommerce platform. | Available |
| product_image | String |
Displays the image of the parent product as it appears in the external ecommerce platform. If multiple images exist, this displays the image with the oldest upload date. |
Not available |
| product_title | String |
Displays the title of the parent product as it appears in the external ecommerce platform. |
Available |
| subscription_id | Number, integer |
Displays the subscription ID of the bundle. |
Available |
| items | Combination of text and numbers |
Displays the items in the bundle including the product and variant IDs, quantity, inventory, image, product title, and handle. |
Not available |
Credit Adjustment created on Recharge
The "Credit Adjustment created on Recharge" metric is triggered when a credit adjustment is created on an associated credit account. At this time, this is triggered by a manual credit adjustment using the Store Credit feature. This metric can be used to send credit adjustment notifications to customers.
The "Credit Adjustment updated on Recharge" metric contains the following properties:
Available properties
Property passed |
Value |
Notes |
Trigger filter availability |
| amount | Number | Displays the amount for the credit adjustment. | Available |
| currency_code |
Text Example: USD |
Displays the currency code of the credit adjustment. | Available |
| ending_balance | Number | Displays the ending balance of the credit adjustment. | Available |
| type |
Text Valid values:
|
Displays the type of credit adjustment on the credit account. | Available |
Membership started on Recharge
This metric is triggered when a membership is added to a customer’s account through the checkout or customer portal, via the API, or the merchant portal.
Available properties
Property |
Value |
Notes |
| membership_next_renewal_date | Date and time | Displays the date and time of the customer’s next scheduled membership renewal date. |
| membership_expiration_date | Date and time | Displays the date and time of the customer's membership expiration date. |
| membership_has_subscription | True or false | Confirms the membership has a subscription. |
| membership_status | Text Example: ACTIVE |
Displays the membership status. |
| membership_program_id | Number | Displays the membership program ID. |
| membership_program_name | Text | Displays the membership program name. |
| membership_program_description | Text | Displays the membership program description. |
| membership_product_billing_frequency | Number | Displays the membership product billing frequency. |
| membership_product_billing_unit | Day, week, month | Displays the membership product frequency type. |
| membership_product_title | Text | Displays the membership product title. |
| purchase_item_id | Number | Displays the purchase item ID. |
Membership expired on Recharge
This metric is triggered when a membership expires.
Available properties
Property |
Value |
Notes |
| membership_has_subscription | True or false | Confirms the membership has a subscription. |
| membership_status | Text Example: ACTIVE |
Displays the membership status. |
| membership_program_name | Text | Displays the membership program name. |
| membership_program_description | Text | Displays the membership program description. |
| membership_product_billing_frequency | Number | Displays the membership product billing frequency. |
| membership_product_billing_unit | Day, week, or month | Displays the membership product frequency type. |
| membership_product_title | Text | Displays the membership product title. |
Membership cancelled on Recharge
This metric is triggered when a membership is canceled in the merchant admin, via the API, by the customer in the customer portal, or by the Recharge support team via our bulk cancelation tool.
Available properties
Property |
Value |
Notes |
| membership_next_renewal_date | Date and time | Displays the date and time of the customer’s next scheduled membership renewal date. |
| membership_expiration_date | Date and time | Displays the date and time of the customer's membership expiration date. |
| membership_has_subscription | True or false | Confirms the membership has a subscription. |
| membership_status | Text Example: ACTIVE |
Displays the membership status. |
| membership_program_name | Text | Displays the membership program name. |
| membership_program_description | Text | Displays the membership program description. |
| membership_product_billing_frequency | Number | Displays the membership product billing frequency. |
| membership_product_billing_unit | Day, week, or month | Displays the membership product frequency type. |
| membership_product_title | Text | Displays the membership product title. |
Recharge membership reactivated
This metric is triggered when a customer reactivates a canceled membership.
Available properties
Property |
Value |
Notes |
| membership_next_renewal_date | Date and time | Displays the date and time of the customer’s next scheduled membership renewal date. |
| membership_expiration_date | Date and time | Displays the date and time of the customer's membership expiration date. |
| membership_has_subscription | True or false | Confirms the membership has a subscription. |
| membership_status | Text Example: ACTIVE |
Displays the membership status. |
| membership_program_name | Text | Displays the membership program name. |
| membership_program_description | Text | Displays the membership program description. |
| membership_product_billing_frequency | Number | Displays the membership product billing frequency. |
| membership_product_billing_unit | Day, week, month | Displays the membership product frequency type. |
| membership_product_title | Text | Displays the membership product title. |
Member pricing removed from subscription on Recharge
This metric is triggered when the member pricing discount is removed from a customer's recurring subscription because their membership expires. This notification will only be sent when member pricing is removed from an active subscription.
Available properties
Property |
Value |
Notes |
| membership_expiration_date | Date and time | Displays the date and time of the customer's membership expiration date. |
| membership_program_name | Text | Displays the membership program name. |
| bundle_has_oos_selection | True or false | Confirms if an order containing a bundle has any out-of-stock bundle contents. The details on which products are out of stock can be found in the customer_selections property in line_items. |
| charge_id | A unique string of letters and numbers Example: 451df17e73c66527 |
Displays the specific charge_id that triggered the metric. |
| currency_code_symbol | Currency symbol Example: $ |
Displays the currency symbol. |
| customer_charge_currency | Currency code Example: USD |
Displays the currency code. |
| has_bundles | True or false | Confirms if the order has bundles. |
| line_item_first | The following values are passed: - variant_id: A unique string of - numbers ie. 120352. - variant_title: The product variant title ie. Hazelnut. - title: The product title ie. Coffee. - order_upcoming_number: The upcoming order number in the customer's series of recurring orders. This number is for this specific line item ie. 2. - image_url: The product image URL ie //cdn.shopify.com/s/files/logo.png. |
Displays a list of line item properties related to the customer's upcoming order. |
| line_item_second | The following values are passed: - variant_id: A unique string of - numbers ie. 120352. - variant_title: The product variant title ie. Hazelnut. - title: The product title ie. Coffee. - order_upcoming_number: The upcoming order number in the customer's series of recurring orders. This number is for this specific line item ie. 2. - image_url: The product image URL ie //cdn.shopify.com/s/files/logo.png. |
Displays a list of line item properties related to the customer's upcoming order. |
| order_upcoming_number | A unique string of numbers Example: 123456789 |
Displays the upcoming order number. |
| shopify_order_id | A unique string of numbers Example: 123456789 |
Displays the Shopify order id. |
| status | Text Example: QUEUED |
Displays the queued status of the order. |
| sub_total | “NONE” | No subtotal available as the order is queued. |
| sub_total_price | Number Example: 27.0 |
Displays the price. |
| total_discounts | Number Example: 10.0 |
Example: 10.0 Displays any discounts applied to the upcoming order. |
| total_line_item_price | Number Example: 27.0 |
Displays the subscription item price before discounts are applied. In ReCharge this is referred to as the subtotal |
| total_price | Number Example: 17.0 |
Displays the total price including discounts and shipping. |
| total_tax | Number Example: 7.0 |
Displays the tax price. |
| total_unique_line_item_count | A number Example: 3 |
Displays the number of unique line items in an order. Multiple orders of the exact same item are only counted once. |
| transaction_id | “NONE” | No transaction ID available as the order is queued. |
| type | “RECURRING” | Displays the type of charge. |
| variant_ids | A unique string of numbers Example: 773736262 |
Displays the variant ID assigned to the product by your ecommerce platform. |
| variant_ids_order_upcoming_number | A list of numbers Example: 3, 2, 4, 5, 9 |
Displays the upcoming order number for each variant a customer is subscribed to if a next order were to occur. Use the variant_ids_order_upcoming_number property with the variant_id property to create custom flows based on where a customer is at within their subscription lifecycle. |
Order placed successfully on Recharge
This metric is triggered when an order successfully processes through checkout.
Available properties
Property |
Value |
Notes |
| skipped_gifted | True or false |
Notify the customer when a shipment they gifted has been processed. |
| currency_code_symbol | Currency symbol Example: $ |
Displays the currency symbol. |
| customer_charge_currency | Currency code Example: USD |
Displays the currency code the charge will be processed in. |
| line_item_first | The following values are passed: - variant_id: A unique string of - numbers ie. 120352. - variant_title: The product variant title ie. Hazelnut. - title: The product title ie. Coffee. - order_upcoming_number: The upcoming order number in the customer's series of recurring orders. This number is for this specific line item ie. 2. - image_url: The product image URL ie //cdn.shopify.com/s/files/logo.png. |
Displays a list of line item properties related to the customer's upcoming order. Use the details provided with the line_items property to improve the messaging you use with customers. Note: Use puchase_item_type to determine if the order has a one time product included. |
| order_upcoming_number | A unique string of numbers Example: 123456789 |
Displays the upcoming order number in the customer's series of recurring orders associated with the address ID the charge lives under. |
| shipping_address | Combination of text and numbers. |
Displays the customer’s shipping address. |
| shipping_lines |
Combination of text and numbers. |
Displays information related to the selected shipping method. |
| shopify_order_id | A unique string of numbers Example: 123456789 |
Displays the Shopify order id. |
| total_discounts | Number Example: 10.0 |
Displays any discounts applied to the upcoming order. |
| total_line_items_price | Number Example: 27.0 |
Displays the subscription item price before discounts are applied. In ReCharge this is referred to as the subtotal. |
| total_price | Number Example: 17.0 |
Displays the total price including discounts and shipping. |
| total_tax | Number Example: 7.0 |
Displays the tax price. |
| type |
Order type Example: checkout or recurring |
Displays the type of charge. |
| total_unique_line_item_count | A number Example: 3 |
Displays the number of unique line items in an order. Multiple orders of the exact same item are only counted once. |
| order_modifications | Comma separated list of line item properties | Displays a list of line item properties related to partial order fulfillment |
Subscription SKU swapped on Recharge
This metric is triggered when a SKU is swapped on Recharge. This metric is not triggered when swaps are completed using Bulk management tools.
Available properties
Property |
Value |
Notes |
| currency_code_symbol | Currency symbol Example: $ |
Displays the currency symbol. |
| customer_charge_currency | Currency code Example: USD |
Displays the currency code the charge will be processed in. |
| order_interval_frequency |
Number Example: 5 |
Displays the frequency in between charges. |
| order_interval_unit |
Day, week, or month |
Displays the subscription frequency type. |
| order_upcoming_number |
A unique string of numbers Example: 4 |
Displays the upcoming order number if a next order were to occur (ie. the customer reactivates). This is calculated by adding 1 to the total number of charges that have been processed for a customer. Use this property to send custom messages to customers who are reactivating after a set number of charges. For example, you may want to offer a discount to a customer who already had 20 orders processed in the past. |
| quantity |
Number Example: 5 |
Displays the quantity ordered. |
| price |
Number Example: 27.0 |
Displays the subscription price. |
| sku |
A unique string of numbers Example: 1324215215215 |
Displays the SKU assigned to the product in your ecommerce platform. |
| subscription_id |
A unique string of numbers Example: 773736262 |
Displays the subscription ID assigned by Recharge. |
| original_sku_product_title |
Text Example: Coffee subscription |
Displays product title associated with the subscription the customer was previously subscribed to. |
| original_sku_product_id |
A unique string of numbers Example: 72935012501510 |
Displays product ID associated with the subscription the customer was previously subscribed to. |
| original_sku_variant_title |
Text Example: Medium ground coffee |
Displays variant title associated with the subscription the customer was previously subscribed to. |
| original_sku_variant_id |
A unique string of numbers Example: 773736262 |
Displays variant ID associated with the subscription the customer was previously subscribed to. |
| new_sku_product_id |
A unique string of numbers Example: 123456789 |
Displays the new product ID. |
| new_sku_variant_title |
Text Example: Small whole bean coffee |
Displays the new variant title. |
| new_sku_variant_id |
A unique string of numbers Example: 65432186 |
Displays the new variant ID. |
| updated_at |
Date and time Example: March 27, 2023, at 11:11 PM |
Displays the date when the queued charge was last updated. |
|
next_charge_scheduled_at |
Date and time Example: May 27, 2023, at 11:11 PM |
The date when the next charge for this item will be processed |
One-time product added on Recharge
This metric is triggered when a one-time product is added to an order.
Available properties
Property |
Value |
Notes |
| currency_code_symbol | Currency symbol Example: $ |
Displays the currency symbol. |
| customer_charge_currency | Currency code Example: USD |
Displays the currency code the charge will be processed in. |
| external_variant_id |
A unique string of numbers Example: 72935012501510 |
Displays the variant id as provided by your ecommerce platform. |
| product_title |
Text Example: Coffee subscription |
Displays the name of the subscription product purchased. |
| variant_title |
Text Example: Small whole bean coffee |
Displays the variant title. |
| image_url_medium |
The product image URL. Example: //cdn.shopify.com/s/files/1/0000/0001/t/1/assets/logo.png |
Displays the URL for the product image |
| order_upcoming_number |
A unique string of numbers Example: 4 |
Displays the upcoming order number. |
| price |
Number Example: 27.0 |
Displays the subscription price. |
| sku |
A unique string of numbers Example: 1324215215215 |
Displays the SKU assigned to the product in your ecommerce platform. |
|
next_charge_scheduled_at |
Date and time Example: May 27, 2023, at 11:11 PM |
The date when the next charge for this item will be processed |
One-time product deleted on Recharge
This metric is triggered when a one-time product is removed from an order.
Available properties
Property |
Value |
Notes |
| currency_code_symbol | Currency symbol Example: $ |
Displays the currency symbol. |
| customer_charge_currency | Currency code Example: USD |
Displays the currency code the charge will be processed in. |
| external_product_id |
A unique string of numbers Example: 72935012501510 |
Displays the product id as provided by your ecommerce platform. |
| external_variant_id |
A unique string of numbers Example: 72935012501510 |
Displays the variant id as provided by your ecommerce platform. |
| product_title |
Text Example: Coffee subscription |
Displays the name of the subscription product purchased. |
| variant_title |
Text Example: Small whole bean coffee |
Displays the variant title. |
| image_url_medium |
The product image URL. Example: //cdn.shopify.com/s/files/1/0000/0001/t/1/assets/logo.png |
Displays the URL for the product image |
| order_upcoming_number |
A unique string of numbers Example: 4 |
Displays the upcoming order number. |
| price |
Number Example: 27.0 |
Displays the subscription price. |
| sku |
A unique string of numbers Example: 1324215215215 |
Displays the SKU assigned to the product in your ecommerce platform. |
Subscription next charge date changed on Recharge
The "Subscription next charge date changed on Recharge" metric is triggered when an individual subscription's next charge date is rescheduled.
This metric will not trigger when changing the charge date using these methods:
- Bulker Updater Tool is used to change the next charge date.
- Bulk management Import tool is used to change dates.
- When a charge date is changed by targeting the charge ID directly.
Available properties
Property |
Value |
Notes |
| currency_code_symbol | Currency symbol Example: $ |
Displays the currency symbol. |
| customer_charge_currency | Currency code Example: USD |
Displays the currency code the charge will be processed in. |
| charge_interval_frequency |
Number Example: 1 |
The number of units (specified in order_interval_unit) between each Charge |
|
created_at
|
Date and time Example: January 28, 2021 at 07:36 PM |
Displays the date and time for the order. |
|
expire_after_specific_number_of_charges |
Number Example: 2 |
Set the number of charges until subscription expires. |
| external_product_id |
A unique string of numbers Example: 72935012501510 |
Displays the product id as provided by your ecommerce platform. |
| external_variant_id |
A unique string of numbers Example: 72935012501510 |
Displays the variant id as provided by your ecommerce platform. |
| subscription_id |
A unique string of numbers Example: 773736262 |
Displays the subscription ID assigned by Recharge. |
| image_url_medium |
The product image URL. Example: //cdn.shopify.com/s/files/1/0000/0001/t/1/assets/logo.png |
Displays the URL for the product image |
| next_charge_scheduled_at |
Date and time Example: March 27, 2021, at 11:11 PM |
Displays the date and time of the customer’s next scheduled charge. |
|
order_interval_frequency |
Number |
Displays the frequency in between charges. |
| order_interval_unit |
Day, week, or month |
Displays the subscription frequency type (day, week, month). |
| price |
Number Example: 27.0 |
Displays the subscription price. |
| product_title |
Text Example: Coffee subscription |
The name is the product. |
| variant_title |
Text Example: Small whole bean coffee |
The name of the variant. |
|
sku |
A unique string of numbers Example: 1324215215215 |
Displays the SKU assigned to the product in your ecommerce platform. |
Transactional vs. Marketing Emails
You can use Klaviyo to send emails for both Marketing and Transactional purposes.
Marketing emails are strategic emails used to announce specific messages to customers. Monthly newsletters or promotional campaigns are considered marketing emails.
Transactional emails are triggered by and are in response to, specific actions occurring. For example, creating a flow that sends a subscription activation email whenever a new subscription is started through Recharge is considered a Transactional email.
Refer to The Difference between Transactional and Marketing Emails for more information.
Email examples
|
|
Use case |
Trigger metric |
Email type |
|
Welcome email |
Welcome new customers to their subscription. |
|
This could be considered a transaction or marketing Klaviyo flow depending on the contents of the email. |
|
Subscription management |
Notify customers of their upcoming orders and provide them with the option to skip or swap their next subscription. |
|
Transactional email with Klaviyo flows.
Note: You can use Recharge Quick Actions with Klaviyo to include quick links for customers to skip and swap their orders.
|
|
Upsell |
Use ReCharge Quick Actions to offer customers the option to add one-time purchases to their upcoming orders. |
Order upcoming on ReCharge |
Marketing email with Klaviyo flows. |
|
Winback campaign |
Target customers who have canceled their subscriptions and encourage them to reactivate. |
Subscription cancelled on ReCharge Subscription expired on Recharge
|
Marketing email with Klaviyo flows.
Note: You can also build a campaign using the property rc_active_subscription_count=0 in Customer Properties when all of the customer’s subscriptions are canceled.
|
|
Abandoned checkout |
Email customers who added products to the cart but did not check out. |
Started Checkout
Note: This metric only works for merchants using the Recharge Checkout on BigCommerce or the Recharge Checkout on Shopify.
|
Marketing email with Klaviyo flows. |
|
Monthly newsletter |
Notify customers of store news and sales every month. |
N/A |
Marketing email with Klaviyo Campaigns. |
|
Seasonal promotion |
Send customers a standard seasonal discount. |
N/A |
Marketing email with Klaviyo Campaigns. |
Replace Recharge notifications with Klaviyo notifications
Transactional emails can be used to replace three notifications in Recharge, including:
To use Klaviyo notifications instead of Recharge notifications, you must complete the following steps:
- Contact Klaviyo’s support team to set your emails to Transactional. This ensures that applicable notifications are sent to customers even if they’ve unsubscribed from your email marketing list.
- Disable the necessary notifications in Recharge. This prevents duplicate notifications from being sent to your customers.
Advanced segmentation with subscription customer information
You can create custom segments in Klaviyo and send select customers specific notifications.
Custom segments use Recharge customer properties to pass store and customer data from Recharge to Klaviyo. These properties can be used to build specific segments to target certain customers.
Recharge passes specific customer information to Klaviyo through our Recharge custom properties. These properties can be used to segment customers in your Klaviyo email campaigns.
Available Recharge custom properties in Klaviyo
Recharge custom properties are stored on the Customer Profile in Klaviyo.
- Open the Customer Profile on Klaviyo for a specific customer.
- Expand the Information tab.
- Locate the Custom Properties section. Properties associated with Klaviyo V2 begin with
rc_.
Available properties
Expand the drop-down menu below to view the Recharge custom properties available in Klaviyo.
Available properties
Recharge customer property |
Value |
Notes |
|
rc_active_subscriber |
True or False |
This property displays the customer’s active status. If the customer has at least one active subscription, the value is true. If the customer does not have an active subscription, the value is false. |
|
rc_active_subscription_count |
Number |
This property displays the number of active subscriptions associated with the customer’s customer hash. |
|
rc_active_subscription_variant_ids |
subscription_variant_id Example: 12345, 67890 |
This property provides a comma-separated list of the `subscription_variant_id` values for each active subscription. |
|
rc_all_subscriptions |
A comma-separated list of subscription fields and corresponding information. |
This property displays the data that is passed from Recharge to Klaviyo when the “Subscription started on ReCharge” metric fires.
Note: It is not possible to query individual variables from this comma-separated list when creating segmentations in Klaviyo with rc_all_subscriptions. The values are within a nested object, which limits how the segmentation tool can query it.
|
|
rc_cancelled_subscription_count |
Number Example: 2 |
This property displays the number of canceled subscriptions.
Note: Expired subscriptions with existing upcoming shipments (ie. prepaids) are included in this count
|
|
rc_customer_hash |
A unique string of letters and numbers Example: 451df17e73c66527 |
This property is the Recharge customer hash specific to this customer. The customer hash is used when creating Recharge Quick Action URLs in Klaviyo. |
|
rc_customer_id |
A unique string of numbers |
This property is the customer ID assigned to the customer by Recharge. The customer hash is used when creating Recharge Quick Action URLs in Klaviyo. |
|
rc_external_customer_id |
A unique string of numbers Example: 3259148107881 |
This property is the customer ID assigned to the customer by your external platform.
Note: the external_customer_id is not yet recorded for the Recharge Checkout on BigCommerce, however, we plan to add it in the future.
|
|
rc_first_charge_processed at |
Date Example: March 03, 2021 at 01:42 PM |
This property refers to the first charge the customer had in Recharge. |
|
rc_active_subscriptions_charge_count |
A comma-separated list of external variant IDs of active subscriptions and the charge count. Example: 12345:3, 67890:2 |
This property displays the charge count for each subscription item the customer is subscribed to. The numbers before the colon in the customer property represents the shopify_variant_Id. The number after the colon represents the amount of charges on this variant so far. In the example provided, the customer is subscribed to different products. The product 12345, which they’ve been charged for a total of three times, and the product 67890, which they’ve been charged for a total of two times. |
|
rc_queued_charge_count |
Number Example: 2 |
This property represents the number of queued charges that currently exist for the customer. Multiple queued charges may be listed if customers have multiple subscriptions with different frequencies. |
|
rc_queued_charges |
A comma-separated list of subscription fields and corresponding information. |
This property displays the data that is passed to Klaviyo when the “Order Upcoming on Recharge” metric fires.
These line item properties can be used to personalize your Order Upcoming on Recharge email flow. This property cannot be used to create segmented lists in Klaviyo. |
|
rc_customer_charge_count |
Number Example: 2 |
This property provides charge count at the overall customer level. This property can be used to welcome first time subscribers to your subscription community. Create a segment or Klaviyo flow that sends to customers when they trigger the 'order placed successfully on Recharge' metric and their rc_customer_charge_count is equal to 1. Use this flow to educate your customers on the benefits of subscriptions. Include the view customer portal quick actions URL to give customers a passwordless link to their portal. |
|
rc_next_charge_date |
Date Example: March 03, 2021 at 01:42 PM |
This property allows you to segment customers based on a specific charge date. If a customer has multiple upcoming charge dates, this will reflect the first upcoming charge. Use this property to filter and segment for customers next charge date, email customers about an upcoming shipment delay, and email customers with an upsell opportunity. |
|
rc_all_next_charge_dates |
String that lists a customer's next charge dates associated with the variant ID. Example: 2023-05-13:41739175035060, 2023-05-13:41739175035061, 2023-05-16:41739175035065 |
This property allows you to segment customers based on a specific variant ID they are subscribed to and the next charge date associated with it. Use this property to filter and segment for customers next charge date and specific variant ID, email customers about an upcoming shipment delay, and email customers with an upsell opportunity. |
Recharge customer properties data sync
Recharge customer property data is synced with Klaviyo depending on the event associated with the variable. Either a subscription event or a charge event triggers the data to update in Klaviyo.
The following properties are updated immediately when an event related to a subscription occurs (ie. a subscription is created, updated, or deleted):
- rc_active_subscriber
- rc_active_subscription_count
- rc_active_subscription_variant_ids
- rc_cancelled_subscription_count
- rc_cancelled_subscription_variant_ids
- rc_all_subscriptions
- rc_customer_charge_count
- rc_next_charge_date
- rc_all_next_charge_dates
The following properties are updated when an event related to a charge occurs:
- rc_active_subscriptions_charge_count
- rc_cancelled_subscriptions_charge_count
- rc_customer_charge_count
- rc_next_charge_date
- rc_all_next_charge_dates
Customer Properties and flows
Customer Properties can be used as Event Filters when building flows in Klaviyo. Previewing a flow email in Klaviyo displays the available properties for that event in the event dialog window. These properties can be leveraged as Event Variables in your Klaviyo flows.
Refer to the following Klaviyo documentation for assistance:
- Event Variables
- Repeating a Block Based on Dynamic Data
- How to Show or Hide Template Blocks Based on Dynamic Variables
Contact the Klaviyo support team if you need assistance building flows in Klaviyo.
