The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.
API reference
/
Models
ContinuationPagedResultDtoOfRecurringBillingRunSummaryDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents a page of results obtained through continuation-token paging.
Supports an approximate total count for display purposes.
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 items
required array of RecurringBillingRunSummaryDto
array of RecurringBillingRunSummaryDto The items returned for this page.
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 RecurringBillingRunSummaryDto:
Field
Type
Description id
required string (uuid)
The document ID.
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)
Links all per-merchant run documents from the same workflow execution.
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.
merchantId
required string (uuid)
The merchant this run was executed for.
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.
runDate
required string (date-time)
The business date of this billing 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.
triggerType
required RecurringBillingTriggerType
RecurringBillingTriggerType Whether this run was auto or manually triggered.
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.
AutoTriggered automatically by the scheduled cron job. ManualTriggered manually by an administrator via the API or UI.
contractCount
required integer (int32)
Number of contracts processed.
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.
successCount
required integer (int32)
Number of successful billing attempts.
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.
failedCount
required integer (int32)
Number of failed billing attempts.
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.
skippedCount
required integer (int32)
Number of skipped contracts (already billed).
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)
Total amount billed across all contracts.
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.
status
required RecurringBillingRunStatus
RecurringBillingRunStatus Execution status.
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.
PendingThe run has been created but not yet started. RunningThe run is currently executing. CompletedAll contracts in the run were processed successfully. FailedThe run failed entirely (infrastructure or unrecoverable error). PartiallyCompletedSome contracts succeeded and some failed.
correlationId
required string (uuid)
Correlation identifier for distributed tracing.
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.
durationMs
required integer (int64)
Total duration of the run in milliseconds.
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.
creationTime
required string (date-time)
When this run was created.
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 body has no documented fields.
nextContinuationToken
required string
Continuation token to use when requesting the next page.
Null means no additional pages exist.
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.
approxTotalCount
required integer (int64)
An approximate total count of matching items.
This value is optional and may be stale or estimated, so treat it as an approximation.
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.
pageItemCount
required integer (int32)
Convenience property for the number of items in this page.
read only 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.
retrievedAt
required string (date-time)
When the page was retrieved. Useful for diagnostics and cache behavior.
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 model has no documented fields.
Next steps