Billing Runs: Gets a single billing run by its identifier.
GET
/api/billing-runs/{id}
deprecated
Requires: MerchantBilling.BillingRuns, merchant scope.
**Required permissions**: `MerchantBilling.BillingRuns` **Scope**: merchant
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 |
|---|---|---|---|
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
200 The billing run was found.
Body: BillingRunDto
Each item has these fields.
| Field | Type | Description |
|---|---|---|
id
required |
string (uuid) | |
creationTime
required |
string (date-time) | The date and time when this entity was created. |
creatorId
required |
string (uuid) | The ID of the user who created this entity. nullable |
lastModificationTime
required |
string (date-time) | The date and time when this entity was last modified. nullable |
lastModifierId
required |
string (uuid) | The ID of the user who last modified this entity. nullable |
isDeleted
required |
boolean | Indicates whether this entity has been deleted. |
deleterId
required |
string (uuid) | The ID of the user who deleted this entity, if it is deleted. nullable |
deletionTime
required |
string (date-time) | The date and time when this entity was deleted, if it is deleted. nullable |
resellerId
required |
string (uuid) | nullable |
resellerName
required |
string | Display name of the reseller the run billed. Populated on list reads, where runs of the caller's own reseller and of resellers beneath it can appear; null when it cannot be resolved. nullable |
periodKey
required |
string | nullable |
status
required |
all of MerchantBillingRunStatus | nullable |
triggerType
required |
all of BillingRunTriggerType | nullable |
isDryRun
required |
boolean | nullable |
totalMerchants
required |
integer (int32) | nullable |
successCount
required |
integer (int32) | nullable |
failureCount
required |
integer (int32) | nullable |
skippedCount
required |
integer (int32) | nullable |
totalBilledAmount
required |
number (double) | nullable |
currency
required |
string | nullable |
orchestrationInstanceId
required |
string | nullable |
startedAt
required |
string (date-time) | nullable |
completedAt
required |
string (date-time) | nullable |
cancelledByUserId
required |
string (uuid) | nullable |
cancelledByUserName
required |
string | nullable |
cancelReason
required |
string | nullable |
failureReason
required |
string | Diagnostic reason a run reached `Failed` (e.g. processing was interrupted by a host restart). Null when the run did not fail or predates this field. nullable |
merchantResults
required |
array of BillingRunResultDto | nullable |
preSelectionExclusions
required |
array of BillingRunExclusionDto | Merchants excluded before selection with the reason each was skipped. Lets the detail UI explain a lower-than-expected billed count instead of silently omitting them. nullable |
concurrencyStamp
required |
string | nullable |
This response has no documented body fields.
404 No billing run exists with the specified id (or it is outside the caller's reseller scope).
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.
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.