NameDescriptionTypeAdditional information
BillingAccounts

Contains the list of billing accounts that this payment plan is firing against.

Collection of PaymentPlanSetupAccountModel

None.

CanEdit

Specifies whether this payment plan can be modified.

boolean

None.

CreateDate

Contains the creation date of this payment plan.

date-time

None.

CurrencySymbol

string

None.

CustomerID

Contains the customer ID associated with this payment plan.

int?

None.

DayToPay

Contains the day of the month that this payment plan fires.

int

None.

DayType

Specifies whether this payment plan was created to fire against the due day of the active bill, or specific fixed day of month.

PaymentPlanDayType

None.

DisplayDescription

Contains a short text description of this payment plan.

string

None.

InitialBalance

Contains the initial account balance when this payment plan was created.

decimal

None.

LastEvaluatedDate

Contains the date and time when the payment plan was last evaluated.

date-time?

None.

LastPaymentAmount

Contains the last payment amount that this payment plan made.

decimal

None.

LastPaymentDate

Contains the date of the final payment for this payment plan.

date-time

None.

MonthlyAmount

Contains the monthly amount that this payment plan fires.

decimal

None.

PaymentAccount

Contains the details of the payment account that this payment plan uses to fire.

PaymentAccountResponseModel

None.

PaymentAccountID

Contains the ID of the payment account that this payment plan uses to fire.

int

None.

PaymentAmount

Contains the payment amount that this payment plan will pay each time it fires.

decimal

None.

PaymentCount

Contains the number of times this payment plan has fired.

int

None.

PaymentName

Contains the name of the payment plan.

string

None.

PaymentPlanID

Contains the ID of this payment plan.

int

None.

PaymentPlanType

Specifies whether this payment plan is fixed or variable.

PaymentPlanType

None.

Payments

For customized payment plan amounts, contains the list of individual customized payment amounts for the duration of the payment plan.

Collection of PaymentPlanPaymentResponseModel

None.

PPD

Specifies whether this payment plan is a PPD.

boolean

None.

RemainingBalance

Contains the remaining account balance.

decimal

None.

StartDate

Contains the starting date of this payment plan.

date-time

None.

Status

Contains the status of this payment plan.

PaymentPlanStatus

None.

Term

Contains the term of this payment plan.

int

None.

UpdateDate

Contain the date and time when this payment plan was last updated.

date-time?

None.