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

{ "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}

List all Report Types

GET / v1 / reporting / report_types

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.

Response