PortfolioRepaymentPlan
Payitoff API: PortfolioRepaymentPlan
Schema
Every PortfolioLoan
in repayment is on a Repayment Plan. While many of our API request payload objects and responses indicate a repayment_plan_type
as a short, helpful string
representation of a PortfolioLoan
's current Repayment Plan, the PortfolioRepaymentPlan
object provides full details.
Schema Definition
Property | Type | Format | Description |
---|---|---|---|
|
| A full description of this plan. | |
|
| Is this an income-driven Repayment Plan? | |
|
|
| The type of Repayment Plan, often used as shorthand (in all-caps) and the value you'd supply in |
Example
{
"description": "Pay As You Earn Repayment Plan",
"income_driven_repayment": true,
"type": "paye"
}
Updated 5 months ago