Billing Runs: Cancels a pending or running billing run.
POST
/api/billing-runs/{id}/cancel
deprecated
Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Create, merchant scope.
The optional cancellation reason is supplied in the request body (not the query string) so the free-text note is not captured by ingress/access logs, proxies, or APM. The body is optional: an empty body cancels the run with no attributed reason.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id
required |
path | string (uuid) | The billing run identifier. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
204 The billing run was cancelled.
| Field | Type | Description |
|---|
This response has no documented body fields.
400 The run is not in a pending or running state, or the reason is too long.
| Field | Type | Description |
|---|
This response has no documented body fields.
404 No billing run exists with the specified id.
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.