Name | Description | Type | Additional information |
---|---|---|---|
CustomerToken |
Contains the unique customer token used to identify the customer the payment plan is being added/edited for. |
string |
Required |
DateToStart |
Date to start the payment plan. |
date-time? |
None. |
DayToPay |
Specifies the day of month to fire the payment plan. |
int |
Required |
DayType |
Specifies whether the payment plan fires against the due date on the current bill, or the specified day of the month. |
PaymentPlanDayType |
Required |
FeeWaived |
Specifies whether this payment plan has fee waived. |
boolean |
None. |
MonthlyAmount |
(Obsolete) Specifies the amount to pay each month. |
decimal |
None. |
OriginalPlanID | int? |
None. |
|
OtherData |
For payment plans associated with a single billing account, contains the Other Data of the selected billing account. |
string |
String length: inclusive between 0 and 100 |
PaymentAccount |
For enrolled or one-time payments, contains the new payment account information to use for the payment. Will be saved as an available payment account for enrolled customers. |
PaymentAccountModel |
None. |
PaymentAccountToken |
For enrolled payments, contains the payment account token of the existing payment account to use. |
string |
String length: inclusive between 0 and 2048 |
PaymentAmount |
Specifies the amount to pay every time the payment plan fires. |
decimal |
None. |
PaymentName |
Specifies the name to give this payment plan. |
string |
Required |
Payments |
Optionally specifies the customized payment amounts that will pay off this payment plan. |
Collection of PaymentPlanPaymentModel |
None. |
PPD |
Specifies if this payment plan is a PPD payment. |
boolean |
None. |
ReferenceNumber |
For payment plans associated with a single billing account, contains the Reference Number of the selected billing account |
string |
String length: inclusive between 0 and 100 |
SelectedAccounts |
For payment plans created against master-entity accounts, optionally restricts the billing accounts in the master-entity that the payment plan will fire against. |
Collection of long |
None. |