Stripe: Retrieve a Report Type

Stripe reporting.getReportingReportTypesReportType: arguments, response, policy and SDK examples.

Operation stripe.getreportingreporttypesreporttype

Provider route: GET /v1/reporting/report_types/{report_type}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["reporting"]["getReportingReportTypesReportType"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.reporting.getReportingReportTypesReportType(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.reporting.get_reporting_report_types_report_type(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.report_type`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.expand`	array	Optional
`query.expand[]`	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Retrieve a Report Type — response body

Referenced models: Retrieve a Report Type — response body

Schemas

Retrieve a Report Type — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	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](https://docs.stripe.com/reporting/statements/api) 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](https://docs.stripe.com/keys#test-live-modes).
`data_available_end`	JSON	Required within parent
`data_available_end (anyOf 1)`	integer	Alternative	Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. Format: unix-time
`data_available_end (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`data_available_start`	JSON	Required within parent
`data_available_start (anyOf 1)`	integer	Alternative	Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. Format: unix-time
`data_available_start (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`default_columns`	JSON	Optional
`default_columns (anyOf 1)`	array	Alternative	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.)
`default_columns (anyOf 1)[]`	string	Each item	Maximum length: 5000
`default_columns (anyOf 2)`	null	Alternative
`id`	string	Required within parent	The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`. Maximum length: 5000
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`name`	string	Required within parent	Human-readable name of the Report Type Maximum length: 5000
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: reporting.report_type
`updated`	JSON	Required within parent
`updated (anyOf 1)`	integer	Alternative	When this Report Type was latest updated. Measured in seconds since the Unix epoch. Format: unix-time
`updated (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`version`	JSON	Required within parent
`version (anyOf 1)`	integer	Alternative	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.
`version (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: stripe.getreportingreporttypesreporttype. Catalog operation: GetReportingReportTypesReportType. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page