Student Loan Repayment Options

A studentLoanRepaymentOption object returns all the financial details of a given Repayment Plan that allows a partner to provide a consumer the ability to see or compare various Plans against their current Repayment Plan, and choose a Plan that works best for their goals and needs.

With your consumer and their debts successfully created, you're ready to fetch available studentLoanRepaymentOptions.

For the most accurate repayment options, make sure the following fields are set on the consumer:

• agi — their Adjusted Gross Income
• filingStatus — Tax Filing Status from their last federal income tax return
  • If married filing jointly, we will need the consumer’s spouse’s agi
  • if married filing jointly, we will need the consumer’s spouse’s federalLoanBalance
• familySize — the Family Size claimed on their taxes
• maritalStatus - Marital Status of the consumer

An Example Query that fetches all repayment options for the consumer

query($consumerUUID: UUID4!) {
  consumer(uuid: $consumerUUID) {
    studentLoanRepaymentOptions {
      inputs {
        agi
        familySize
        federalLoanBalance
        filingStatus
        maritalStatus
        privateLoanBalance
        spouseAgi
        spouseFederalLoanBalance
      }
      original {
        amountForgiven
        finalMonthlyPayment
        monthlyPayment
        numberOfPayments
        outstandingInterest
        outstandingPrincipal
        totalCost
        totalPaid
      }
      options {
        annualSnapshots {
          agi
          currentDate
          interestSubsidy
          monthlyPayment
          outstandingInterest
          outstandingPrincipal
          totalPaid
          totalPayments
        }
        amountForgiven
        eligibleDebts {
          uuid
        }
        estimatedTaxLiability
        finalMonthlyPayment
        ineligibleDebts {
          uuid
        }
        ineligibleReasons
        name
        numberOfPayments
        pslfEligible
        repaymentPlan {
          description
          idr
          name
          pslfEligible
          type
        }
        scheduledMonthlyPayment
        startingMonthlyPayment
        totalCost
        totalPaid
      }
    }
  }
}

The variables to fetch repayment options must include the Consumer's UUID, for example:

{
	"consumerUUID": "d66a9ec4-1d9d-4517-b342-10097e5753d0"
}

For complete GraphQL documentation see here.

Here to help: Repayment Option Eligibility

Each repayment option can provide an ineligibleReasons array which, if empty, indicates that the consumer is eligible for that repayment plan.

For example, if your consumer doesn’t have Student Loan debts or they have a 0 balance on their student loan debts you will see ineligibleReasons on the options.