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.
Attributes
- idstring
The ID of the Report Type, such as
balance..summary. 1 - data_
available_ endtimestamp Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
- data_
available_ starttimestamp Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
- namestring
Human-readable name of the Report Type
More attributes
- objectstring
- default_
columnsnullable array of strings - livemodeboolean
- updatedtimestamp
- versioninteger
{ "id": "balance.summary.1", "object": "reporting.report_type", "data_available_end": 1695081600, "data_available_start": 1667952000, "default_columns": [ "category", "description", "net_amount", "currency" ], "livemode": false, "name": "Balance summary", "updated": 1695109133, "version": 1}Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)
Parameters
No parameters.
Returns
Returns the specified ReportType object if found, and raises an error otherwise.
{ "id": "balance.summary.1", "object": "reporting.report_type", "data_available_end": 1695081600, "data_available_start": 1667952000, "default_columns": [ "category", "description", "net_amount", "currency" ], "livemode": false, "name": "Balance summary", "updated": 1695109133, "version": 1}Returns a full list of Report Types.
Parameters
No parameters.
Returns
A dictionary with a data property that contains an array of Report Types. Each entry is a separate ReportType object.
{ "object": "list", "url": "/v1/reporting/report_types", "has_more": false, "data": [ { "id": "balance.summary.1", "object": "reporting.report_type", "data_available_end": 1695081600, "data_available_start": 1667952000, "default_columns": [ "category", "description", "net_amount", "currency" ], "livemode": false, "name": "Balance summary", "updated": 1695109133, "version": 1 } ]}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.