> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firmhouse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Available lifecycle events

> Browse Firmhouse lifecycle events and the properties they send to Klaviyo.

Find the events you can enable under **Apps > Klaviyo > Lifecycle events**, grouped by the same categories shown in Firmhouse. Each entry lists the default Klaviyo metric name, the Firmhouse event identifier, and the properties sent by default.

To get started, [install the Firmhouse Klaviyo app](https://docs.firmhouse.com/integrations/klaviyo/getting-started.md#install-the-firmhouse-klaviyo-app), review the enabled events, and send a test event where available. New v2-only connections enable all supported events automatically; existing installations keep their event choices. The events available to your project depend on its setup.

Lifecycle events use Firmhouse webhook events to record Klaviyo metrics. Their default payloads are specific to the Klaviyo integration and can differ from examples in the [developer webhook reference](https://developer.firmhouse.com/webhooks/overview). Use this page for Klaviyo metric names and properties.

## Properties included with every event

Every event includes these properties, alongside the event-specific properties listed below:

| Property | Description |
| - | - |
| `firmhouse_event` | The Firmhouse event identifier. |
| `subscription_id` | The subscription's ID. |
| `subscription_status` | The subscription's current status. |

Use these properties in your Klaviyo flows and messages. Customer profile properties are [documented separately](https://docs.firmhouse.com/integrations/klaviyo/getting-started.md#standard-properties).

Fields ending in `_cents` contain amounts in the currency's minor units—for example, `1099` means €10.99 for EUR. Values depend on the event's data, so inspect a test event before using a property in your message.

If you customized an event, its properties may differ. Expand **Customize event payload** and click **Edit payload template** to inspect them. When a newer default is available, use **Load update into editor**, review it, then **Save changes**. Loading an update does not change the saved payload until you save.

## Subscriptions

### Subscription cancellation initiation

**Klaviyo metric:** `Firmhouse: Subscription cancellation initiation`\
**Firmhouse event:** `subscription_cancellation_initiation`

Additional properties:

| Property | Description |
| - | - |
| `cancellation_started_at` | When cancellation was started. |
| `cancelled_at` | When the subscription was cancelled. |
| `planned_cancellation_date` | The planned cancellation date. |
| `cancellation_reason` | The reason for cancellation. |
| `remaining_orders_count` | The number of orders remaining before cancellation. |
| `final_order_date` | The date of the final order. |

### Subscription cancellation confirmation

**Klaviyo metric:** `Firmhouse: Subscription cancellation confirmation`\
**Firmhouse event:** `subscription_cancellation_confirmation`

Additional properties:

| Property | Description |
| - | - |
| `cancellation_started_at` | When cancellation was started. |
| `cancelled_at` | When the subscription was cancelled. |
| `planned_cancellation_date` | The planned cancellation date. |
| `cancellation_reason` | The reason for cancellation. |
| `remaining_orders_count` | The number of orders remaining before cancellation. |
| `final_order_date` | The date of the final order. |

### Subscription signed up

**Klaviyo metric:** `Firmhouse: Subscription signed up`\
**Firmhouse event:** `subscription_signed_up`

Additional properties:

| Property | Description |
| - | - |
| `plan_id` | The plan's ID. |
| `plan_name` | The plan's name. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `next_billing_date` | The next billing date. |
| `currency` | The currency. |
| `monthly_amount_cents` | The monthly subscription amount, in minor units. |

### Subscription activated

**Klaviyo metric:** `Firmhouse: Subscription activated`\
**Firmhouse event:** `subscription_activated`

Additional properties:

| Property | Description |
| - | - |
| `plan_id` | The plan's ID. |
| `plan_name` | The plan's name. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `next_billing_date` | The next billing date. |
| `currency` | The currency. |
| `monthly_amount_cents` | The monthly subscription amount, in minor units. |
| `add_product_url` | A link to add a product to the subscription. |

### Subscription address changed

**Klaviyo metric:** `Firmhouse: Subscription address changed`\
**Firmhouse event:** `subscription_address_changed`

Additional properties:

| Property | Description |
| - | - |
| `name` | The customer's full name. |
| `company_name` | The company name. |
| `address` | The street address. |
| `address2` | Additional address details. |
| `house_number` | The house number. |
| `zipcode` | The postal code. |
| `city` | The city. |
| `state` | The state or region. |
| `country` | The country. |
| `changes` | The fields changed by this event. |

### Subscription rejected

**Klaviyo metric:** `Firmhouse: Subscription rejected`\
**Firmhouse event:** `subscription_rejected`

Additional properties:

| Property | Description |
| - | - |
| `plan_id` | The plan's ID. |
| `plan_name` | The plan's name. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `next_billing_date` | The next billing date. |
| `currency` | The currency. |
| `monthly_amount_cents` | The monthly subscription amount, in minor units. |

### Subscription paused

**Klaviyo metric:** `Firmhouse: Subscription paused`\
**Firmhouse event:** `subscription_paused`

Additional properties:

| Property | Description |
| - | - |
| `paused_at` | When the subscription was paused. |
| `paused_until` | When the pause ends. |
| `pause_reason` | The reason for pausing. |
| `next_billing_date` | The next billing date. |

### Subscription resumed

**Klaviyo metric:** `Firmhouse: Subscription resumed`\
**Firmhouse event:** `subscription_resumed`

Additional properties:

| Property | Description |
| - | - |
| `paused_at` | When the subscription was paused. |
| `paused_until` | When the pause ends. |
| `pause_reason` | The reason for pausing. |
| `next_billing_date` | The next billing date. |

### Subscription stopped

**Klaviyo metric:** `Firmhouse: Subscription stopped`\
**Firmhouse event:** `subscription_stopped`

Additional properties:

| Property | Description |
| - | - |
| `stopped_at` | When the subscription was stopped. |

### Subscription approved

**Klaviyo metric:** `Firmhouse: Subscription approved`\
**Firmhouse event:** `subscription_approved`

Additional properties:

| Property | Description |
| - | - |
| `plan_id` | The plan's ID. |
| `plan_name` | The plan's name. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `next_billing_date` | The next billing date. |
| `currency` | The currency. |
| `monthly_amount_cents` | The monthly subscription amount, in minor units. |

### Subscription resolved non paying

**Klaviyo metric:** `Firmhouse: Subscription resolved non paying`\
**Firmhouse event:** `subscription_resolved_non_paying`

Additional properties:

| Property | Description |
| - | - |
| `marked_as_non_paying` | Whether the subscription is marked as non-paying. |
| `outstanding_amount` | The subscription's outstanding amount. |
| `currency` | The currency. |

### Subscription discount applied

**Klaviyo metric:** `Firmhouse: Subscription discount applied`\
**Firmhouse event:** `subscription_discount_applied`

Additional properties:

| Property | Description |
| - | - |
| `promotion_ids` | A list of applied promotion IDs. |
| `discount_codes` | A list of applied discount codes. |
| `next_order_discount_percentages` | The discount percentages applied to the next order. |

### Subscription discount updated

**Klaviyo metric:** `Firmhouse: Subscription discount updated`\
**Firmhouse event:** `subscription_discount_updated`

Additional properties:

| Property | Description |
| - | - |
| `promotion_ids` | A list of applied promotion IDs. |
| `discount_codes` | A list of applied discount codes. |
| `next_order_discount_percentages` | The discount percentages applied to the next order. |

### Subscription discount deleted

**Klaviyo metric:** `Firmhouse: Subscription discount deleted`\
**Firmhouse event:** `subscription_discount_deleted`

Additional properties:

| Property | Description |
| - | - |
| `promotion_ids` | A list of applied promotion IDs. |
| `discount_codes` | A list of applied discount codes. |
| `next_order_discount_percentages` | The discount percentages applied to the next order. |

### Subscription upcoming billing

**Klaviyo metric:** `Firmhouse: Subscription upcoming billing`\
**Firmhouse event:** `subscription_upcoming_billing`

Additional properties:

| Property | Description |
| - | - |
| `order_id` | The order's ID. |
| `order_status` | The order's status. |
| `shipment_date` | The shipment date. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `shipping_costs_cents` | Shipping costs, in minor units. |
| `discount_cents` | The discount amount, in minor units. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |
| `tracking_codes` | The order's tracking codes. |
| `shopify_order_id` | The Shopify order ID. |
| `fulfilled_at` | When the order was fulfilled. |

### Subscription metadata updated

**Klaviyo metric:** `Firmhouse: Subscription metadata updated`\
**Firmhouse event:** `subscription_metadata_updated`

Additional properties:

| Property | Description |
| - | - |
| `metadata` | The subscription's additional metadata. |
| `changes` | The fields changed by this event. |

### Subscription marked non paying

**Klaviyo metric:** `Firmhouse: Subscription marked non paying`\
**Firmhouse event:** `subscription_marked_non_paying`

Additional properties:

| Property | Description |
| - | - |
| `marked_as_non_paying` | Whether the subscription is marked as non-paying. |
| `outstanding_amount` | The subscription's outstanding amount. |
| `currency` | The currency. |

## Plans

### Billing cycle skipped

**Klaviyo metric:** `Firmhouse: Billing cycle skipped`\
**Firmhouse event:** `billing_cycle_skipped`

Additional properties:

| Property | Description |
| - | - |
| `event_type` | The contract term event type. |
| `consumed_at` | When the contract term event was consumed. |
| `plan_id` | The plan's ID. |
| `plan_name` | The plan's name. |
| `invoice_id` | The invoice's ID. |

### Subscription plan changed

**Klaviyo metric:** `Firmhouse: Subscription plan changed`\
**Firmhouse event:** `subscribed_plan_plan_changed`

Additional properties:

| Property | Description |
| - | - |
| `plan_id` | The plan's ID. |
| `plan_name` | The plan's name. |
| `billing_cycle_interval` | The number of units between billing cycles. |
| `billing_cycle_unit` | The unit used for billing cycles, such as months. |
| `delivery_cycle_interval` | The number of units between deliveries. |
| `delivery_cycle_unit` | The unit used for delivery cycles, such as weeks. |

### Subscribed plan updated

**Klaviyo metric:** `Firmhouse: Subscribed plan updated`\
**Firmhouse event:** `subscribed_plan_updated`

Additional properties:

| Property | Description |
| - | - |
| `plan_id` | The plan's ID. |
| `plan_name` | The plan's name. |
| `billing_cycle_interval` | The number of units between billing cycles. |
| `billing_cycle_unit` | The unit used for billing cycles, such as months. |
| `delivery_cycle_interval` | The number of units between deliveries. |
| `delivery_cycle_unit` | The unit used for delivery cycles, such as weeks. |

## Subscription products

### Subscription product added

**Klaviyo metric:** `Firmhouse: Subscription product added`\
**Firmhouse event:** `ordered_product_created`

Additional properties:

| Property | Description |
| - | - |
| `ordered_product_id` | The subscription product's ID. |
| `ordered_product_status` | The subscription product's status. |
| `product_id` | The product's ID. |
| `product_name` | The product's name. |
| `product_sku` | The product's SKU. |
| `shopify_product_id` | The Shopify product ID. |
| `shopify_variant_id` | The Shopify variant ID. |
| `shopify_image_url` | The Shopify product image URL. |
| `quantity` | The product quantity. |
| `recurring` | Whether the product is recurring. |
| `price_cents` | The product price, in minor units. |

### Subscription product updated

**Klaviyo metric:** `Firmhouse: Subscription product updated`\
**Firmhouse event:** `ordered_product_updated`

Additional properties:

| Property | Description |
| - | - |
| `ordered_product_id` | The subscription product's ID. |
| `ordered_product_status` | The subscription product's status. |
| `product_id` | The product's ID. |
| `product_name` | The product's name. |
| `product_sku` | The product's SKU. |
| `shopify_product_id` | The Shopify product ID. |
| `shopify_variant_id` | The Shopify variant ID. |
| `shopify_image_url` | The Shopify product image URL. |
| `quantity` | The product quantity. |
| `recurring` | Whether the product is recurring. |
| `price_cents` | The product price, in minor units. |

### Subscription product removed

**Klaviyo metric:** `Firmhouse: Subscription product removed`\
**Firmhouse event:** `ordered_product_deleted`

Additional properties:

| Property | Description |
| - | - |
| `ordered_product_id` | The subscription product's ID. |
| `ordered_product_status` | The subscription product's status. |
| `product_id` | The product's ID. |
| `product_name` | The product's name. |
| `product_sku` | The product's SKU. |
| `shopify_product_id` | The Shopify product ID. |
| `shopify_variant_id` | The Shopify variant ID. |
| `shopify_image_url` | The Shopify product image URL. |
| `quantity` | The product quantity. |
| `recurring` | Whether the product is recurring. |
| `price_cents` | The product price, in minor units. |

### Subscription product out of stock

**Klaviyo metric:** `Firmhouse: Subscription product out of stock`\
**Firmhouse event:** `subscription_product_out_of_stock`

Additional properties:

| Property | Description |
| - | - |
| `product_id` | The product's ID. |
| `product_name` | The product's name. |
| `product_sku` | The product's SKU. |
| `shopify_product_id` | The Shopify product ID. |
| `shopify_variant_id` | The Shopify variant ID. |
| `shopify_image_url` | The Shopify product image URL. |
| `available` | Whether the product is available. |
| `in_stock` | Whether the product is in stock. |

### Subscription product back in stock

**Klaviyo metric:** `Firmhouse: Subscription product back in stock`\
**Firmhouse event:** `subscription_product_back_in_stock`

Additional properties:

| Property | Description |
| - | - |
| `product_id` | The product's ID. |
| `product_name` | The product's name. |
| `product_sku` | The product's SKU. |
| `shopify_product_id` | The Shopify product ID. |
| `shopify_variant_id` | The Shopify variant ID. |
| `shopify_image_url` | The Shopify product image URL. |
| `available` | Whether the product is available. |
| `in_stock` | Whether the product is in stock. |

## Orders

### Order confirmed

**Klaviyo metric:** `Firmhouse: Order confirmed`\
**Firmhouse event:** `order_confirmed`

Additional properties:

| Property | Description |
| - | - |
| `order_id` | The order's ID. |
| `order_status` | The order's status. |
| `shipment_date` | The shipment date. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `shipping_costs_cents` | Shipping costs, in minor units. |
| `discount_cents` | The discount amount, in minor units. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |
| `tracking_codes` | The order's tracking codes. |
| `shopify_order_id` | The Shopify order ID. |
| `fulfilled_at` | When the order was fulfilled. |
| `add_product_url` | A link to add a product to the subscription. |

### Order pending

**Klaviyo metric:** `Firmhouse: Order pending`\
**Firmhouse event:** `order_pending`

Additional properties:

| Property | Description |
| - | - |
| `order_id` | The order's ID. |
| `order_status` | The order's status. |
| `shipment_date` | The shipment date. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `shipping_costs_cents` | Shipping costs, in minor units. |
| `discount_cents` | The discount amount, in minor units. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |
| `tracking_codes` | The order's tracking codes. |
| `shopify_order_id` | The Shopify order ID. |
| `fulfilled_at` | When the order was fulfilled. |

### Order fulfilled

**Klaviyo metric:** `Firmhouse: Order fulfilled`\
**Firmhouse event:** `order_fulfilled`

Additional properties:

| Property | Description |
| - | - |
| `order_id` | The order's ID. |
| `order_status` | The order's status. |
| `shipment_date` | The shipment date. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `shipping_costs_cents` | Shipping costs, in minor units. |
| `discount_cents` | The discount amount, in minor units. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |
| `tracking_codes` | The order's tracking codes. |
| `shopify_order_id` | The Shopify order ID. |
| `fulfilled_at` | When the order was fulfilled. |

### Upcoming order notice

**Klaviyo metric:** `Firmhouse: Upcoming order notice`\
**Firmhouse event:** `upcoming_order_notice`

This event can also announce already-paid scheduled deliveries when **Also send before already-paid deliveries** is enabled in the project's upcoming order notice settings. These notices are sent seven days before shipment. Branch on `is_paid_delivery` to distinguish them from recurring-order notices. See [paid delivery setup](https://docs.firmhouse.com/configure/customer-communication/supported-emails-overview.md#upcoming-notices-for-already-paid-deliveries). Existing saved payloads need the new property added or the default update reviewed.

Additional properties:

| Property | Description |
| - | - |
| `order_id` | The order's ID. |
| `order_status` | The order's status. |
| `shipment_date` | The shipment date. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `shipping_costs_cents` | Shipping costs, in minor units. |
| `discount_cents` | The discount amount, in minor units. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |
| `tracking_codes` | The order's tracking codes. |
| `shopify_order_id` | The Shopify order ID. |
| `fulfilled_at` | When the order was fulfilled. |
| `products` | A list of products with their event details. |
| `confirmed_orders_count` | The number of confirmed and fulfilled orders. |
| `upcoming_order_number` | The upcoming order's number in the subscription. |
| `is_paid_delivery` | `true` for an already-paid scheduled delivery; `false` for a regular recurring-order notice. |
| `plan_id` | The ID of the subscription's plan. `null` when the subscription has no plan. |
| `plan_slug` | The slug of the subscription's plan. `null` when the subscription has no plan. |
| `payment_method_health_status` | The result of the payment method health check. |
| `payment_method_health_provider` | The payment provider checked. |
| `payment_method_health_reason` | The reason for the health check result. |
| `payment_method_health_checked_at` | When the payment method was checked. |
| `payment_method_health_expires_on` | The payment method's expiration date. |
| `update_payment_method_url` | A link to update the payment method. |
| `pause_subscription_url` | A link to pause the subscription. |
| `snooze_upcoming_order_url` | A link to snooze the upcoming order. |
| `skip_upcoming_order_url` | A link to skip the upcoming order. |
| `offers` | A list of eligible promotional offers with their event details. |
| `offer_ids` | A list of eligible promotional offer IDs. |
| `offer_count` | The number of eligible promotional offers. |
| `offer_<slug>_accept_url` | A link to accept this eligible offer. |
| `offer_<slug>_image_url` | The offer's featured product image URL, when available. |
| `offer_<slug>_title` | The offer's title. |

The `products` list contains each order line's product details, including names, quantities, SKUs, and image URLs. The `offers` list contains eligible offers.

**Individual offer properties:** Firmhouse replaces `<slug>` with the offer's slug. For example, an eligible offer with the slug `add-coffee` adds these properties directly to the event:

| Example property | Description |
| - | - |
| `offer_add-coffee_accept_url` | The link to accept the add-coffee offer. |
| `offer_add-coffee_image_url` | The featured product's image URL. |
| `offer_add-coffee_title` | The offer's title, such as “Add coffee to your next order”. |

These properties appear only when the customer has an eligible offer. If multiple eligible offers share the same slug, these properties use the offer that expires soonest.

### Tracking code added

**Klaviyo metric:** `Firmhouse: Tracking code added`\
**Firmhouse event:** `tracking_code_added`

Additional properties:

| Property | Description |
| - | - |
| `order_id` | The order's ID. |
| `order_status` | The order's status. |
| `shipment_date` | The shipment date. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `shipping_costs_cents` | Shipping costs, in minor units. |
| `discount_cents` | The discount amount, in minor units. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |
| `tracking_codes` | The order's tracking codes. |
| `shopify_order_id` | The Shopify order ID. |
| `fulfilled_at` | When the order was fulfilled. |

### Order scheduled

**Klaviyo metric:** `Firmhouse: Order scheduled`\
**Firmhouse event:** `order_scheduled`

Additional properties:

| Property | Description |
| - | - |
| `order_id` | The order's ID. |
| `order_status` | The order's status. |
| `shipment_date` | The shipment date. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `shipping_costs_cents` | Shipping costs, in minor units. |
| `discount_cents` | The discount amount, in minor units. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |
| `tracking_codes` | The order's tracking codes. |
| `shopify_order_id` | The Shopify order ID. |
| `fulfilled_at` | When the order was fulfilled. |

### Order pre confirmation

**Klaviyo metric:** `Firmhouse: Order pre confirmation`\
**Firmhouse event:** `order_pre_confirmation`

Additional properties:

| Property | Description |
| - | - |
| `order_id` | The order's ID. |
| `order_status` | The order's status. |
| `shipment_date` | The shipment date. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `shipping_costs_cents` | Shipping costs, in minor units. |
| `discount_cents` | The discount amount, in minor units. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `product_skus` | A list of product SKUs. |
| `shopify_product_ids` | A list of Shopify product IDs. |
| `shopify_variant_ids` | A list of Shopify variant IDs. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |
| `tracking_codes` | The order's tracking codes. |
| `shopify_order_id` | The Shopify order ID. |
| `fulfilled_at` | When the order was fulfilled. |

### Recurring order skipped

**Klaviyo metric:** `Firmhouse: Recurring order skipped`\
**Firmhouse event:** `recurring_order_skipped`

Additional properties:

| Property | Description |
| - | - |
| `next_billing_date` | The next billing date. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `reason` | The reason for this event. |

### Order invoice ready

**Klaviyo metric:** `Firmhouse: Order invoice ready`\
**Firmhouse event:** `order_invoice_ready`

Additional properties:

| Property | Description |
| - | - |
| `invoice_id` | The invoice's ID. |
| `invoice_number` | The invoice number. |
| `invoice_status` | The invoice's status. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `invoiced_at` | When the invoice was issued. |
| `order_id` | The order's ID. |
| `line_item_descriptions` | A list of invoice line descriptions. |
| `line_item_types` | A list of invoice line types. |
| `line_item_quantities` | A list of invoice line quantities. |

## Invoices

### Invoice invoiced

**Klaviyo metric:** `Firmhouse: Invoice invoiced`\
**Firmhouse event:** `invoice_invoiced`

Additional properties:

| Property | Description |
| - | - |
| `invoice_id` | The invoice's ID. |
| `invoice_number` | The invoice number. |
| `invoice_status` | The invoice's status. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `invoiced_at` | When the invoice was issued. |
| `order_id` | The order's ID. |
| `line_item_descriptions` | A list of invoice line descriptions. |
| `line_item_types` | A list of invoice line types. |
| `line_item_quantities` | A list of invoice line quantities. |

### Invoice paid

**Klaviyo metric:** `Firmhouse: Invoice paid`\
**Firmhouse event:** `invoice_paid`

Additional properties:

| Property | Description |
| - | - |
| `invoice_id` | The invoice's ID. |
| `invoice_number` | The invoice number. |
| `invoice_status` | The invoice's status. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `invoiced_at` | When the invoice was issued. |
| `order_id` | The order's ID. |
| `line_item_descriptions` | A list of invoice line descriptions. |
| `line_item_types` | A list of invoice line types. |
| `line_item_quantities` | A list of invoice line quantities. |

### Outstanding invoices

**Klaviyo metric:** `Firmhouse: Outstanding invoices`\
**Firmhouse event:** `outstanding_invoices`

Additional properties:

| Property | Description |
| - | - |
| `invoice_ids` | A list of invoice IDs. |
| `invoice_numbers` | A list of invoice numbers. |
| `invoice_statuses` | A list of invoice statuses. |
| `invoice_amounts_cents` | A list of invoice amounts, in minor units. |
| `outstanding_invoice_count` | The number of outstanding invoices. |
| `currency` | The currency. |

#### When this event is sent

This event isn't sent in real time. Firmhouse runs a daily check and sends it for each subscription that is marked as [non-paying](https://docs.firmhouse.com/configure/payment-dunning/non-paying-customer-status.md) and has outstanding invoices. A subscription receives this event at most once every 7 days, so a customer who stays non-paying with unpaid invoices receives it again after a week.

This event is separate from the [Outstanding invoices email](https://docs.firmhouse.com/configure/payment-dunning/overview-of-payment-dunning-options.md#outstanding-invoices-notification). Turning on the lifecycle event doesn't send that email to your customers, and the event is still sent when the email is turned off.

#### Test this event

**Send test event** isn't available for this event. To trigger the event itself, use a test subscription that is marked as non-paying and has an outstanding invoice, then wait for the next daily check.

To rehearse your Klaviyo flow straight away, use the `sendSubscriptionKlaviyoEvent` GraphQL mutation with `eventName` set to `Firmhouse: Outstanding invoices` and `properties` containing the keys listed above: `invoice_ids`, `invoice_numbers`, `invoice_statuses`, `invoice_amounts_cents`, `outstanding_invoice_count`, and `currency`. This sends a bespoke event with the same metric name rather than triggering the lifecycle event. See [Bespoke Klaviyo events](https://docs.firmhouse.com/developers/guides/send-bespoke-subscription-notifications.md#bespoke-klaviyo-events-including-v2) in the developer guide.

### Invoice reminder sent

**Klaviyo metric:** `Firmhouse: Invoice reminder sent`\
**Firmhouse event:** `invoice_reminder_sent`

Additional properties:

| Property | Description |
| - | - |
| `invoice_id` | The invoice's ID. |
| `invoice_number` | The invoice number. |
| `invoice_status` | The invoice's status. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `reminder_number` | The invoice reminder number. |
| `final_reminder` | Whether this is the final invoice reminder. |
| `order_status` | The status of an unsubmitted pending order, when present; otherwise the latest related order. `null` when the invoice has no order. |
| `shopify_order_id` | The Shopify ID of the order represented by `order_status`; `null` when that order was not sent to Shopify. |
| `pending_retries` | Whether a payment retry is still in progress for the invoice. |

## Payments

### Payment failed

**Klaviyo metric:** `Firmhouse: Payment failed`\
**Firmhouse event:** `payment_failed`

Additional properties:

| Property | Description |
| - | - |
| `payment_id` | The payment's ID. |
| `payment_status` | The payment's status. |
| `payment_type` | The type of payment. |
| `failure_reason` | The reason the payment failed. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `attempts_count` | The number of payment attempts. |
| `scheduled_retry_on` | The scheduled date for the next payment attempt. |
| `invoice_id` | The invoice's ID. |
| `invoice_status` | The invoice's status. |
| `pay_now_url` | A link to pay now. |

### Payment succeeded

**Klaviyo metric:** `Firmhouse: Payment succeeded`\
**Firmhouse event:** `payment_succeeded`

Additional properties:

| Property | Description |
| - | - |
| `payment_id` | The payment's ID. |
| `payment_status` | The payment's status. |
| `payment_type` | The type of payment. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `invoice_id` | The invoice's ID. |
| `invoice_status` | The invoice's status. |

### Payment refunded

**Klaviyo metric:** `Firmhouse: Payment refunded`\
**Firmhouse event:** `payment_refunded`

Additional properties:

| Property | Description |
| - | - |
| `payment_id` | The payment's ID. |
| `payment_status` | The payment's status. |
| `payment_type` | The type of payment. |
| `amount_cents` | The amount, in minor units. |
| `currency` | The currency. |
| `invoice_id` | The invoice's ID. |
| `invoice_status` | The invoice's status. |
| `refund_ids` | A list of refund IDs. |
| `refund_statuses` | A list of refund statuses. |
| `refund_amounts_cents` | A list of refund amounts, in minor units. |
| `refund_reasons` | A list of refund reasons. |

## Returns

### Return order created

**Klaviyo metric:** `Firmhouse: Return order created`\
**Firmhouse event:** `return_order_created`

Additional properties:

| Property | Description |
| - | - |
| `return_order_id` | The return order's ID. |
| `return_order_status` | The return order's status. |
| `reason` | The reason for this event. |
| `desired_return_date` | The requested return date. |
| `returned_on` | The date the return was received. |
| `tracking_code` | The return's tracking code. |
| `external_reference` | The return's external reference. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |

### Return order completed

**Klaviyo metric:** `Firmhouse: Return order completed`\
**Firmhouse event:** `return_order_completed`

Additional properties:

| Property | Description |
| - | - |
| `return_order_id` | The return order's ID. |
| `return_order_status` | The return order's status. |
| `reason` | The reason for this event. |
| `desired_return_date` | The requested return date. |
| `returned_on` | The date the return was received. |
| `tracking_code` | The return's tracking code. |
| `external_reference` | The return's external reference. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |

### Return order cancelled

**Klaviyo metric:** `Firmhouse: Return order cancelled`\
**Firmhouse event:** `return_order_cancelled`

Additional properties:

| Property | Description |
| - | - |
| `return_order_id` | The return order's ID. |
| `return_order_status` | The return order's status. |
| `reason` | The reason for this event. |
| `desired_return_date` | The requested return date. |
| `returned_on` | The date the return was received. |
| `tracking_code` | The return's tracking code. |
| `external_reference` | The return's external reference. |
| `product_ids` | A list of product IDs. |
| `product_names` | A list of product names. |
| `shopify_image_urls` | A list of Shopify product image URLs. |
| `product_quantities` | A list of product quantities. |

## Acceptance checks

### Subscription acceptance check created

**Klaviyo metric:** `Firmhouse: Subscription acceptance check created`\
**Firmhouse event:** `subscription_acceptance_check_created`

Additional properties:

| Property | Description |
| - | - |
| `acceptance_check_id` | The acceptance check's ID. |
| `acceptance_check_name` | The acceptance check's name. |
| `acceptance_check_status` | The acceptance check's status. |

### Subscription acceptance check pending

**Klaviyo metric:** `Firmhouse: Subscription acceptance check pending`\
**Firmhouse event:** `subscription_acceptance_check_pending`

Additional properties:

| Property | Description |
| - | - |
| `acceptance_check_id` | The acceptance check's ID. |
| `acceptance_check_name` | The acceptance check's name. |
| `acceptance_check_status` | The acceptance check's status. |

### Subscription acceptance check accepted

**Klaviyo metric:** `Firmhouse: Subscription acceptance check accepted`\
**Firmhouse event:** `subscription_acceptance_check_accepted`

Additional properties:

| Property | Description |
| - | - |
| `acceptance_check_id` | The acceptance check's ID. |
| `acceptance_check_name` | The acceptance check's name. |
| `acceptance_check_status` | The acceptance check's status. |

### Subscription acceptance check rejected

**Klaviyo metric:** `Firmhouse: Subscription acceptance check rejected`\
**Firmhouse event:** `subscription_acceptance_check_rejected`

Additional properties:

| Property | Description |
| - | - |
| `acceptance_check_id` | The acceptance check's ID. |
| `acceptance_check_name` | The acceptance check's name. |
| `acceptance_check_status` | The acceptance check's status. |

## Collection cases

### Collection case created

**Klaviyo metric:** `Firmhouse: Collection case created`\
**Firmhouse event:** `collection_case_created`

Additional properties:

| Property | Description |
| - | - |
| `collection_case_id` | The collection case's ID. |
| `collection_case_status` | The collection case's status. |
| `case_number` | The collection case number. |
| `case_type` | The type of collection case. |
| `invoice_ids` | A list of invoice IDs. |
| `invoice_numbers` | A list of invoice numbers. |
| `invoice_statuses` | A list of invoice statuses. |

### Collection case open

**Klaviyo metric:** `Firmhouse: Collection case open`\
**Firmhouse event:** `collection_case_open`

Additional properties:

| Property | Description |
| - | - |
| `collection_case_id` | The collection case's ID. |
| `collection_case_status` | The collection case's status. |
| `case_number` | The collection case number. |
| `case_type` | The type of collection case. |
| `invoice_ids` | A list of invoice IDs. |
| `invoice_numbers` | A list of invoice numbers. |
| `invoice_statuses` | A list of invoice statuses. |

### Collection case closed

**Klaviyo metric:** `Firmhouse: Collection case closed`\
**Firmhouse event:** `collection_case_closed`

Additional properties:

| Property | Description |
| - | - |
| `collection_case_id` | The collection case's ID. |
| `collection_case_status` | The collection case's status. |
| `case_number` | The collection case number. |
| `case_type` | The type of collection case. |
| `invoice_ids` | A list of invoice IDs. |
| `invoice_numbers` | A list of invoice numbers. |
| `invoice_statuses` | A list of invoice statuses. |

## Retention

### Churn request initiated

**Klaviyo metric:** `Firmhouse: Churn request initiated`\
**Firmhouse event:** `churn_request_initiated`

Additional properties:

| Property | Description |
| - | - |
| `churn_request_id` | The cancellation or pause request's ID. |
| `churn_request_status` | The request's status. |
| `flow` | The flow used for the request. |
| `follow_up_action` | The follow-up action for the request. |
| `reason` | The reason for this event. |
| `feedback` | The customer's feedback. |
| `created_at` | When the record was created. |
| `updated_at` | When the record was last updated. |

### Churn request prevented

**Klaviyo metric:** `Firmhouse: Churn request prevented`\
**Firmhouse event:** `churn_request_prevented`

Additional properties:

| Property | Description |
| - | - |
| `churn_request_id` | The cancellation or pause request's ID. |
| `churn_request_status` | The request's status. |
| `flow` | The flow used for the request. |
| `follow_up_action` | The follow-up action for the request. |
| `reason` | The reason for this event. |
| `feedback` | The customer's feedback. |
| `created_at` | When the record was created. |
| `updated_at` | When the record was last updated. |

### Churn request completed

**Klaviyo metric:** `Firmhouse: Churn request completed`\
**Firmhouse event:** `churn_request_completed`

Additional properties:

| Property | Description |
| - | - |
| `churn_request_id` | The cancellation or pause request's ID. |
| `churn_request_status` | The request's status. |
| `flow` | The flow used for the request. |
| `follow_up_action` | The follow-up action for the request. |
| `reason` | The reason for this event. |
| `feedback` | The customer's feedback. |
| `created_at` | When the record was created. |
| `updated_at` | When the record was last updated. |

### Churn request feedback updated

**Klaviyo metric:** `Firmhouse: Churn request feedback updated`\
**Firmhouse event:** `churn_request_feedback_updated`

Additional properties:

| Property | Description |
| - | - |
| `churn_request_id` | The cancellation or pause request's ID. |
| `churn_request_status` | The request's status. |
| `flow` | The flow used for the request. |
| `follow_up_action` | The follow-up action for the request. |
| `reason` | The reason for this event. |
| `feedback` | The customer's feedback. |
| `created_at` | When the record was created. |
| `updated_at` | When the record was last updated. |

### Promotional offer issued

**Klaviyo metric:** `Firmhouse: Promotional offer issued`\
**Firmhouse event:** `promotional_offer_issued`

Sent when you send an offer from **Offers > Send**, either to one subscription or to all eligible subscriptions. The event includes a direct link that signs the customer in and opens the offer, valid until the offer expires. When Klaviyo is connected, Firmhouse turns this event on the first time you send an offer. Without Klaviyo or a webhook for this event, the offer is still issued and customers see it in their portal, but nothing is sent.

Additional properties:

| Property | Description |
| - | - |
| `promotional_offer_id` | The issued offer's ID. |
| `offer_definition_id` | The configured offer's ID. |
| `offer_definition_name` | The configured offer's name. |
| `offer_slug` | The stable identifier shared by all issued offers from this configuration. |
| `title` | The customer-facing offer title. |
| `description` | The customer-facing offer description. |
| `benefit_label` | What the customer receives. |
| `expires_at` | When the offer expires. |
| `accept_url` | A direct link where the customer can review and accept the offer. |
| `upsell_product` | The product and quantity for an upsell offer, otherwise `null`. |

### Promotional offer accepted

**Klaviyo metric:** `Firmhouse: Promotional offer accepted`

**Firmhouse event:** `promotional_offer_accepted`

Additional properties:

| Property | Description |
| - | - |
| `churn_request_id` | The cancellation request's ID. |
| `churn_request_status` | The request's status. |
| `flow` | The flow used for the request. |
| `reason` | The selected cancellation reason. |
| `promotional_offer_id` | The accepted issued-offer ID. |
| `offer_definition_id` | The configured offer's ID. |
| `offer_definition_name` | The configured offer's name. |
| `accepted_at` | When the offer was accepted. |
| `entry_point` | Where the offer was accepted. |
| `benefit` | The accepted benefit snapshot. |
| `commitment_snapshot` | The optional accepted commitment snapshot. |

## Offers and referrals

### Purchase offer completed

**Klaviyo metric:** `Firmhouse: Offer completed`\
**Firmhouse event:** `offer_completed`

This metric tracks an invoice-linked purchase offer after its invoice is paid, such as an asset purchase or plan change. It does not track acceptance of a churn-prevention promotional offer; use `promotional_offer_accepted` for that.

Additional properties:

| Property | Description |
| - | - |
| `offer_id` | The offer's ID. |
| `offer_status` | The offer's status. |
| `offer_type` | The type of offer. |
| `plan_id` | The plan's ID. |
| `plan_name` | The plan's name. |
| `invoice_id` | The invoice's ID. |
| `created_at` | When the record was created. |
| `expires_at` | When the offer expires. |

### Referral reward applied

**Klaviyo metric:** `Firmhouse: Referral reward applied`\
**Firmhouse event:** `referral_reward_applied`

Additional properties:

| Property | Description |
| - | - |
| `referral_code` | The subscription's referral code. |

## Customer access

### Login token created

**Klaviyo metric:** `Firmhouse: Login token created`\
**Firmhouse event:** `login_token_created`

Additional properties:

| Property | Description |
| - | - |
| `login_url` | A link for the customer to sign in. |

## Assets

### Asset assigned

**Klaviyo metric:** `Firmhouse: Asset assigned`\
**Firmhouse event:** `asset_assigned`

Additional properties:

| Property | Description |
| - | - |
| `asset_id` | The asset's ID. |
| `asset_status` | The asset's status. |
| `internal_number` | The asset's internal number. |
| `external_number` | The asset's external number. |
| `product_id` | The product's ID. |
| `product_name` | The product's name. |
| `product_sku` | The product's SKU. |
| `shopify_image_url` | The Shopify product image URL. |

## Customer details

### Extra field answer updated

**Klaviyo metric:** `Firmhouse: Extra field answer updated`\
**Firmhouse event:** `extra_field_answer_updated`

Additional properties:

| Property | Description |
| - | - |
| `extra_field_answer_id` | The extra field answer's ID. |
| `extra_field_id` | The extra field's ID. |
| `field_name` | The extra field's name. |
| `field_key` | The extra field's key. |
| `field_value` | The formatted value of the extra field. |
| `changes` | The fields changed by this event. |

## Related articles

* [Getting started with Klaviyo](https://docs.firmhouse.com/integrations/klaviyo/getting-started.md)
* [Klaviyo metrics via outgoing webhooks](https://docs.firmhouse.com/integrations/klaviyo/metric-webhooks.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.