ReportTypes
To query the available report types.
Table Specific Information
Used to query all the report types or a specific report type.
Note: This report type requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.
Select
Server-Side Query Support
The cmdlet uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the cmdlet.
- Id supports the following operators: =, IN.
You can select from ReportTypes with the following queries:
SELECT * FROM ReportTypes
SELECT * FROM ReportTypes WHERE Id = 'balance.summary.1'
SELECT * FROM ReportTypes WHERE Id IN ('balance.summary.1', 'balance_change_from_activity.itemized.1')
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the Report Type, such as balance.summary.1. | |
| Object | String | String representing the object's type. Objects of the same type share the same value. | |
| DataAvailableEnd | Datetime | Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. | |
| DataAvailableStart | Datetime | Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. | |
| DefaultColumns | String | List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.) | |
| Livemode | Boolean | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
| Name | String | Human-readable name of the Report Type | |
| Updated | Datetime | When this Report Type was latest updated. Measured in seconds since the Unix epoch. | |
| Version | Integer | Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas. |