The Report Run object

Attributes

  • idstring

    Unique identifier for the object.

  • parametersobject

    Parameters of this report run.

  • report_typestring

    The ID of the report type to run, such as "balance.summary.1".

  • resultnullable object

    The file object representing the result of the report run (populated when status=succeeded).

  • statusstring

    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.

More attributes

  • objectstring

  • createdtimestamp

  • errornullable string

  • livemodeboolean

  • succeeded_atnullable timestamp

The Report Run object
{
"id": "frr_1MrQwrLkdIwHu7ixUov4x2b3",
"object": "reporting.report_run",
"created": 1680203749,
"error": null,
"livemode": false,
"parameters": {
"interval_end": 1680100000,
"interval_start": 1680000000
},
"report_type": "balance.summary.1",
"result": null,
"status": "pending",
"succeeded_at": null
}

Create a Report Run

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

Parameters

  • report_typestringRequired

    The ID of the report type to run, such as "balance.summary.1".

  • parametersobject

    Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the API Access to Reports documentation.

Returns

Returns the new ReportRun object.

POST /v1/reporting/report_runs
curl https://api.stripe.com/v1/reporting/report_runs \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d report_type="balance.summary.1" \
-d "parameters[interval_start]"=1680000000 \
-d "parameters[interval_end]"=1680100000
Response
{
"id": "frr_1MrQwrLkdIwHu7ixUov4x2b3",
"object": "reporting.report_run",
"created": 1680203749,
"error": null,
"livemode": false,
"parameters": {
"interval_end": 1680100000,
"interval_start": 1680000000
},
"report_type": "balance.summary.1",
"result": null,
"status": "pending",
"succeeded_at": null
}

Retrieve a Report Run

Retrieves the details of an existing Report Run.

Parameters

No parameters.

Returns

Returns the specified ReportRun object if found, and raises an error otherwise.

GET /v1/reporting/report_runs/:id
curl https://api.stripe.com/v1/reporting/report_runs/frr_1MrQwrLkdIwHu7ixUov4x2b3 \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "frr_1MrQwrLkdIwHu7ixUov4x2b3",
"object": "reporting.report_run",
"created": 1680203749,
"error": null,
"livemode": false,
"parameters": {
"interval_end": 1680100000,
"interval_start": 1680000000
},
"report_type": "balance.summary.1",
"result": null,
"status": "pending",
"succeeded_at": null
}

List all Report Runs

Returns a list of Report Runs, with the most recent appearing first.

Parameters

  • createdobject

    Only return Report Runs that were created during the given date interval.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit Report Runs, starting after the argument starting_after if it is provided. Each entry in the array is a separate ReportRun object. If no more Report Runs are available, the resulting array will be empty.

GET /v1/reporting/report_runs
curl -G https://api.stripe.com/v1/reporting/report_runs \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d limit=3
Response
{
"object": "list",
"url": "/v1/reporting/report_runs",
"has_more": false,
"data": [
{
"id": "frr_1MrQwrLkdIwHu7ixUov4x2b3",
"object": "reporting.report_run",
"created": 1680203749,
"error": null,
"livemode": false,
"parameters": {
"interval_end": 1680100000,
"interval_start": 1680000000
},
"report_type": "balance.summary.1",
"result": null,
"status": "pending",
"succeeded_at": null
}
{...}
{...}
],
}

Report Types

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 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.

Account Owner

Describes an owner of an account.

Session

A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

Transactions

A Transaction represents a real transaction that affects a Financial Connections Account balance.

Tax Calculations

A Tax Calculation allows you to calculate the tax to collect from your customer.

Related guide: Calculate tax in your custom payment flow

Tax Registrations

A Tax Registration lets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax.

Stripe doesn’t register on your behalf with the relevant authorities when you create a Tax Registration object. For more information on how to register to collect tax, see our guide.

Related guide: Using the Registrations API

Tax Settings

You can use Tax Settings to manage configurations used by Stripe Tax calculations.

Related guide: Using the Settings API

Verification Session

A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.

A VerificationSession transitions through multiple statuses throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the user’s verified data after verification checks are complete.

Related guide: The Verification Sessions API

Verification Report

A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type and options parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document, id_number, selfie.

Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.

Related guides: Accessing verification results.

Crypto Onramp Session

A Crypto Onramp Session represents your customer’s session as they purchase cryptocurrency through Stripe. Once payment is successful, Stripe will fulfill the delivery of cryptocurrency to your user’s wallet and contain a reference to the crypto transaction ID.

You can create an onramp session on your server and embed the widget on your frontend. Alternatively, you can redirect your users to the standalone hosted onramp.

Related guide: Integrate the onramp

Crypto Onramp Quotes

Crypto Onramp Quotes are estimated quotes for onramp conversions into all the different cryptocurrencies on different networks. The Quotes API allows you to display quotes in your product UI before directing the user to the onramp widget.

Related guide: Quotes API

Climate Order

Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.

Climate Product

A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.

Forwarding RequestPreview feature

Instructs Stripe to make a request on your behalf using the destination URL and HTTP method in the config. A config is set up for each destination URL by Stripe at the time of onboarding. Stripe verifies requests with your credentials in the config, and injects card details from the payment_method into the request.

Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period.

You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request.

Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits.

Related guide: Forward card details to third-party API endpoints.

Webhook Endpoints

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

Related guide: Setting up webhooks

Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$