POpolar
subscriptions
public

Export Subscriptions

Changed on

Export subscriptions as a CSV file.

Scopes: subscriptions:read subscriptions:write

get/v1/subscriptions/export

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/subscriptions/export
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: subscriptions:read, subscriptions:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The organization ID.

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

The product ID.

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

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.

started_beforestring date-time nullable

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

timezonestring

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[]

Response

Successful Response

Changes

  • 964f974aceffRevision changes
    • info

      added the new optional query request parameter cancel_at_period_end

    • info

      added the new optional query request parameter columns

    • info

      added the new optional query request parameter product_id

    • info

      added the new optional query request parameter started_after

    • info

      added the new optional query request parameter started_before

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter timezone