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
InvoicePaymentPlanDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Read DTO for an invoice payment plan and its installments.
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 status
required PaymentPlanStatus
PaymentPlanStatus Current lifecycle of the plan.
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.
ActiveInstallments remain outstanding; the plan is collecting (manually or automatically). CompletedEvery installment was paid (or cancelled); the plan is complete. CancelledThe plan was cancelled; remaining installments no longer apply. The invoice balance is unchanged and remains payable normally.
createdUtc
required string (date-time)
UTC the plan 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.
autoCollect
required boolean
Whether installments are auto-charged against the stored token as they come due.
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.
paymentTokenId
required string (uuid)
The stored payment-method token used for automatic collection (when `autoCollect`).
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.
installments
required array of PaymentPlanInstallmentDto
array of PaymentPlanInstallmentDto The scheduled installments, in sequence order.
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 PaymentPlanInstallmentDto:
Field
Type
Description id
required string (uuid)
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.
sequenceNumber
required integer (int32)
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.
amount
required number (double)
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.
dueDate
required string (date-time)
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 InstallmentStatus
InstallmentStatus Status of a single installment within an invoice payment plan.
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.
PendingOutstanding: not yet collected. The due date (and any scheduled retry) governs auto-collection. PaidCollected in full; the matching payment reduced the invoice balance. FailedAutomatic collection exhausted its attempts (or hard-declined); the amount is still owed and needs manual intervention. CancelledVoided because the plan was cancelled before this installment was collected.
paidAmount
required number (double)
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.
paidAt
required string (date-time)
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.
transactionId
required string (uuid)
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.
attemptCount
required integer (int32)
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.
lastAttemptUtc
required string (date-time)
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.
nextAttemptUtc
required string (date-time)
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.
lastDeclineReasonCode
required string
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.
This model has no documented fields.
Next steps