Report Runs v2

The ReportRun object represents an instance of a Report 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 the results.

Learn more about calling API v2 endpoints.

The ReportRun object

Attributes

idstring
The unique identifier of the ReportRun object.

objectstring, value is "v2.reporting.report_run"
String representing the object’s type. Objects of the same type share the same value of the object field.

createdtimestamp
Time at which the object was created.

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

reportstring
The unique identifier of the Report object which was run.

report_namestring
The human-readable name of the Report which was run.

report_parametersmap
The parameters used to customize the generation of the report.

resultnullable object
Details how to retrieve the results of a successfully completed ReportRun.

result_optionsnullable object
The options specified for customizing the output file of the ReportRun.

statusenum
The current status of the ReportRun.
Possible enum values
failed
Report has failed to complete due to an error.
running
Report generation is in progress.
succeeded
Report has successfully generated.

status_detailsmap
Additional details about the current state of the ReportRun. The field is currently only populated when a ReportRun is in the failed state, providing more information about why the report failed to generate successfully.

The ReportRun object

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "4242",
  "object": "4242",
  "report": "4242",
  "report_name": "4242",
  "report_parameters": {
    "4242": {
      "array_value": {
        "items": [
          "4242"
        ]
      },
      "string_value": "4242",
      "timestamp_value": "2025-01-01T00:00:00.000Z"
    }
  },
  "result": {
    "file": {
      "content_type": "csv",
      "download_url": {
        "expires_at": "2025-01-01T00:00:00.000Z",
        "url": "4242"
      },
      "size": 4242
    },
    "type": "file"
  },
  "result_options": {
    "compress_file": true
  },
  "status": "failed",
  "status_details": {
    "4242": {
      "error_code": "file_size_above_limit",
      "error_message": "4242"
    }
  },
  "livemode": true
}

ReportRun event types v2

This is a list of all public thin events we currently send for updates to ReportRun, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.