Stripe: Reporting schemas
3 Stripe schemas with complete fields and constraints.
← Reporting operations · All schemas
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 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 |
Retrieve a Report Type — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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](https://docs.stripe.com/reporting/statements/api) 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](https://docs.stripe.com/keys#test-live-modes). |
data_available_end | JSON | Required within parent | |
data_available_end (anyOf 1) | integer | Alternative | Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. Format: unix-time |
data_available_end (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
data_available_start | JSON | Required within parent | |
data_available_start (anyOf 1) | integer | Alternative | Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. Format: unix-time |
data_available_start (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
default_columns | JSON | Optional | |
default_columns (anyOf 1) | array | Alternative | List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.) |
default_columns (anyOf 1)[] | string | Each item | Maximum length: 5000 |
default_columns (anyOf 2) | null | Alternative | |
id | string | Required within parent | The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
name | string | Required within parent | Human-readable name of the Report Type Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: reporting.report_type |
updated | JSON | Required within parent | |
updated (anyOf 1) | integer | Alternative | When this Report Type was latest updated. Measured in seconds since the Unix epoch. Format: unix-time |
updated (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
version | JSON | Required within parent | |
version (anyOf 1) | integer | Alternative | Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas. |
version (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |