Request Export

Overview

Use this endpoint to request a new data export. The export runs in the background - you'll receive an email when your file is ready to download.

Request Body

Each export type has additional filters. See the sections below for details.

Export Types

Subscriptions

Get a list of all subscriptions with their plan, status, billing details, and customer information.

Use case: Reconcile your subscriber list with your CRM, or analyze churn by exporting canceled subscriptions.

{
  "object": "subscriptions",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "status": "active",
  "collection_method": "charge_automatically"
}

Memberships

Get membership records. Uses the same filters as Subscriptions.

Use case: Export members in a specific plan to send targeted communications or verify access levels.

{
  "object": "memberships",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "status": "active",
  "plan_id": 456
}

Invoices

Get invoice records with line items, totals, and payment status.

Use case: Export paid invoices for quarterly revenue reporting or reconcile with your accounting system.

{
  "object": "invoices",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "status": "paid"
}

Payments

Get payment transaction records.

Use case: Generate a payment report for your finance team, or export all card payments in USD for bank reconciliation.

{
  "object": "payments",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "status": "succeeded",
  "category": "Card",
  "currency": "USD"
}

Refunds

Get refund records.

Use case: Track refunds for a specific period to analyze return trends or prepare financial reports.

{
  "object": "refunds",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "status": "succeeded",
  "type": "online"
}

Customers

Get customer profile records.

Use case: Export new customers for the quarter to import into your marketing automation platform.

{
  "object": "customers",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "mode": "full_data"
}

Customers Metadata

Get custom metadata fields for customers. Uses the same filters as Customers.

Use case: Export custom fields like "company_size" or "industry" for customer segmentation analysis.

{
  "object": "customers_metadata",
  "date_from": 1704067200,
  "date_to": 1711929600
}

Newsletters

Get newsletter subscription records.

Use case: Export newsletter subscribers to sync with your email marketing service like Mailchimp or Klaviyo.

{
  "object": "newsletters",
  "date_from": 1704067200,
  "date_to": 1711929600
}

Addresses

Get customer address records.

Use case: Export shipping addresses for a specific country to analyze your geographic customer distribution.

{
  "object": "addresses",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "country": "US",
  "type": "shipping"
}

Balance Transactions

Get customer balance credits and debits.

Use case: Audit all credits applied to customer accounts during a billing period.

{
  "object": "balance_transactions",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "type": "credit"
}

Credit Notes

Get credit note records.

Use case: Export credit notes in EUR to reconcile with your European accounting system.

{
  "object": "credit_note",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "currency": "EUR"
}

Orders

Get e-commerce order records.

Use case: Export fulfilled orders for a specific product to send to your fulfillment warehouse.

{
  "object": "orders",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "status": "fulfilled",
  "product_id": 789
}

Campaign Reports

Get marketing campaign performance data.

Use case: Export performance data for a specific campaign to analyze conversion rates and ROI.

{
  "object": "campaign_reports",
  "date_from": 1704067200,
  "date_to": 1711929600,
  "campaign_key": "summer-sale-2024"
}

Accounting

Get a complete monthly accounting package. Unlike other exports, this produces a ZIP file with 11 CSV reports.

Use case: Close your monthly books by exporting all revenue, payments, and adjustments for January 2024 in USD.

{
  "object": "accounting",
  "month": "2024-01-01",
  "currency": "USD"
}

What's in the ZIP file:

• subscription_revenue.csv - Revenue from subscription invoices
• order_revenue.csv - Revenue from e-commerce orders
• recognized_revenue.csv - Revenue recognized over time
• recognized_revenue_issue_based.csv - Issue-based recognized revenue
• recognized_revenue_order_based.csv - Order-based recognized revenue
• payments_received.csv - All payments received
• applied_balance.csv - Customer balance applications
• refunds_made.csv - All refunds issued
• uncollectible.csv - Invoices marked as uncollectible
• voided.csv - Voided invoices
• credit_notes.csv - Credit notes issued

Note: You can only export accounting data for past or current months, starting from the month of your first invoice.

Date Range Limits

• Maximum range: You can export up to 6 months of data at a time
• Accounting exports: One month at a time

Understanding the Mode Parameter

The mode parameter determines which records are included:

Use modified_data when you want to capture changes to existing records. For example, if a subscription was created in January but updated in March, using modified_data with a March date range will include that subscription.

Common Errors

Related Endpoints

• List Exports - See all available export types and filters
• Download Export - Download your completed export