v1

latestOpenAPI 3.0.32026-07-248519153.1 KB

Start subscriptions TSV export (async)

Queue a background job that exports the entire filtered subscription set as a TSV file (UTF-8 BOM, tab-delimited, Excel-friendly). Useful when the dataset is too large to page through /subscriptions/list.

The endpoint returns immediately with status: "pending" and an id. Poll GET /exports/{id} until status == "completed", then fetch download_url (signed, expires in 1 hour).

Accepts the same filters as /subscriptions/list. All filters are optional — omit them to export everything in the project.

post/exports/subscriptions

Headers

api_keystring required

Request body

user_idstring
searchstring
payment_systemstring
price_idstring
fromstring

ISO date (inclusive, project timezone)

tostring

ISO date (inclusive, project timezone)

status'active' | 'incomplete' | 'incomplete_expired' | 'trialing' | 'past_due' | 'canceled' | 'unpaid' | 'paused'
ltv_minnumber
ltv_maxnumber
quiz_idstring
paywall_idstring

Example request

{
  "from": "2026-01-01",
  "to": "2026-05-20"
}

Response

Export job has been queued.

successinteger

Example response

{
  "success": 1,
  "export": {
    "type": "subscriptions",
    "file_name": "subscriptions_export_2026-05-20_18-30-00.tsv",
    "file_size_human": "12.4 MB",
    "mime_type": "text/tab-separated-values"
  }
}