Sign in

v7

latestOpenAPI 3.1.02026-08-051856761.1 MB
subscriptions
public

Export Subscriptions

Export subscriptions as a CSV file.

Scopes: subscriptions:read subscriptions:write

get/v1/subscriptions/export

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

string uuid4

The product ID.

OR
string[]

Filter by product ID.

'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'paused'
OR
SubscriptionStatus[]

Filter by subscription status.

cancel_at_period_endboolean nullable

Filter by subscriptions that are set to cancel at period end.

Filter by subscriptions that are set to cancel at period end.

started_afterstring date-time nullable

Only include subscriptions started after this date. Must include a UTC offset.

Only include subscriptions started after this date. Must include a UTC offset.

started_beforestring date-time nullable

Only include subscriptions started before this date. Must include a UTC offset.

Only include subscriptions started before this date. Must include a UTC offset.

timezonestring

Time zone used to render dates in the CSV.

Time zone used to render dates in the CSV.

'email' | 'started_at' | 'product' | 'amount' | 'currency' | 'status' | 'recurring_interval' | 'customer_name' | 'billing_name' | 'billing_country' | 'net_amount' | 'discount' | 'seats' | 'current_period_start' | 'current_period_end' | 'cancel_at_period_end' | 'canceled_at' | 'ends_at' | 'ended_at' | 'cancellation_reason' | 'trial_start' | 'trial_end'
OR
SubscriptionExportColumn[]

Columns to include in the CSV, in order. Defaults to email, started_at, product, amount, currency, status and recurring_interval.

Response

Successful Response