Billing Runs: Creates and runs a billing run for the caller's reseller scope.
POST
/api/billing-runs
deprecated
Requires: MerchantBilling.BillingRuns, MerchantBilling.BillingRuns.Create, merchant scope.
A reseller caller (or an admin acting inside a reseller's context) runs that single reseller; an admin with no reseller context fans out across every reseller with billable merchants. Set `ResellerId` to run one named reseller instead: the caller's own or one beneath it (an admin may name any). Set `IsDryRun` on the input for a preview that calculates charges without generating invoices.
Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.
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 CreateBillingRunInput. See the Request body section below for its fields.
Parameters
Request body
application/json
, required
| Field | Type | Description |
|---|---|---|
periodKey
required |
string | Billing period key in yyyyMM format (e.g., "202602" for February 2026).
nullablemin length 0max length 10
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
isDryRun
required |
boolean | When true, calculates charges without generating invoices (preview mode).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
resellerId
required |
string (uuid) | Optional reseller to run billing for. Omit it to run for the caller's own reseller (or, for an
admin with no reseller selected, to bill every reseller). When set, the run bills that one
reseller's merchants; a reseller caller may name their own reseller or any reseller beneath it,
and an admin may name any reseller. A reseller outside the caller's scope is reported as not
found. Not accepted by the all-resellers trigger.
Conditional: When ResellerId is not null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This request body has no documented fields.
Responses
200 The run was created (or the fan-out was started).
Body:
BillingRunBatchResultDto
BillingRunBatchResultDto
Each item has these fields.
| Field | Type | Description | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
periodKey
required |
string | Billing period key (yyyyMM) the batch was run for.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
isDryRun
required |
boolean | True when charges were previewed without generating invoices/charges.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
wasFanOut
required |
boolean | True when this was an admin cross-reseller fan-out; false for a single-reseller run.
Drives whether the UI shows the multi-reseller summary or the single-run message.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
isAsyncStarted
required |
boolean | True when the fan-out was started as a Durable background process rather than
run inline: the per-reseller counts in this result are not yet populated. Callers track
progress via `BillingRunBatchStatusDto` (`batchId`).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
batchId
required |
string (uuid) | The background batch id when `isAsyncStarted` is true; otherwise null.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
resellersConsidered
required |
integer (int32) | Number of resellers evaluated (the full set considered for the run).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
resellersRun
required |
integer (int32) | Number of resellers for which a billing run actually executed.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
resellersSkipped
required |
integer (int32) | Number of resellers skipped without running: no billable merchants for the period,
or a completed run already exists / is in progress for the period.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
resellersFailed
required |
integer (int32) | Number of resellers whose run failed.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
totalMerchantsBilled
required |
integer (int32) | Total merchants successfully billed across every reseller run in the batch.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
totalMerchantsFailed
required |
integer (int32) | Total merchants that failed within the executed reseller runs. A run can complete at the
reseller level while individual merchants fail; this surfaces those so the toast severity
reflects them (a fan-out with merchant failures is not a clean success).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
outcomes
required |
array of BillingRunResellerOutcomeDto array of BillingRunResellerOutcomeDto | Per-reseller outcomes.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||||||||||||||||||||||
Fields of each BillingRunResellerOutcomeDto:
This body has no documented fields. | ||||||||||||||||||||||||||||||||||||||||
This response has no documented body fields.
403 Forbidden
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
401 Unauthorized
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
400 Bad Request
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
404 The named reseller does not exist or is outside the caller's reseller scope.
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
501 Not Implemented
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
500 Internal Server Error
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
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. The error reference lists the values `error.code` can take. 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. The error reference lists the values `error.code` can take.
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: 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. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.
Body:
RemoteServiceErrorResponse
RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo RemoteServiceErrorInfo |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
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.