Create a Report Run

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

Returns

Returns the new ReportRun object.

Parameters

• report_type (string, required) The ID of the report type to run, such as "balance.summary.1".

• parameters (object, optional) Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the API Access to Reports documentation.

  • parameters.columns (array of strings, optional) The set of report columns to include in the report output. If omitted, the Report Type is run with its default column set.

  • parameters.connected_account (string, optional) Connected account ID to filter for in the report run.

  • parameters.currency (enum, optional) Currency of objects to be included in the report run.

  • parameters.interval_end (timestamp, optional) Ending timestamp of data to be included in the report run (exclusive).

  • parameters.interval_start (timestamp, optional) Starting timestamp of data to be included in the report run.

  • parameters.payout (string, optional) Payout ID by which to filter the report run.

  • parameters.reporting_category (string, optional) Category of balance transactions to be included in the report run.

  • parameters.timezone (string, optional) Defaults to Etc/UTC. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the IANA Time Zone Database. Has no effect on interval_start or interval_end.

curl https://api.stripe.com/v1/reporting/report_runs \
  -u "<<YOUR_SECRET_KEY>>" \
  -d "report_type=balance.summary.1" \
  -d "parameters[interval_start]=1680000000" \
  -d "parameters[interval_end]=1680100000"

Response

{
  "id": "frr_1MrQwrLkdIwHu7ixUov4x2b3",
  "object": "reporting.report_run",
  "created": 1680203749,
  "error": null,
  "livemode": false,
  "parameters": {
    "interval_end": 1680100000,
    "interval_start": 1680000000
  },
  "report_type": "balance.summary.1",
  "result": null,
  "status": "pending",
  "succeeded_at": null
}