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

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

  • parametersMap

    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.

Returns

Returns the new ReportRun object.

POST /v1/reporting/report_runs
Stripe.apiKey = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2";
ReportRunCreateParams params =
  ReportRunCreateParams.builder()
    .setReportType("balance.summary.1")
    .setParameters(
      ReportRunCreateParams.Parameters.builder()
        .setIntervalStart(1680000000L)
        .setIntervalEnd(1680100000L)
        .build()
    )
    .build();
ReportRun reportRun = ReportRun.create(params);
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
}

Retrieve a Report Run 

Retrieves the details of an existing Report Run.

Parameters

No parameters.

Returns

Returns the specified ReportRun object if found, and throws an error otherwise.

GET /v1/reporting/report_runs/:id
Stripe.apiKey = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2";
ReportRun reportRun = ReportRun.retrieve("frr_1MrQwrLkdIwHu7ixUov4x2b3");
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
}

List all Report Runs 

Returns a list of Report Runs, with the most recent appearing first.

Parameters

  • createdMap

    Only return Report Runs that were created during the given date interval.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A Map with a data property that contains an array of up to limit Report Runs, starting after the argument starting_after if it is provided. Each entry in the array is a separate ReportRun object. If no more Report Runs are available, the resulting array will be empty.

GET /v1/reporting/report_runs
Stripe.apiKey = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2";
ReportRunListParams params = ReportRunListParams.builder().setLimit(3L).build();
ReportRunCollection reportRuns = ReportRun.list(params);
Response
{
  "object": "list",
  "url": "/v1/reporting/report_runs",
  "has_more": false,
  "data": [
    {
      "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
    }
  ]
}

Report Types 

The Report Type resource corresponds to a particular type of report, such as the “Activity summary” or “Itemized payouts” reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.

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.

Endpoints

Report Runs v2

The ReportRun object represents an instance of a Report 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 the results.

Learn more about calling API v2 endpoints.