CreatePaymentPlanInput
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Input for setting up an installment payment plan against an issued invoice's outstanding balance.
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 | ||||||
|---|---|---|---|---|---|---|---|---|
installmentCount
required |
integer (int32) | Number of equal installments to split the balance into. Ignored when `customAmounts` is supplied.
Conditional: When CustomAmounts is null or CustomAmounts.Count == 0. Range: 2 to 60.
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.
| ||||||
firstDueDate
required |
string (date-time) | The due date of the first installment. Subsequent due dates are spaced by `frequency`.
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.
| ||||||
frequency
required |
PaymentPlanFrequency PaymentPlanFrequency | The cadence between installment due dates.
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 | When true, each installment is auto-charged against `paymentTokenId` as it comes 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 to auto-charge. Required when `autoCollect` is true.
Required: When AutoCollect is true.
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.
| ||||||
customAmounts
required |
array of number (double) array of | Optional explicit per-installment amounts. When supplied, they must sum to the invoice balance.
Conditional: When CustomAmounts is not null and CustomAmounts.Count > 0.
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 model has no documented fields.