FinancialReportingFinanceReportRunList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stripe/main/json-schema/stripe-financial-reporting-finance-report-run-list-schema.json",
  "title": "FinancialReportingFinanceReportRunList",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/stripe-reporting-api-openapi.yml#/components/schemas/FinancialReportingFinanceReportRunList",
  "type": "object",
  "required": [
    "data",
    "has_more",
    "object",
    "url"
  ],
  "properties": {
    "data": {
      "items": {
        "$ref": "#/$defs/reporting.report_run"
      },
      "type": "array"
    },
    "has_more": {
      "description": "True if this list has another page of items after this one that can be fetched.",
      "type": "boolean"
    },
    "object": {
      "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
      "enum": [
        "list"
      ],
      "type": "string"
    },
    "url": {
      "description": "The URL where this list can be accessed.",
      "maxLength": 5000,
      "pattern": "^/v1/reporting/report_runs",
      "type": "string"
    }
  },
  "$defs": {
    "file": {
      "type": "object",
      "description": "Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.",
      "x-ae-placeholder": true
    },
    "financial_reporting_finance_report_run_run_parameters": {
      "type": "object",
      "description": "Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.",
      "x-ae-placeholder": true
    },
    "reporting.report_run": {
      "description": "The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://stripe.com/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).",
      "properties": {
        "created": {
          "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
          "format": "unix-time",
          "type": "integer"
        },
        "error": {
          "description": "If something should go wrong during the run, a message about the failure (populated when\n `status=failed`).",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "Unique identifier for the object.",
          "maxLength": 5000,
          "type": "string"
        },
        "livemode": {
          "description": "`true` if the report is run on live mode data and `false` if it is run on test mode data.",
          "type": "boolean"
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "reporting.report_run"
          ],
          "type": "string"
        },
        "parameters": {
          "$ref": "#/$defs/financial_reporting_finance_report_run_run_parameters"
        },
        "report_type": {
          "description": "The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `\"balance.summary.1\"`.",
          "maxLength": 5000,
          "type": "string"
        },
        "result": {
          "anyOf": [
            {
              "$ref": "#/$defs/file"
            }
          ],
          "description": "The file object representing the result of the report run (populated when\n `status=succeeded`)."
        },
        "status": {
          "description": "Status of this report run. This will be `pending` when the run is initially created.\n When the run finishes, this will be set to `succeeded` and the `result` field will be populated.\n Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.",
          "maxLength": 5000,
          "type": "string"
        },
        "succeeded_at": {
          "description": "Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch.",
          "format": "unix-time",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "created",
        "id",
        "livemode",
        "object",
        "parameters",
        "report_type",
        "status"
      ],
      "title": "reporting_report_run",
      "type": "object",
      "x-expandableFields": [
        "parameters",
        "result"
      ],
      "x-resourceId": "reporting.report_run"
    }
  }
}