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.
Was this section helpful? Yes No
Retrieve a Report Type
GET / v1 / reporting / report_types /:id
List all Report Types
GET / v1 / reporting / report_types
The Report Type object
Attributes
- id string The ID of the Report Type, such as
balance.summary.1. - data _ available _ end timestamp Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
- data _ available _ start timestamp Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
- name string Human-readable name of the Report Type
More attributes
- object string, value is "reporting.report_type"
- default _ columns nullable array of strings
- livemode boolean
- updated timestamp
- version integer
The Report Type object
{ "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}
Retrieve a Report Type
GET / v1 / reporting / report_types /:id
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.
Response
{ "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}