Core Resources
Payment Methods
Money Management
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

Retrieve a Report v2

Reporting
Reports
Retrieve a Report

Retrieves metadata about a specific Report template, including its name, description, and the parameters it accepts. It’s useful for understanding the capabilities and requirements of a particular Report before requesting a ReportRun.

Learn more about calling API v2 endpoints.

Parameters

  • idstringRequired

    The unique identifier of the Report object.

Returns

Response attributes

  • idstring

    The unique identifier of the Report object.

  • objectstring, value is "v2.reporting.report"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • namestring

    The human-readable name of the Report.

  • parametersmap

    Specification of the parameters that the Report accepts. It details each parameter’s name, description, whether it is required, and any validations performed.

Error Codes
403report_inaccessible

Returned when a report cannot be accessed. The error message provides specific details about the reason for the access failure.

404not_found

The resource wasn’t found.

GET /v2/reporting/reports/:id
cURL
curl https://api.stripe.com/v2/reporting/reports/report_test_xxx \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2026-01-28.preview"
Response
{
  "id": "report_test_xxx",
  "name": "test report name",
  "object": "v2.reporting.report",
  "parameters": {
    "columns": {
      "array_details": {
        "element_type": "enum",
        "enum_details": {
          "allowed_values": [
            "column_1",
            "column_2"
          ]
        }
      },
      "description": "Set of output columns requested for inclusion in the report.",
      "enum_details": false,
      "required": true,
      "timestamp_details": null,
      "type": "array"
    },
    "interval_start": {
      "array_details": null,
      "description": "",
      "enum_details": null,
      "required": true,
      "timestamp_details": {
        "max": "2025-08-26T14:00:00.000Z",
        "min": "2025-03-11T00:00:00.000Z"
      },
      "type": "timestamp"
    },
    "interval_end": {
      "array_details": null,
      "description": "",
      "enum_details": null,
      "required": true,
      "timestamp_details": {
        "max": "2025-08-26T14:00:00.000Z",
        "min": "2025-03-11T00:00:00.000Z"
      },
      "type": "timestamp"
    },
    "category": {
      "array_details": null,
      "description": "",
      "enum_details": {
        "allowed_values": [
          "enum_value_1",
          "enum_value_2"
        ]
      },
      "required": false,
      "timestamp_details": null,
      "type": "enum"
    }
  },
  "livemode": false
}