Export Data

This page will help you get started with Export Data.

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

ColumnDescription
Subscription IDThe Shopify ID of the subscription (integer)
StatusCurrent subscription status: ACTIVE, PAUSED, or CANCELLED
Created DateWhen the subscription was created in the system
Next Billing DateThe next scheduled billing date for the subscription
Cancelled DateThe most recent cancellation date
Cancellation ReasonThe reason selected by the customer for cancellation
Cancellation Other ReasonFree-text reason provided when "Other" is selected
CurrencyCurrency code for the subscription
Cart ValueSum of cart discounted amounts converted to merchant currency (duplicated across line rows)
Shipping PriceShipping cost converted to merchant currency
PrepaidIndicates whether the subscription is prepaid
FrequencyBilling policy interval (e.g., "2 weeks")
Address 1Subscription shipping address line 1
Address 2Subscription shipping address line 2
CityShipping address city
ProvinceShipping address province/state
ZipShipping address postal code
CountryShipping address country
Dunning Started DateWhen the subscription entered dunning status
Dunning Ended DateWhen the subscription exited dunning status
Out of Stock Billing AttemptsNumber of billing attempts failed due to out-of-stock items
Failed Billing AttemptsNumber of billing attempts that failed for any reason
NotesNotes associated with the subscription
Churn Risk StatusMachine learning prediction: "At Risk" or "Not At Risk"
Order NotesNotes associated with orders
Discount CodesActive discount codes on the subscription
Customer IDShopify customer ID (integer)
First NameCustomer first name
Last NameCustomer last name
EmailCustomer email address
PhoneCustomer phone number
Orders on StayTotal number of orders recorded for this subscription
Total SpentSum of all order amounts for this subscription in merchant currency
Total DiscountsSum of all cart discounts for orders in merchant currency
Total ShippingSum of all shipping costs for orders in merchant currency
Total TaxSum of all tax costs for orders in merchant currency
AOVAverage order value (Total Spent ÷ Orders on Stay)
Most Recent Bill DateDate of the most recent order (Shopify timestamp)
Line IDShopify line item ID (UUID)
Line Added DateUTC timestamp when the line was created in the database
Product NameName of the product
Variant NameName of the product variant
SKUStock keeping unit for the variant
Product IDShopify product ID (integer)
Variant IDShopify variant ID (integer)
Line Item TypeEither onetime (non-recurring) or subscription (recurring)
Line QuantityQuantity subscribed for this product
Line Full PricePrice before discounts, converted from customer currency
Line Discounted PricePrice after discounts, converted from customer currency
Selling Plan IDShopify selling plan ID (integer)
Selling Plan Pricing PoliciesComma-separated list of pricing policies
Selling Plan Billing PolicyBilling 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.

Columns

ColumnDescription
Order IDShopify order ID (integer)
Orders On StayTotal number of orders recorded for the subscription
Created DateWhen the order was created in Shopify
CurrencyMerchant currency at the time of order
Order TotalTotal order amount in merchant currency
Cart DiscountCart-level discount applied to the order
TaxTax amount for the order
ShippingShipping cost for the order
Migrated SubscriptionIndicates if the subscription was migrated from another system
Partially FulfilledIndicates if the order was partially fulfilled
PromotionsNumber of promotions this subscription was eligible for
Prepaid Total AOVAverage order value for the current prepaid cycle (total price ÷ total orders)
Prepaid Discount AOVAverage discount for the current prepaid cycle (total discounts ÷ total orders)
Prepaid Tax AOVAverage tax for the current prepaid cycle (total tax ÷ total orders)
Prepaid Shipping AOVAverage shipping for the current prepaid cycle (total shipping ÷ total orders)
Prepaid Cycle NumberThe cycle number for prepaid orders
Total Orders in Prepaid CycleNumber of orders in the current prepaid cycle
Prepaid Cycle Start DateDate of the first order in this prepaid cycle
Prepaid Cycle Start Order IDOrder ID of the first order in this prepaid cycle
Subscription IDShopify subscription ID (integer)
Subscription Created DateWhen the subscription was created
Address 1Order shipping address line 1
Address 2Order shipping address line 2
CityShipping address city
ProvinceShipping address province/state
CountryShipping address country
ZipShipping address postal code
Customer IDShopify customer ID (integer)
First NameCustomer first name
Last NameCustomer last name
EmailCustomer email address
PhoneCustomer phone number
Product NameName of the product
Variant NameName of the product variant
SKUStock keeping unit for the variant
Product IDShopify product ID (integer)
Variant IDShopify variant ID (integer)
Line Item TypeEither onetime or subscription
Line QuantityQuantity ordered
Line Full PricePrice before discounts in merchant currency
Line Discounted PricePrice 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

ColumnDescription
EVENT_DATE_UTCUTC timestamp when the Retention Engine session event occurred
CUSTOMER_IDShopify customer ID
EMAILCustomer email address
SUBSCRIPTION_IDShopify subscription ID
CANCELLATION_REASONReason selected by the customer for cancellation
CANCELLATION_REASON_OTHERFree-text reason when "Other" is selected
SAVE_OFFER_SHOWNThe save offer presented during the session
OUTCOMEResult of the session (e.g., saved or cancelled)
SAVE_OFFER_CLAIMEDSave offer claimed by the customer (may be the shown offer or pause option)
PRODUCTSList of all products associated with the subscription at event time
START_DATE_UTCUTC timestamp when the subscription was created in Shopify
CANCELLED_DATE_UTCUTC timestamp when the customer clicked the cancellation button (if applicable)

Notes

All date fields are provided in UTC format. Price metrics are returned in merchant currency for consistency across exports.

Language
Credentials
Header
Click Try It! to start a request and see the response here!