Skip to main content
Manja / Stripe
Schema2020-08-27object

reporting.report_run

The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see [API Access to Reports](https://stripe.com/docs/reporting/statements/api). Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

reporting_report_run

object

The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see [API Access to Reports](https://stripe.com/docs/reporting/statements/api). Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without …

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

error string
optionalnullable

If something should go wrong during the run, a message about the failure (populated when `status=failed`).

maxLength:5000

id string
required

Unique identifier for the object.

maxLength:5000

livemode boolean
required

`true` if the report is run on live mode data and `false` if it is run on test mode data.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "reporting.report_run"

report_type string
required

The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`.

maxLength:5000

result
optionalnullable

The file object representing the result of the report run (populated when `status=succeeded`).

status string
required

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.

maxLength:5000

succeeded_at integer (unix-time)
optionalnullable

Timestamp at which this run successfully finished (populated when `status=succeeded`). Measured in seconds since the Unix epoch.