Billing Runs: Force-clears the current all-resellers fan-out batch.
POST
/api/billing-runs/batch/clear
deprecated
Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Manage, merchant scope.
Drives a stuck or stale batch to the terminal Cleared state and releases the single-in-flight guard. Restricted to an admin with no reseller context and gated on the dedicated Manage permission.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a . See the Request body section below for its fields.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
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
200 The batch was cleared.
Body: BillingRunBatchStatusDto
Each item has these fields.
| Field | Type | Description |
|---|---|---|
batchId
required |
string (uuid) | Batch document id (the tracking id returned at trigger time). |
orchestrationInstanceId
required |
string | Identifier of the background job processing the batch. Null until processing has started. nullable |
periodKey
required |
string | Billing period key (yyyyMM) the batch is running for. nullable |
isDryRun
required |
boolean | True when charges are previewed without generating invoices/charges. |
status
required |
all of MerchantBillingRunBatchStatus | Current batch status. |
triggeredByUserId
required |
string (uuid) | User that triggered the batch. nullable |
triggeredByUserName
required |
string | Display name of the user that triggered the batch. nullable |
startedAt
required |
string (date-time) | When the fan-out workflow started processing. nullable |
completedAt
required |
string (date-time) | When the batch reached a terminal status. nullable |
clearedByUserName
required |
string | Display name of the admin that force-cleared the batch, when `status` is `Cleared`. nullable |
resellersConsidered
required |
integer (int32) | |
resellersRun
required |
integer (int32) | |
resellersSkipped
required |
integer (int32) | |
resellersFailed
required |
integer (int32) | |
totalMerchantsBilled
required |
integer (int32) | |
totalMerchantsFailed
required |
integer (int32) | |
outcomes
required |
array of BillingRunResellerOutcomeDto | Per-reseller outcomes (populated once the batch completes). nullable |
isInProgress
required |
boolean | True while the batch is non-terminal (Pending or Running). read only |
This response has no documented body fields.
204 No batch existed to clear.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
403 Forbidden
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
401 Unauthorized
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
400 Bad Request
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
404 Not Found
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
501 Not Implemented
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
500 Internal Server Error
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
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.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded. Wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling.
Body: RateLimitProblemDetails
Each item has these fields.
| Field | Type | Description |
|---|---|---|
type
required |
string | The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. nullable |
title
required |
string | A short, human-readable summary of the problem type. nullable |
status
required |
integer (int32) | The HTTP status code, repeated in the body as the problem-details format defines. |
detail
required |
string | A human-readable explanation of this occurrence of the problem. nullable |
retryAfterSeconds
required |
integer (int32) | How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. |
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.