Export invoices as CSV
const url = 'http://localhost:8080/v1/exports/invoices.csv';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:8080/v1/exports/invoices.csv \ --header 'Authorization: Bearer <token>'Streams every invoice, newest first, from one consistent snapshot. Amounts are in cents. Columns: id, invoice_number, customer_id, subscription_id, status, payment_status, currency, subtotal_cents, tax_amount_cents, discount_cents, total_amount_cents, amount_due_cents, amount_paid_cents, credits_applied_cents, billing_period_start, billing_period_end, tax_provider, tax_transaction_id, tax_reversed_at, issued_at, due_at, paid_at, voided_at, uncollectible_at, created_at.
Audit row, EXPORT_INCOMPLETE marker and formula escaping work
as in the customers export.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Lower bound on created_at, inclusive. RFC 3339 or YYYY-MM-DD.
Upper bound on created_at, inclusive. RFC 3339 or YYYY-MM-DD (end of that day, UTC).
Responses
Section titled “Responses”CSV file (sent as an attachment).
from or to is malformed, or to is before from.
object
object
One of invalid_request_error, authentication_error,
rate_limit_error or api_error. Every error the API
answers has this shape, including an unknown path (404,
code route_not_found) and a method the path does not take
(405, code method_not_allowed, with an Allow header).
The few exceptions are listed in docs/api-surface.md.
The request field the error is about. Sent only when the error
names one. A request body may hold only the fields its
operation lists, spelled and cased as listed: any other
field, or one the server sets (such as id), is refused
with 422 and param naming it. An operation with no request body lists no fields: send
no body, {} or null. The Stripe and Postmark webhooks and
the LiteLLM callback take their sender’s body as it comes.
Example
{ "error": { "type": "invalid_request_error" }}The export’s audit row could not be written; nothing was sent.
object
object
One of invalid_request_error, authentication_error,
rate_limit_error or api_error. Every error the API
answers has this shape, including an unknown path (404,
code route_not_found) and a method the path does not take
(405, code method_not_allowed, with an Allow header).
The few exceptions are listed in docs/api-surface.md.
The request field the error is about. Sent only when the error
names one. A request body may hold only the fields its
operation lists, spelled and cased as listed: any other
field, or one the server sets (such as id), is refused
with 422 and param naming it. An operation with no request body lists no fields: send
no body, {} or null. The Stripe and Postmark webhooks and
the LiteLLM callback take their sender’s body as it comes.
Example
{ "error": { "type": "invalid_request_error" }}