Sample - Stripe API
POST/v1/reporting/report_runs

Create a Report Run

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields
expandarray<string>optional
Specifies which fields in the response should be expanded.
parametersobjectoptional
Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://docs.stripe.com/reporting/statements/api) documentation.
report_typestringrequired
The ID of the [report type](https://docs.stripe.com/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`.

2 status codes
200Successful response.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
errorstringoptional
If something should go wrong during the run, a message about the failure (populated when `status=failed`).
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
`true` if the report is run on live mode data and `false` if it is run on test mode data.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:reporting.report_run
parametersobjectrequired
report_typestringrequired
The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`.
resultobjectoptional
The file object representing the result of the report run (populated when `status=succeeded`).
statusstringrequired
Status of this report run. This will be `pending` when the run is initially created. When the run finishes, this will be set to `succeeded` and the `result` field will be populated. Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.
succeeded_atintegeroptional
Timestamp at which this run successfully finished (populated when `status=succeeded`). Measured in seconds since the Unix epoch.
defaultError response.
errorobjectrequired

Error handling

Any other status is an error: Error response.