Using Recharge metrics to trigger Klaviyo flows
Recharge sends custom metrics to Klaviyo that record subscription and order actions as timestamped events. Use these metrics as flow triggers in Klaviyo to automatically send notifications via email or Klaviyo SMS when key events occur. You can also use the event properties sent with each metric to filter who enters the flow and personalize messages.
This guide explains how Recharge metrics work with Klaviyo, which metrics are available, and the properties sent with each metric.
- Recharge Checkout on BigCommerce
- Shopify Checkout Integration
- Migrated Shopify Checkout Integration
Before you start
- Review the Klaviyo overview guide to understand how Klaviyo works with Recharge.
- See Recharge and Klaviyo use cases for detailed walkthroughs on building Klaviyo flows and campaigns with Recharge data.
Video walkthroughs
Recharge and Klaviyo metrics
Metrics are events in Recharge that are sent to Klaviyo. You can use metrics to trigger specific events and provide line-item details around the event. Review the following video to learn about the different stages of the customer lifecycle and how you can use Recharge and Klaviyo metrics to support your customers’ needs.
Klaviyo email flows
Email flows in Klaviyo consist of a trigger setup that searches for keywords in a metric and then sends your configured email to customers. Watch the video below to learn how Recharge and Klaviyo pass information, as well as instructions on replacing standard Recharge notifications.
Build a flow in Klaviyo with Recharge metrics
Review How to build a flow in Klaviyo with Recharge metrics for detailed setup instructions.
Recharge metrics as event triggers for Klaviyo flows
Every Klaviyo flow begins with a trigger that activates the flow when the trigger conditions are met. Recharge metrics are one type of trigger you can use when configuring a Flow Trigger.
Use metrics as triggers when building Klaviyo Marketing flows to grow your business, or create Transactional flows that replace customer notifications in Recharge.
Flow examples
- Use the Subscription started on ReCharge metric to welcome new customers to their subscription.
- Use the Subscription frequency change on Recharge metric to automatically send customers a confirmation that their subscription was successfully updated.
- Use the Order upcoming on ReCharge to replace Recharge's standard upcoming order notification.
Understanding metrics and properties
Metrics are recorded customer events, stored in Klaviyo. Metrics are triggered when specific customer events occur, and customer data is sent to Klaviyo based on the customer's action. For example, anytime a customer checks out with a new subscription product, the Subscription started on ReCharge metric is triggered to send information from Recharge to Klavyio. See Klaviyo’s article Getting started with metrics to learn more about how metrics work.
Recharge passes line-item details around every event to Klaviyo through metrics. These line-item details are called properties, and they tell the story of the specific action the customer took. Available properties depend on the metric Recharge sends to Klaviyo. For example, the Subscription started on ReCharge properties contains details about the product the customer purchased to start their subscription, including the product ID, so you can create custom Welcome emails to customers based on the products they subscribe to.
Find each metric listed below, grouped by event type, along with the properties sent with each metric.
To use any of the property variables listed below 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 Cancelled 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 }}.
Viewing properties in Klaviyo
You can view example customer properties when previewing the email associated with a Klaviyo flow:
- Open the flow in Klaviyo.
- Click on the email action in the flow.
- Click Edit template to open the email template.
- Click Preview & test to open a preview of the Event Info.
You can now view the available properties associated with the event in the right-hand panel under Event Properties.
Use the arrow buttons in the Previewing with recent event section to populate different customer data.
Subscription metrics
The following metrics are sent to Klaviyo when a customer interacts with their subscription:
-
Subscription started on ReCharge: Triggered when a subscription is added to the customer's account through the checkout, customer portal, API, or through the Recharge merchant portal.
- The system triggers the "Subscription started on ReCharge" metric for every new subscription, potentially triggering multiple events if a customer purchases multiple subscriptions. To only send one email when a customer buys multiple subscriptions at checkout, use the "Order placed successfully on Recharge" metric. Set the filter type to "CHECKOUT" and/or "RECURRING" based on your use case.
- Subscription cancelled on ReCharge: Triggered when a subscription is canceled through the customer portal, via API, through the Recharge merchant portal, or, upon request, through Recharge's bulk cancellation tool.
-
Subscription expired on ReCharge: Triggered when a subscription auto-expires by design.
- To provide a positive customer experience, this metric is only sent if the subscription expires after two or more charges.
- Recharge subscription reactivated: Triggered when a customer reactivates a canceled subscription.
- Subscription paused on ReCharge: Triggered when a customer pauses their subscription.
- Subscription SKU swapped on Recharge: Triggered when a SKU is swapped on ReCharge.
- Subscription next charge date changed on Recharge: Triggered when an individual subscription's next charge date is rescheduled.
- Subscription frequency changed on Recharge: Triggered when a customer changes their subscription frequency.
- One-time product added on Recharge: Triggered when a one-time product is added to an order.
- One-time product deleted on Recharge: Triggered when a one-time product is removed from an order.
Properties
Review the list of available properties sent with subscription metrics. See Property availability per subscription metric to confirm if a property is sent through a specific metric.
Property |
Definition |
|---|---|
| customer_charge_currency | The currency code for the currency the customer used to purchase their subscription. |
| charge_interval_frequency | The number of billing cycles between each charge for a subscription or recurring payment. |
| currency_code_symbol | The currency symbol that is used for the currency the customer used to purchase their subscription. |
| customer_portal_link |
A tokenized customer portal link. Compatible with Affinity customer portal theme. |
| customer_selections | Lists the bundle contents selected by the customer. This property remains empty if the customer purchases a preset bundle. |
| expire_after_specific_number_of_charges | The final charge before the subscription expires. This value will always be two or more. |
| external_product_id | The product ID assigned by your ecommerce platform. |
| external_variant_id | The product variant ID assigned by your ecommerce platform. |
| extra | The subscription ID assigned by Recharge. |
| fallback_selections | The fallback content set for a bundle. |
| image_url_medium | The URL for the product image. |
| is_bundle | Indicates if the subscription is a bundle. |
| is_customizable | Indicates if the bundle is customizable. |
| next_charge_scheduled_at | Displays the date and time of the customer’s next scheduled charge, if applicable. |
| onetime_id | The one-time product assigned by your ecommerce platform. |
| order_interval_days | The number of days in between charges. |
| order_upcoming_number | The upcoming order number linked to the address ID associated with the charge. This count includes the initial checkout order. |
| price | The subscription price. |
| product_id | The unique identifier for the product in your ecommerce platform. |
| product_title | The product name. |
| purchase_item_type | The type of purchase. |
| quantity | The number of product units in an order. |
| sku | The SKU assigned to the product in your ecommerce platform. |
| subscription_id | The subscription ID that Recharge assigns. |
| $value |
Klaviyo property availability per subscription metric (Click to expand)
Property |
Subscription started |
Subscription Cancelled |
Subscription Expired |
Subscription Paused |
Recharge Reactivated |
SKU Swapped |
Next Charge Changed |
Frequency Changed |
One-Time Added |
One-Time Deleted |
|---|---|---|---|---|---|---|---|---|---|---|
| customer_charge_currency | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ✔️ | ✔️ |
| charge_interval_frequency | ❌ | ❌ | ❌ | ❌ | ❌ | ✔️ | ✔️ | ❌ | ❌ | ❌ |
| currency_code_symbol | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ✔️ | ✔️ |
| customer_portal_link | ✔️ | ✔️ | ✔️ | ❌ | ✔️ | ✔️ | ❌ | ❌ | ❌ | ❌ |
| customer_selections | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ | ❌ | ❌ | ❌ | ❌ |
| expire_after_specific_number_of_charges | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ❌ |
| external_product_id | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| external_variant_id | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| extra | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| fallback_selections | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ | ❌ | ❌ | ❌ | ❌ |
| image_url_medium | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ✔️ | ✔️ |
| is_bundle | ✔️ | ✔️ | ✔️ | ❌ | ✔️ | ✔️ | ✔️ | ❌ | ❌ | ❌ |
| is_customizable | ✔️ | ✔️ | ❌ | ❌ | ✔️ | ✔️ | ❌ | ❌ | ❌ | ❌ |
| next_charge_scheduled_at | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| onetime_id | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✔️ | ✔️ |
| order_interval_days | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ❌ |
| order_upcoming_number | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ❌ |
| price | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| product_id | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ❌ |
| product_title | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| purchase_item_type | ❌ | ❌ | ❌ | ❌ | ❌ | ✔️ | ✔️ | ✔️ | ❌ | ❌ |
| quantity | ❌ | ❌ | ❌ | ❌ | ❌ | ✔️ | ✔️ | ✔️ | ❌ | ❌ |
| sku | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| subscription_id | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ❌ |
| $value | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ✔️ | ✔️ |
Order metrics
The following metrics are sent to Klaviyo when a customer interacts with their order:
- Order upcoming on ReCharge: Triggered three days before a customer's upcoming order is processed, by default.
- Order upcoming (prepaid) on ReCharge: Triggered three days before a customer's upcoming prepaid shipment is processed by default.
- Order placed successfully on Recharge: Triggered when a checkout or recurring order is successfully processed.
By default, Recharge sends the upcoming order metrics to Klaviyo three days before the queued charge date. To change when this metric is sent, follow these steps:
- In the merchant portal, click Cross-sell and upsell. Select Upcoming order email, and click Settings.
- Alternatively, click Email. Select Upcoming order email, and click Settings.
- Under Send these emails, enter the number of days before the charge date that Recharge should send the upcoming order metric to Klaviyo.
- Click Save settings to apply your changes.
You must contact the Recharge support team to update the settings for the order upcoming (prepaid) on ReCharge metric.
Properties
Review the list of available properties sent with order metrics. See Property availability per order metric to confirm if a property is sent through a specific metric.
Property |
Definition |
|---|---|
| bundle_has_oos_selection |
Indicates whether any selections within a bundle are out of stock. This property is only included when the order contains a bundle and will return either true or false based on stock availability.
Note: If you do not track inventory in Shopify, you must enable the Continue selling when out of stock setting. Otherwise, Shopify may incorrectly mark products as out of stock.
|
| charge_id | The specific charge_id that triggered the metric. |
| created_at | The date and time the order will be created. |
| currency | The currency code for the currency the customer used to purchase their subscription. |
| currency_code_symbol | The currency symbol associated with the payment method used by the customer to purchase their subscription. |
| customer_charge_currency | The currency used to calculate the order amount. |
| customer_portal_link | A tokenized customer portal link that is compatible with Affinity customer portal theme. |
| customer_subscription_related_streak_count |
The total sum of consecutive subscription-related orders across all of the customer's active subscriptions.
|
| external_order_id | The order id assigned your external ecommerce platform. |
| external_order_number | The order number assigned your external ecommerce platform. |
| has_bundles | Indicates if the order contains any Bundles products. |
| line_item_first |
A list of line item properties related to the customer's upcoming order:
|
| line_items |
A list of order information, including:
|
| merged_order | Indicates if the charge was merged with other charges as a result of automatic order merging. See Order merge notifications for additional details. |
| net_new_subscription_line_items_value | The total monetary value of new subscription line items added to the order. |
| one_time_line_items_value | The total monetary value of one-time line items included in the order. |
| order_modifications | A list of line item properties related to partial order fulfillment. |
| order_upcoming_number | The upcoming order number linked to the address ID associated with the charge. This count includes the initial checkout order. |
| recurring_subscription_line_items_value | The total monetary value of recurring line items purchased during the specified period. |
| scheduled_at | The scheduled date and time for the upcoming. |
| shipping_address | The customer's shipping address. |
| shipping_date | Indicates when the order ships. |
| shipping_lines | Information related to the selected shipping method. |
| shopify_order_id | The order ID assigned by Shopify. |
| shopify_order_number | The order number assigned by Shopify. |
| skipped_gifted | Indicates if a shipment that was gifted has been processed. |
| status | The current status of the order. |
| sub_total | |
| subtotal_price | The price before shipping, discounts, and taxes. |
| total_line_items_price | The subscription item price before discounts are applied. |
| total_discounts | Any discounts applied to the upcoming order. |
| total_line_items_value | Represents the total value of all line items in the order. |
| total_price | The total price including discounts and shipping. |
| total_tax | The total amount charged for tax. |
| total_unique_line_item_count | The number of unique line items in an order. Multiple orders of the exact same item are only counted once. |
| transaction_id | Identifies the unique ID associated with the payment transaction for the order. |
| type | The type of charge. |
| updated_at | The date and time when the queued charge was last updated. |
| variant_ids | The variant ID assigned to the product by your ecommerce platform. |
| variant_ids_order_upcoming_number | The upcoming order number for each variant a customer is subscribed to. This count includes the checkout order. |
Property availability per order metric (Click to expand)
Property |
Order placed successfully |
Order upcoming |
Order upcoming (prepaid) |
|---|---|---|---|
| bundle_has_oos_selection | ❌ | ✔️ | ✔️ |
| charge_id | ❌ | ✔️ | ✔️ |
| created_at | ✔️ | ✔️ | ✔️ |
| currency | ✔️ | ❌ | ❌ |
| currency_code_symbol | ✔️ | ✔️ | ✔️ |
| customer_charge_currency | ✔️ | ✔️ | ✔️ |
| customer_portal_link | ✔️ | ✔️ | ✔️ |
| customer_subscription_related_streak_count | ❌ | ✔️ | ✔️ |
| external_order_id | ✔️ | ❌ | ❌ |
| external_order_number | ✔️ | ❌ | ❌ |
| has_bundles | ❌ | ✔️ | ✔️ |
| line_item_first | ✔️ | ✔️ | ✔️ |
| line_items | ✔️ | ✔️ | ✔️ |
| merged_order | ❌ | ✔️ | ✔️ |
| net_new_subscription_line_items_value | ✔️ | ✔️ | ✔️ |
| one_time_line_items_value | ✔️ | ✔️ | ✔️ |
| order_modifications | ✔️ | ❌ | ❌ |
| order_upcoming_number | ✔️ | ✔️ | ✔️ |
| recurring_subscription_line_items_value | ✔️ | ✔️ | ✔️ |
| scheduled_at | ❌ | ✔️ | ✔️ |
| shipping_address | ✔️ | ✔️ | ✔️ |
| shipping_date | ✔️ | ❌ | ❌ |
| shipping_lines | ✔️ | ✔️ | ✔️ |
| shopify_order_id | ✔️ | ✔️ | ✔️ |
| shopify_order_number | ✔️ | ❌ | ❌ |
| skipped_gifted | ✔️ | ❌ | ❌ |
| status | ❌ | ✔️ | ✔️ |
| sub_total | ❌ | ✔️ | ✔️ |
| subtotal_price | ✔️ | ✔️ | ✔️ |
| total_discounts | ✔️ | ❌ | ✔️ |
| total_line_items_price | ❌ | ✔️ | ✔️ |
| total_line_items_value | ✔️ | ✔️ | ✔️ |
| total_price | ✔️ | ✔️ | ✔️ |
| total_tax | ✔️ | ✔️ | ✔️ |
| total_unique_line_item_count | ✔️ | ✔️ | ✔️ |
| transaction_id | ✔️ | ✔️ | ✔️ |
| type | ✔️ | ✔️ | ✔️ |
| updated_at | ✔️ | ✔️ | ✔️ |
| variant_ids | ✔️ | ✔️ | ✔️ |
| variant_ids_order_upcoming_number | ✔️ | ✔️ | ✔️ |
Gifting metrics
Recharge sends the following metrics to Klaviyo when a gift is purchased:
- Gift purchased on ReCharge: Triggered when Recharge schedules the notification for the gift recipient.
- Gift redeemed on ReCharge: Triggered when a gift recipient redeems their gift.
- Gift unclaimed on ReCharge: Triggered when a gift recipient does not redeem their gift.
Properties
The following properties are sent with every gifting-related metric:
Property |
Definition |
|---|---|
| gift_amount | The total cost of the gift. |
| gift_currency | The currency the gift was purchased in. |
| gift_external_order_id | The order id for your external ecommerce platform. |
| gift_id | Identifies a specific gift purchase line item. |
| gift_note | A note the customer can send to the gift recipient. |
| gift_notification_send_at | The date the notification is set to send for. |
| gift_product_id | The external product id of the gift product purchased by the sender. |
| gift_product_variant_id | The external variant id if of the gift product purchased by the sender. |
| recipient_customer_hash | The unique identifier used to identify the gift recipient. |
| recipient_customer_id | The unique identifier used to identify the gift recipient. |
| recipient_email | The email address of the person who is receiving the gift. |
| recipient_first_name | The first name of the person who is receiving the gift. |
| recipient_last_name | The last name of the person who is receiving the gift. |
| redeemable_product_id | The external product id of the product that the recipient can redeem. |
| redeemable_product_title | The title of the product that the recipient can redeem. |
| redeemable_product_image_link | The image link for the product that the recipient can redeem. |
| redemption_url | The unique URL customers use to redeem their gift. |
| sender_email | The email address of the person who purchased the gift. |
| sender_first_name | The first name of the person who purchased the gift. |
| sender_last_name | The last name of the person who purchased the gift. |
| sender_name | The full name of the person who purchased the gift. |
| is_sender | Indicates whether the customer associated with the metric is the gift sender rather than the gift recipient. |
Bundle metrics
Recharge sends the following metrics to Klaviyo to report bundle activity:
- Bundle selection created on ReCharge: Triggered when a new bundle selection record is created and when new selections are created after an automatic reset.
- Bundle selection updated on ReCharge: Triggered when an existing bundle selection record is updated in the customer portal.
Properties
The following properties are sent with every Bundles-related metric:
Property |
Definition |
|---|---|
| bundle_selection_id | The ID of the bundle selection record. |
| external_product_id | The product ID assigned by your ecommerce platform. |
| external_variant_id | The product variant ID assigned by your ecommerce platform. |
| items | the items in the bundle including the product and variant IDs, quantity, inventory, image, product title, and handle. |
| product_handle | The handle of the parent product as it appears in the external ecommerce platform. |
| product_image | The image of the parent product as it appears in the external ecommerce platform. |
| product_title | The title of the parent product as it appears in the external ecommerce platform. |
| subscription_id | The subscription ID for the bundled product. |
Rewards metrics
Rewards metrics are split between Credits and Memberships.
Credit metrics
- Credit adjustment created on ReCharge: Triggered whenever a credit adjustment is created on an associated credit account.
Properties
The following properties are sent with every Credits-related metric:
Property |
Definition |
|---|---|
| amount | The amount of the credit adjustment on an associated credit account. |
| credit_account_type |
The credit account type. Possible values include:
|
| currency_code | The currency of the associated credit account. |
| ending_balance | The available balance on an associated credit account following the adjustment. This does not represent the customer's total available balance across all of their credit accounts. |
| total_available_balance | The total available balance of all credits issued to the customer. |
| type |
The type of adjustment made on the credit account. Possible values include:
|
Membership metrics
- Membership started on ReCharge: Triggered when a membership is added to a customer’s account through the checkout or customer portal, via the API, or the merchant portal.
- Membership expired on ReCharge: Triggered when a membership automatically expires.
- Membership cancelled on ReCharge: Triggered when a membership is canceled in the merchant portal, via the API, by the customer in the customer portal, or via the Recharge bulk cancelation tool.
- Recharge membership reactivated: Triggered when a customer reactivates a canceled membership.
- Member pricing removed from subscription on ReCharge: Triggered when the member pricing discount is removed from a customer's recurring subscription because their membership expires. This notification is only sent when member pricing is removed from an active subscription.
Properties
The following properties are sent with every Memberships-related metric:
Property |
Definition |
|---|---|
| membership_expiration_date | The date and time of the customer's membership expiration date. |
| membership_has_subscription | Indicates if the membership has a subscription. |
| membership_next_renewal_date | The date and time of the customer’s next scheduled membership renewal date. |
| membership_product_billing_frequency | The membership product billing frequency. |
| membership_product_billing_unit | The membership product frequency type. |
| membership_product_title | The membership product title. |
| membership_program_name | The membership program name you assigned. |
| membership_program_description | The membership program description you set. |
| membership_status | Indicates the membership status. |
| purchase_item_id | The purchase item ID. |
Additional properties are sent with specific metrics. Refer to the list below for additional properties sent with each metric:
Membership started on ReCharge
Property |
Definition |
|---|---|
| membership_program_id | The membership program ID assigned by Recharge. |
Member pricing removed from subscription on ReCharge
The member pricing removed from subscription on ReCharge metric only sends some of the properties listed in the chart above, as well as the following properties:
Property |
Definition |
|---|---|
| bundle_has_oos_selection | Indicates if the order containing a bundle has any out-of-stock bundle contents. Review the customer_selections property under line_items to confirm which products are out-of-stock. |
| charge_id | The specific charge_id that triggered the metric. |
| currency_code_symbol | The currency symbol that is used for the currency the customer used to purchase their subscription. |
| customer_charge_currency | The currency code for the currency the customer used to purchase their subscription. |
| has_bundles | Indicates if the order has bundles. |
| line_item_first/line_item_second |
A list of line item properties related to the customer's upcoming order:
|
| order_upcoming_number | The upcoming order number linked to the address ID associated with the charge. This count includes the initial checkout order. |
| shopify_order_id | shopify_order_id: The order ID assigned by Shopify. |
| status | Indicates the queued status of the order. |
| sub_total | No subtotal is available as the order is queued. |
| sub_total_price | The subtotal. |
| total_discounts | Any discounts applied to the upcoming order. |
| total_line_item_price | The subscription item price before discounts are applied. Also considered the subtotal. |
| total_price | The total price including discounts and shipping. |
| total_tax | The total amount charged for tax. |
| total_unique_line_item_count | The number of unique line items in an order. Multiple orders of the exact same item are only counted once. |
| transaction_id | No transaction ID is available as the order is queued. |
| type | The type of charge. |
| variant_ids | The variant ID assigned to the product by your ecommerce platform. |
| variant_ids_order_upcoming_number | The upcoming order number for each variant a customer is subscribed to. This count includes the checkout order. |
Subscription Experiences metrics
For applicable Subscription Experiences, add a Klaviyo notification node to the flow canvas to send relevant customer notifications using Klaviyo. For setup instructions, see Add a Klaviyo node to a Subscription Experience.
The following metric is sent to Klaviyo when a customer enters a Subscription Experience containing a Klaviyo notification node:
- Flow triggered on Recharge
Properties
Flow event properties
Flow event properties are related to the flow itself. These are sent with every Klaviyo node.
Property name |
Event property |
Description |
|---|---|---|
| Flow name | flow_name | The flow's unique name. |
| Unique identifier for a flow | flow_id |
Identifies the flow associated with the event metric. For example, you can configure a trigger filter to look for events with a specific flow_id to trigger a Klaviyo email flow for a specific Recharge flow. |
Customer event properties
Customer event properties are related to specific customer events.
Property name |
Event property |
Description |
|---|---|---|
| Customer portal URL | customer_portal_link | A magic link that dynamically populates a direct link to the customer portal. Passwordless login is supported. |
| Unique identifier used in a customer portal link | customer_hash | The unique string identifier used to identify the customer portal link. |
Order event properties
Order event properties are related to specific order events.
Property name |
Event property |
Description |
|---|---|---|
| Charge scheduled date | scheduled_at |
The processing date scheduled for the affected charge. Use this property to dynamically populate the upcoming charge date that the flow affects. |
| Currency code | customer_charge_currency |
The customer’s currency code. Use this property as a filter or to dynamically populate a customer's currency code, ie. USD, CAD, MXN, AUD. |
| Currency symbol | currency_code_symbol |
The customer’s currency symbol. Use this property to dynamically populate the customer's currency code symbol. |
| Customer’s shipping address | shipping_address{} |
The customer’s shipping address. Use this property to dynamically populate the customer's shipping address. |
| Line items | line_items{} |
The line item details of the affected charge. Use this property to dynamically populate the upcoming orders line items, ie. the product image, or product or variant title. |
| Sub-total | subtotal_price |
The sub-total of the affected charge. Use this property as a filter or to dynamically populate the subtotal price. |
| Total discounts | total_discounts |
The total discounts on the affected charge. Use this property as a filter, or to dynamically populate the discount amount on an order. |
| Total price | total_price |
The total price on the affected charge. Use this property as a filter, or to dynamically populate the order's total price. It is recommended to use the sub_total event property for Shopify Checkout Integration stores as the tax amount on an upcoming order is an estimate or displays as 0.00. This is because the tax is calculated when the charge is processed. |
| Total tax estimated | total_tax |
The total tax estimated on the affected charge. Use this property to dynamically populate the estimated tax amount on an order. The tax amount on an upcoming order is an estimate or displayed as 0.00 for Shopify Checkout Integration stores. This is because Recharge calcuates the tax amount when processing the charge. |
| Unique identifier for the charge that the flow applies to | charge_id |
The charge_id for the upcoming charge that the flow applies to. For example, if the flow is configured to add a gift to the customer's next order, the charge_id would reflect the order the gift was added to. The charge_id is typically used for investigation purposes. |
Incentive event properties
The incentive event properties relate to the incentive provided through the Recharge flow. The incentive node must be placed before the Klaviyo node for the event properties to be made available.
Property name |
Event property |
Description |
|---|---|---|
| Incentive offer value | incentive_offer_value |
The value of the incentive being offered to customers. The value of this event property is reflective of the incentive type:
|
| Incentive type | incentive_offer_type |
The incentive type that customers are receiving. The value of this event property is dependent on the type of incentive and can be one of the following:
Use this property as a filter or to dynamically populate the incentive offer type. |
| Onsite experience customer portal link | onsite_experience_link |
A magic link that sends customers directly to the onsite landing page. This is only applicable for Upcoming Order Cross-sell flows. Use this property as a filter to dynamically populate a direct link to the onsite experience. |
|
Product image
|
incentive_image{} |
The incentive product image. Use this property as a filter or to dynamically populate the incentive product image. |
| Variant id | incentive_variant_id |
The variant id for the incentive product. Use this property as a filter or to dynamically populate the incentive products variant id. |
Custom event properties
Use custom event properties to pass unique store information from Recharge to Klaviyo and dynamically populate it, or use them to filter and segment customers. You can send up to four custom event properties per Klaviyo node.
For example, if you set up a Surprise and Delight A/B test and want to segment the customers in Klaviyo based on who didn’t receive an incentive, you could add a Klaviyo node to the “no offer” branch and pass a custom attribute with the property name branch and the value no_offer:
- The property name will always be prefixed with
rc_flow_ - To continue with the same example, in Klaviyo the custom event property would populate as
rc_flow_branch: no_offer
Considerations
Consider the following when using Klaviyo and Recharge:
Consideration |
Notes |
| Notification timing for upcoming charge events | Recharge sends the upcoming charge events to Klaviyo between 1-4 PM ET. After Recharge sends the upcoming charge events to Klaviyo, Klaviyo handles the notifications, which may result in timing variations compared to Recharge's in-house notifications. |
| Event payload size limits for Klaviyo |
Klaviyo enforces a 100KB payload size limit for events sent through their API. To keep event and customer property syncs reliable, Recharge automatically trims certain data only when an event exceeds this limit.
Most merchants will not see any impact on their Klaviyo data or segmentation due to these limits. |
