How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Stripe Reporting API

The financial reports in the Dashboard provide downloadable reports in CSV format for a variety of accounting and reconciliation tasks. These reports are also available through the API, so you can schedule them to run automatically or run them whenever you need to receive the associated report files for accounting purposes.

Stripe Reporting API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reporting and Reports. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-16.

Requests are made against a single base URL, https://api.stripe.com/.

5 operations 4 paths 10 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Stripe Reporting API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reporting 5
GET
/v1/reporting/report_runs
Returns a list of Report Runs, with the most recent appearing first.
GetReportingReportRuns 5 params body → 200default
POST
/v1/reporting/report_runs
Creates a new object and begin running the report. (Certain report types require a live-mode API key .)
PostReportingReportRuns body → 200default
GET
/v1/reporting/report_runs/{report_run}
Retrieves the details of an existing Report Run.
GetReportingReportRunsReportRun 2 params body → 200default
GET
/v1/reporting/report_types
Returns a full list of Report Types.
GetReportingReportTypes 1 param body → 200default
GET
/v1/reporting/report_types/{report_type}
Retrieves the details of a Report Type. (Certain report types require a live-mode API key .)
GetReportingReportTypesReportType 2 params body → 200default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are reporting.report_run (10 properties), reporting.report_type (9 properties), FinancialReportingFinanceReportTypeList (4 properties), FinancialReportingFinanceReportRunList (4 properties). Each schema is shown below with its type and property counts.

reporting.report_type
object
The Report Type resource corresponds to a particular type of report, such as the "Activity summary" or "Itemized payouts" reports. These objects are identified…
9 properties 8 required
FinancialReportingFinanceReportTypeList
object
4 properties 4 required
PostReportingReportRunsRequest
object
3 properties 1 required
GetReportingReportRunsRequest
object
FinancialReportingFinanceReportRunList
object
4 properties 4 required
error
object
An error response from the Stripe API
1 property 1 required
GetReportingReportTypesRequest
object
GetReportingReportTypesReportTypeRequest
object
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…
10 properties 7 required
GetReportingReportRunsReportRunRequest
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-reporting-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
Stripe Balance API
Stripe Billing API
Stripe Charges API
Stripe Checkout API
Stripe Climate API
Stripe Country API
Stripe Coupons API
Stripe Credit Notes API
Stripe Customers API
Stripe Disputes API
Stripe Ephemeral Keys API
Where this information came from

This is an independent, third-party profile of Stripe Reporting API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.