API reference
Test mode. Use your secret key on your server; live processing is currently disabled.
https://api.knoxapi.comSend form-encoded requests with Authorization: Bearer sk_test_....
Complete OpenAPI specification · Integration guide
Operations and schemas are based on the pinned Stripe OpenAPI specification (MIT). Nested object definitions and enums are available in the complete specification.
GET /v1/reporting/report_runs
List all Report Runs
Returns a list of Report Runs, with the most recent appearing first.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
created | query | one of multiple schemas | Only return Report Runs that were created during the given date interval. |
ending_before | query | string | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. |
expand | query | array of string | Specifies which fields in the response should be expanded. |
limit | query | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
starting_after | query | string | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
data required | array of reporting.report_run | |
has_more required | boolean | True if this list has another page of items after this one that can be fetched. |
object required | string | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. |
url required | string | The URL where this list can be accessed. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
POST /v1/reporting/report_runs
Create a Report Run
Creates a new object and begin running the report. (Certain report types require a live-mode API key.)
Request parameters
| Field | Type | Description |
|---|---|---|
expand | array of string | Specifies which fields in the response should be expanded. |
parameters | object | Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://docs.stripe.com/reporting/statements/api) documentation. |
report_type required | string | The ID of the [report type](https://docs.stripe.com/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
error | string | If something should go wrong during the run, a message about the failure (populated when `status=failed`). |
id required | string | Unique identifier for the object. |
livemode required | boolean | `true` if the report is run on live mode data and `false` if it is run on test mode data. |
object required | string | String representing the object's type. Objects of the same type share the same value. |
parameters required | financial_reporting_finance_report_run_run_parameters | |
report_type required | string | The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`. |
result | one of multiple schemas | The file object representing the result of the report run (populated when `status=succeeded`). |
status required | string | 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. |
succeeded_at | integer | Timestamp at which this run successfully finished (populated when `status=succeeded`). Measured in seconds since the Unix epoch. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
GET /v1/reporting/report_types
List all Report Types
Returns a full list of Report Types.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
expand | query | array of string | Specifies which fields in the response should be expanded. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
data required | array of reporting.report_type | |
has_more required | boolean | True if this list has another page of items after this one that can be fetched. |
object required | string | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. |
url required | string | The URL where this list can be accessed. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
GET /v1/reporting/report_runs/{report_run}
Retrieve a Report Run
Retrieves the details of an existing Report Run.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
expand | query | array of string | Specifies which fields in the response should be expanded. |
report_run | path | string |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
error | string | If something should go wrong during the run, a message about the failure (populated when `status=failed`). |
id required | string | Unique identifier for the object. |
livemode required | boolean | `true` if the report is run on live mode data and `false` if it is run on test mode data. |
object required | string | String representing the object's type. Objects of the same type share the same value. |
parameters required | financial_reporting_finance_report_run_run_parameters | |
report_type required | string | The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`. |
result | one of multiple schemas | The file object representing the result of the report run (populated when `status=succeeded`). |
status required | string | 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. |
succeeded_at | integer | Timestamp at which this run successfully finished (populated when `status=succeeded`). Measured in seconds since the Unix epoch. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
GET /v1/reporting/report_types/{report_type}
Retrieve a Report Type
Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
expand | query | array of string | Specifies which fields in the response should be expanded. |
report_type | path | string |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
data_available_end required | integer | Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. |
data_available_start required | integer | Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. |
default_columns | array of string | 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.) |
id required | string | The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`. |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
name required | string | Human-readable name of the Report Type |
object required | string | String representing the object's type. Objects of the same type share the same value. |
updated required | integer | When this Report Type was latest updated. Measured in seconds since the Unix epoch. |
version required | integer | 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. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |