Data Exports

Our data export endpoint allows you to request exports asynchronously. When you make a POST request to this endpoint, the system will process your request and deliver the resulting data export to your specified webhook URL. See Create Webhook Subscription.

Export Types

SUBSCRIPTION

The Subscription export provides data at the subscription line level. Each row represents a unique subscription line item (associated with a specific product/variant), meaning the subscription ID may appear multiple times across rows.

Columns

Column	Description
Subscription ID	The Shopify ID of the subscription (integer)
Status	Current subscription status: `ACTIVE`, `PAUSED`, or `CANCELLED`
Created Date (US/Eastern)	When the subscription was created in the system in the US/Eastern timezone
Updated Date (US/Eastern)	When the subscription was last updated in the system in the US/Eastern timezone
Next Billing Date (US/Eastern)	The next scheduled billing date for the subscription in the US/Eastern timezone
Cancelled Date (US/Eastern)	The most recent cancellation date in the US/Eastern timezone
Cancellation Reason	The reason selected by the customer for cancellation
Cancellation Other Reason	Free-text reason provided when "Other" is selected
Currency	Currency code for the subscription
Cart Value	Sum of cart discounted amounts converted to merchant currency (duplicated across line rows)
Shipping Price	Shipping cost converted to merchant currency
Prepaid	Indicates whether the subscription is prepaid
Frequency	Billing policy interval (e.g., "2 weeks")
Address 1	Subscription shipping address line 1
Address 2	Subscription shipping address line 2
City	Shipping address city
Province	Shipping address province/state
Zip	Shipping address postal code
Country	Shipping address country
Dunning Started Date (US/Eastern)	When the subscription entered dunning status in the US/Eastern timezone
Dunning Ended Date (US/Eastern)	When the subscription exited dunning status in the US/Eastern timezone
Out of Stock Billing Attempts	Number of billing attempts failed due to out-of-stock items
Failed Billing Attempts	Number of billing attempts that failed for any reason
Notes	Notes associated with the subscription
Churn Risk Status	Machine learning prediction: "At Risk" or "Not At Risk"
Order Notes	Notes associated with orders
Discount Codes	Active discount codes on the subscription
Customer ID	Shopify customer ID (integer)
First Name	Customer first name
Last Name	Customer last name
Email	Customer email address
Phone	Customer phone number
Orders on Stay	Total number of orders recorded for this subscription
Total Spent	Sum of all order amounts for this subscription in merchant currency
Total Discounts	Sum of all cart discounts for orders in merchant currency
Total Shipping	Sum of all shipping costs for orders in merchant currency
Total Tax	Sum of all tax costs for orders in merchant currency
AOV	Average order value (Total Spent ÷ Orders on Stay)
Most Recent Bill Date (US/Eastern)	Date of the most recent order in the US/Eastern timezone
Line ID	Shopify line item ID (UUID)
Line Added Date (US/Eastern)	UTC timestamp when the line was created in the database in the US/Eastern timezone
Product Name	Name of the product
Variant Name	Name of the product variant
SKU	Stock keeping unit for the variant
Product ID	Shopify product ID (integer)
Variant ID	Shopify variant ID (integer)
Line Item Type	Either `onetime` (non-recurring) or `subscription` (recurring)
Line Quantity	Quantity subscribed for this product
Line Full Price	Price before discounts, converted from customer currency
Line Discounted Price	Price after discounts, converted from customer currency
Selling Plan ID	Shopify selling plan ID (integer)
Selling Plan Pricing Policies	Comma-separated list of pricing policies
Selling Plan Billing Policy	Billing interval (e.g., "every 2 weeks")

ORDER

The Order export provides data at the order line level. Order-level metrics are duplicated across rows, with each row representing a unique line item within an order. Shopify orders may be duplicated if they belong to more than one subscription.

Columns

