Sample - Stripe API
GET/v1/reporting/report_types/{report_type}

Retrieve a report type

Retrieves the details of a specific report type. Provide report_type to identify the report type and use expand to include additional response fields; certain report types require a live-mode API key.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
report_typestringrequired
The identifier of the report type to retrieve.
expandarray<string>optional
Fields to expand in the report type response; each value can be at most 5000 characters.

2 status codes
200Returns a report type object containing its identifier, human-readable name, version, data availability range, update time, live-mode state, object type, and default columns.
data_available_endintegerrequired
Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
data_available_startintegerrequired
Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
default_columnsarray<string>optional
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.)
idstringrequired
The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
namestringrequired
Human-readable name of the Report Type
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:reporting.report_type
updatedintegerrequired
When this Report Type was latest updated. Measured in seconds since the Unix epoch.
versionintegerrequired
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.
defaultError response.
errorobjectrequired

Error handling

report_type must identify the requested report type, and expand values must be strings no longer than 5000 characters. Use a live-mode API key when retrieving a report type that requires live mode.