Create reports

Create, track, and download API v2 CSV reports with report_type, date range, and Bearer authentication

Use reports API v2 to export subscription and invoice data as a CSV file.

Each report covers one report_type and one date range. Records are selected by creation date, where date_from is inclusive and date_to is exclusive.

API

To create and download a report

Use the create report API v2 request.
- Set report_type to SUBSCRIPTIONS or INVOICES .
- Pass date_from and date_to.
Save the report id from the response. Processing is asynchronous and starts in PROCESSING status.
Optionally use the list reports API v2 request with the same report_type until status is SUCCEEDED .
Use the download report API v2 request with the report id. A successful response returns a 303 redirect to a short-lived download URL.

If the report is not ready or no longer available, download returns:

303 - redirect to a short-lived download URL
404 - report not found
422 - report still processing, failed, or expired

Reports expire 30 days after creation. Column layouts stay in the reports API v2 reference.

Looking for help? Contact us

Stay informed with Changelog