HomeGuidesAPI Reference

RepaymentPlanSummary

Payitoff API: RepaymentPlanSummary Schema

An Enrollment object will always include a RepaymentPlanSummary object under the repayment_plan property.

Schema Definition

PropertyTypeFormatDescription
descriptionstringThe full human-readable name of the IDR Plan a Borrower has asked to be enrolled in.
typestringsave
paye
repaye
ibr
new_ibr
icr
An abbreviated code that indicates the IDR Plan a Borrower has asked to be enrolled in.

Example

{
  "description": "Pay As You Earn Repayment Plan",
  "type": "paye"
}