The Report Type object 

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

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 

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.

GET /v1/reporting/report_types/:id
curl https://api.stripe.com/v1/reporting/report_types/balance.summary.1 \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
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 

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.

GET /v1/reporting/report_types
curl https://api.stripe.com/v1/reporting/report_types \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
"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.

Reports v2

The Report resource represents a customizable report template that provides insights into various aspects of your Stripe integration.