Stripe: List all Report Runs

← Reporting operations · Get started

Operation stripe.getreportingreportruns

Provider route: GET /v1/reporting/report_runs. 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"]["getReportingReportRuns"]>[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.getReportingReportRuns(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_runs(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.created	JSON	Optional
query.created (anyOf 1)	object	Alternative
query.created (anyOf 1).gt	integer	Optional
query.created (anyOf 1).gte	integer	Optional
query.created (anyOf 1).lt	integer	Optional
query.created (anyOf 1).lte	integer	Optional
query.created (anyOf 2)	integer	Alternative
query.ending_before	string	Optional	Maximum length: 5000
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.limit	integer	Optional
query.starting_after	string	Optional	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
$	object	Root
data	array	Required within parent
data[]	Model	Each item	Expand Create a Report Run — response body
has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
object	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Always has the value `list`. Known values: list
url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/reporting/report_runs

Referenced models: Create a Report Run — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Create a Report Run — response body

Field	Type	Presence	Description and constraints
$	object	Root	The Report Run object represents an instance of a report type 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 a file where you can retrieve your results. For an overview, see [API Access to Reports](https://docs.stripe.com/reporting/statements/api). 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).
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
error	JSON	Optional
error (anyOf 1)	string	Alternative	If something should go wrong during the run, a message about the failure (populated when `status=failed`). Maximum length: 5000
error (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	`true` if the report is run on live mode data and `false` if it is run on test mode data.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: reporting.report_run
parameters	Model	Required within parent	Expand Create a Report Run — response body — parameters
report_type	string	Required within parent	The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`. Maximum length: 5000
result	JSON	Optional
result (anyOf 1)	JSON	Alternative	The file object representing the result of the report run (populated when `status=succeeded`).
result (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a file — response body
result (anyOf 2)	null	Alternative
status	string	Required within parent	Status of this report run. This will be `pending` when the run is initially created. When the run finishes, this will be set to `succeeded` and the `result` field will be populated. Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated. Maximum length: 5000
succeeded_at	JSON	Optional
succeeded_at (anyOf 1)	JSON	Alternative
succeeded_at (anyOf 1) (anyOf 1)	integer	Alternative	Timestamp at which this run successfully finished (populated when `status=succeeded`). Measured in seconds since the Unix epoch. Format: unix-time
succeeded_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
succeeded_at (anyOf 2)	null	Alternative

Referenced models: Create a file — response body, Create a Report Run — response body — parameters

Create a file — response body

Field	Type	Presence	Description and constraints
$	object	Root	This object represents files hosted on Stripe's servers. You can upload files with the [create file](https://docs.stripe.com/api#create_file) request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a [Sigma scheduled query](#scheduled_queries)). Related guide: [File upload guide](https://docs.stripe.com/file-upload)
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at	JSON	Optional
expires_at (anyOf 1)	JSON	Alternative
expires_at (anyOf 1) (anyOf 1)	integer	Alternative	The file expires and isn't available at this time in epoch seconds. Format: unix-time
expires_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at (anyOf 2)	null	Alternative
filename	JSON	Optional
filename (anyOf 1)	string	Alternative	The suitable name for saving the file to a filesystem. Maximum length: 5000
filename (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
links	JSON	Optional
links (anyOf 1)	object	Alternative	A list of [file links](https://docs.stripe.com/api#file_links) that point at this file.
links (anyOf 1).data	array	Required within parent	Details about each object.
links (anyOf 1).data[]	Model	Each item	Expand Create a file link — response body
links (anyOf 1).has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
links (anyOf 1).object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
links (anyOf 1).url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/file_links
links (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: file
purpose	string	Required within parent	The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file. Known values: account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, document_provider_identity_document, finance_report_run, financial_account_statement, identity_document, identity_document_downloadable, issuing_regulatory_reporting, pci_document, platform_terms_of_service, selfie, sigma_scheduled_query, tax_document_user_upload, terminal_android_apk, terminal_reader_splashscreen, terminal_wifi_certificate, terminal_wifi_private_key
size	JSON	Required within parent
size (anyOf 1)	integer	Alternative	The size of the file object in bytes.
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
title	JSON	Optional
title (anyOf 1)	string	Alternative	A suitable title for the document. Maximum length: 5000
title (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). Maximum length: 5000
type (anyOf 2)	null	Alternative
url	JSON	Optional
url (anyOf 1)	string	Alternative	Use your live secret API key to download the file from this URL. Maximum length: 5000
url (anyOf 2)	null	Alternative

Referenced models: Create a file link — response body

Create a Report Run — response body — parameters

Field	Type	Presence	Description and constraints
$	object	Root
columns	array	Optional	The set of output columns requested for inclusion in the report run.
columns[]	string	Each item	Maximum length: 5000
connected_account	string	Optional	Connected account ID by which to filter the report run. Maximum length: 5000
currency	string	Optional	Currency of objects to be included in the report run. Format: currency
interval_end	JSON	Optional
interval_end (anyOf 1)	integer	Alternative	Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value. Format: unix-time
interval_end (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
interval_start	JSON	Optional
interval_start (anyOf 1)	integer	Alternative	Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value. Format: unix-time
interval_start (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
payout	string	Optional	Payout ID by which to filter the report run. Maximum length: 5000
reporting_category	string	Optional	Category of balance transactions to be included in the report run. Maximum length: 5000
timezone	string	Optional	Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`. Maximum length: 5000

Policy, approvals and errors

SDK function policy ID: stripe.getreportingreportruns. Catalog operation: GetReportingReportRuns. 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