PaymentPlanStatus
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Lifecycle of an invoice payment plan: a schedule that splits an issued invoice's outstanding balance into a series of dated installments. Only meaningful on invoices that carry a plan; invoices without one have no plan state.
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.
Active |
Installments remain outstanding; the plan is collecting (manually or automatically). |
Completed |
Every installment was paid (or cancelled); the plan is complete. |
Cancelled |
The plan was cancelled; remaining installments no longer apply. The invoice balance is unchanged and remains payable normally. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.