WinkPG Docs
View as Markdown

llms.txt

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:52 UTC.

API reference Models

RecurringBillingRunDetailDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Detail DTO for a recurring billing run, including per-contract items.

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
summary required RecurringBillingRunSummaryDto RecurringBillingRunSummaryDto Summary data for this 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.

Fields of 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.
Auto Triggered automatically by the scheduled cron job.
Manual Triggered 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.
Pending The run has been created but not yet started.
Running The run is currently executing.
Completed All contracts in the run were processed successfully.
Failed The run failed entirely (infrastructure or unrecoverable error).
PartiallyCompleted Some 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.

triggeredByUserId required string (uuid) The user who triggered this run (manual triggers only). 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.
triggeredByUserName required string Display name of the triggering user. 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.
notes required string Notes provided with the manual trigger. 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.
instanceId required string Identifier of the background job that processed this run. 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.
errorMessage required string Error message if the run failed. 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.
errorDetails required array of RecurringBillingRunErrorDetailDto array of RecurringBillingRunErrorDetailDto Structured failure chain for admin-only diagnostic display. Null unless the caller holds `CustomersPermissions.RecurringBilling.ViewErrorDetails`. Each frame is one link of the exception / Durable `FailureDetails` tree (outer-first). 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 RecurringBillingRunErrorDetailDto:

Field Type Description
errorType required string Fully qualified CLR type of the exception (or Durable `FailureDetails.ErrorType`). 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.
errorMessage required string Human-readable exception message. 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.
stackTrace required string Demystified stack trace for the frame, if available. 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 body has no documented fields.

items required array of RecurringBillingRunItemDto array of RecurringBillingRunItemDto Per-contract billing 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 RecurringBillingRunItemDto:

Field Type Description
contractId required string (uuid) The contract that was 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.
customerId required string (uuid) The customer who owns the contract.
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.
amountBilled required number (double) Amount charged.
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.
success required boolean Whether the billing attempt was successful.
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.
skipped required boolean Whether the contract was skipped (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.
transactionId required string (uuid) The transaction created in the payment engine. 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.
failureReason required string Failure reason if the billing attempt failed. 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.
processorResponseCode required string Payment processor response code. 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.
processorMessage required string Payment processor message. 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.
executedAt required string (date-time) When the billing execution started. 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.
completedAt required string (date-time) When the billing execution completed. 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.
persistenceFailed required boolean True when the contract was charged successfully (`success` = true, `transactionId` populated) but the customer document update that would have written the new `ExecutionHistory` record and advanced `NextScheduledRun` failed at `SaveChangesAsync`. The charge stands; the contract's local view of it is missing until the next billing cycle replays the persistence step (deterministic `IdempotencyKey` prevents re-charge). Null when the row's persistence either succeeded or never ran (skipped/failed). 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.
persistenceFailureReason required string Short label naming the exception type that caused `persistenceFailed` (e.g. `"DbUpdateException"`). Surfaced in the run detail UI so operators can distinguish a transient concurrency conflict from a structural shape bug without leaving the page. Null when `persistenceFailed` is 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.
preCreditAmount required number (double) The contract amount this cycle was priced at before any proration credit, pre-surcharge. Null on items written before proration existed and on skips that resolved no amount. 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.
creditApplied required number (double) The proration credit taken off this charge, or null when none applied. 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.
chargedAmount required number (double) The contract amount submitted after the credit, pre-surcharge. Zero for a cycle the credit covered in full; null on items written before proration existed and on skips. 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.
planPriceId required string (uuid) The plan price revision this contract was billed under, or null when the contract carries no plan and on items written before the field existed. 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.
planPriceTotalAmount required number (double) What that revision charges per cycle, resolved from the merchant's plan catalog once for the whole run. Null whenever `planPriceId` is, and also when the revision can no longer be read: the plan it belonged to has since been deleted, or the catalog read failed. 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.
planPriceEffectiveFrom required string (date-time) When that revision started applying, in UTC. Null under the same conditions as `planPriceTotalAmount`. 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.
skipCategory required RecurringBillingSkipCategory RecurringBillingSkipCategory Why the run did not charge this contract, or null when it did or tried to. Set for every skipped item, and for a failed item whose consent state could not be read. Null on items recorded before this field existed. 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.
AlreadyBilled The contract already has a successful charge for this scheduled run. Harmless: nothing is owed, and nothing needs attention.
MerchantIneligible The merchant that owns the contract is missing, deleted, or inactive.
InvalidContract The contract's own per-bill amount is zero or less, so there is nothing to charge.
PlanUnresolved The contract subscribes to a plan whose price could not be read, so the amount is unknown.
MissingConsent The stored payment method has no active stored-credential consent that permits a recurring charge.
ConsentLookupUnavailable The platform could not read the stored payment method's consent state. A platform fault rather than a configuration problem, recorded as a failed run item, and retried on the next run.

This body has no documented fields.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.