SandboxRecurringBillingRunResultDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
What an accelerated recurring billing run did.
Values
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
| Field | Type | Description |
|---|---|---|
merchantId
required |
string (uuid) | The merchant this run acted on, resolved from the caller's own credential.
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.
|
advancedContractCount
required |
integer (int32) | How many contracts had their next scheduled run brought forward to now.
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.
|
billedContractCount
required |
integer (int32) | How many contracts the engine charged successfully.
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.
|
failedContractCount
required |
integer (int32) | How many contracts the engine attempted and failed to charge.
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.
|
skippedContractCount
required |
integer (int32) | How many contracts the engine passed over without charging.
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.
|
totalAmount
required |
number (double) | The gross amount the successful charges carried.
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.
|
runId
required |
string (uuid) | The billing run record this produced, as it appears in recurring billing history.
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.
|
contracts
required |
array of SandboxRecurringBillingContractResultDto array of SandboxRecurringBillingContractResultDto | What happened to each contract the run touched.
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 SandboxRecurringBillingContractResultDto: This body has no documented fields. | ||
This model has no documented fields.