Column	Description
Stay Order ID	Stay's internal order ID (cuid)
Order ID	Shopify order ID (integer)
Created Date	When the order was created in Shopify
Currency	Merchant currency at the time of order
Order Total	Total order amount in merchant currency
Cart Discount	Cart-level discount applied to the order
Tax	Tax amount for the order
Shipping	Shipping cost for the order
Partially Fulfilled	Indicates if the order was partially fulfilled
Subscription ID	Shopify subscription ID (integer)
Migrated Subscription	Indicates if the subscription was migrated from another system
Orders On Stay	Total number of orders recorded for the subscription
Promotions	Number of promotions this subscription was eligible for
Subscription Created Date	When the subscription was created
Address 1	Order shipping address line 1
Address 2	Order shipping address line 2
City	Shipping address city
Province	Shipping address province/state
Zip	Shipping address postal code
Country	Shipping address country
Prepaid Total AOV	Average order value for the current prepaid cycle (total price ÷ total orders)
Prepaid Discount AOV	Average discount for the current prepaid cycle (total discounts ÷ total orders)
Prepaid Tax AOV	Average tax for the current prepaid cycle (total tax ÷ total orders)
Prepaid Shipping AOV	Average shipping for the current prepaid cycle (total shipping ÷ total orders)
Prepaid Cycle Number	The cycle number for prepaid orders
Total Orders in Prepaid Cycle	Number of orders in the current prepaid cycle
Prepaid Cycle Start Date	Date of the first order in this prepaid cycle
Prepaid Cycle Start Order ID	Order ID of the first order in this prepaid cycle
Customer ID	Shopify customer ID (integer)
First Name	Customer first name
Last Name	Customer last name
Email	Customer email address
Phone	Customer phone number
Order Line ID	Shopify order line ID (integer)
Product Name	Name of the product
Variant Name	Name of the product variant
SKU	Stock keeping unit for the variant
Product ID	Shopify product ID (integer)
Variant ID	Shopify variant ID (integer)
Line Item Type	Either `onetime` or `subscription`
Line Quantity	Quantity ordered
Line Full Price	Price before discounts in merchant currency
Line Discounted Price	Price after discounts in merchant currency

RETENTION_ENGINE_SESSION

The Retention Engine Session export captures data from customer offboarding flows, specifically when customers attempt to cancel their subscriptions through Retention Engine.

Columns

Column	Description
EVENT_DATE_UTC	UTC timestamp when the Retention Engine session event occurred
CUSTOMER_ID	Shopify customer ID
EMAIL	Customer email address
SUBSCRIPTION_ID	Shopify subscription ID
CANCELLATION_REASON	Reason selected by the customer for cancellation
CANCELLATION_REASON_OTHER	Free-text reason when "Other" is selected
SAVE_OFFER_SHOWN	The save offer presented during the session
OUTCOME	Result of the session (e.g., saved or cancelled)
SAVE_OFFER_CLAIMED	Save offer claimed by the customer (may be the shown offer or pause option)
PRODUCTS	List of all products associated with the subscription at event time
START_DATE_UTC	UTC timestamp when the subscription was created in Shopify
CANCELLED_DATE_UTC	UTC timestamp when the customer clicked the cancellation button (if applicable)

CUSTOMER_PORTAL_METRICS_BY_SUBSCRIPTION

The Customer Portal Metrics by Subscription export pulls events generated by each subscription within the time range.

Columns

Column	Description
Event Date (US/Eastern)	Timestamp when the event took place in the US/Eastern timezone
Subscription ID	Shopify subscription ID
Subscription Created Date (US/Eastern)	Timestamp when the subscription was created in the US/Eastern timezone
Event Type	Which event took place, one of `Got It Now`, `Skipped`, `Swapped`, `Gifted Next Order`, `Changed Order Date`, `Updated Status`, `Changed Billing Policy`, or `Added Banner Ad`
From Value	Indicates the previous value when applicable
To Value	Indicates the updated value when applicable

FAILED_BILLING

The Failed Billing export pulls failed billing attempts within the time range.

Columns

Column	Description
Billing Attempt ID	Either a common ID, such as `out_of_stock` or `contract_error` for generic error codes, or a unique ID (integer) for customer specific errors
Billing Attempt Date (US/Eastern)	Timestamp when the event took place in the US/Eastern timezone
Error Code	Indicates the specific error that occurred
Error Message	A message further explaining the code
Subscription ID	The Shopify ID of the subscription (integer)
Currency	The currency code of the subscription
Projected Sales Price	The current valuation of the cart in merchant currency
Customer Name	The first and last name of the customer
Retry Source	An indicator on where the billing attempt was triggered
Failed Billing Attempt #	The attempt number of this billing attempt within the recovery session
Recovery ID	The internal ID used to track which recovery session this billing attempt belongs to
Date of Initial Failure (US/Eastern)	The date of the first billing attempt in this recovery session in the US/Eastern timezone
Initial Error Code	The error code of the first billing attempt in this recovery session
Initial Error Message	The error message of the first billing attempt in this recovery session

Notes

All date fields are provided in US/Eastern, unless otherwise noted. Price metrics are returned in merchant currency for consistency across exports.

200200

422422