Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

Create a Report Run 

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.)

Parameters

  • report_typestringRequired

    The ID of the report type to run, such as "balance.summary.1".

  • parametersobject

    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.columnsarray of strings

      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_accountstring

      Connected account ID to filter for in the report run.

    • parameters.currencyenum

      Currency of objects to be included in the report run.

    • parameters.interval_endtimestamp

      Ending timestamp of data to be included in the report run (exclusive).

    • parameters.interval_starttimestamp

      Starting timestamp of data to be included in the report run.

    • parameters.payoutstring

      Payout ID by which to filter the report run.

    • parameters.reporting_categorystring

      Category of balance transactions to be included in the report run.

    • parameters.timezonestring

      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.

Returns

Returns the new ReportRun object.

POST /v1/reporting/report_runs
curl https://api.stripe.com/v1/reporting/report_runs \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -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
}