StudentLoan.help: federal repayment plan calculator

{
  "type": "object",
  "required": [
    "loans",
    "agi",
    "offered_apr_pct"
  ],
  "properties": {
    "agi": {
      "type": "number",
      "maximum": 10000000,
      "minimum": 0,
      "description": "Borrower's adjusted gross income in dollars per year."
    },
    "loans": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type",
          "balance",
          "rate_pct"
        ],
        "properties": {
          "type": {
            "enum": [
              "direct",
              "ffel",
              "parent_plus",
              "private"
            ],
            "type": "string",
            "description": "direct, ffel (FFEL or Perkins), parent_plus (or a consolidation of one), or private."
          },
          "balance": {
            "type": "number",
            "maximum": 5000000,
            "minimum": 0,
            "description": "Current balance in dollars."
          },
          "rate_pct": {
            "type": "number",
            "maximum": 25,
            "minimum": 0,
            "description": "Annual interest rate in percent, e.g. 6.39."
          }
        },
        "additionalProperties": false
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "Each loan: type, balance in dollars and annual interest rate in percent, e.g. [{\"type\":\"direct\",\"balance\":38000,\"rate_pct\":6.39}]. Direct includes Grad PLUS and Direct Consolidation loans."
    },
    "region": {
      "enum": [
        "contiguous_48_or_dc",
        "alaska",
        "hawaii"
      ],
      "type": "string",
      "default": "contiguous_48_or_dc",
      "description": "Poverty guideline region: contiguous_48_or_dc, alaska or hawaii."
    },
    "employer": {
      "enum": [
        "for_profit",
        "government",
        "nonprofit_501c3",
        "nonprofit_other"
      ],
      "type": "string",
      "default": "for_profit",
      "description": "for_profit (or self-employed), government, nonprofit_501c3 or nonprofit_other. Government and 501(c)(3) add the PSLF projection."
    },
    "full_time": {
      "type": "boolean",
      "default": true,
      "description": "Works at least 30 hours a week for a qualifying employer (needed for PSLF)."
    },
    "refinance": {
      "enum": [
        "everything",
        "private_only"
      ],
      "type": "string",
      "default": "everything",
      "description": "everything (federal and private) or private_only."
    },
    "dependents": {
      "type": "integer",
      "default": 0,
      "maximum": 20,
      "minimum": 0,
      "description": "Dependents claimed; RAP subtracts $50 a month for each."
    },
    "loan_dates": {
      "enum": [
        "owed_before_2014_07_01",
        "first_loan_2014_to_2026",
        "loan_on_or_after_2026_07_01"
      ],
      "type": "string",
      "default": "first_loan_2014_to_2026",
      "description": "owed_before_2014_07_01 (IBR at 15%), first_loan_2014_to_2026 (IBR at 10%), or loan_on_or_after_2026_07_01 (only RAP and Tiered Standard)."
    },
    "spouse_agi": {
      "type": "number",
      "default": 0,
      "maximum": 10000000,
      "minimum": 0,
      "description": "Spouse's AGI in dollars; counted only when married_joint."
    },
    "term_years": {
      "enum": [
        5,
        7,
        10,
        15,
        20
      ],
      "type": "integer",
      "default": 10,
      "description": "Refinance term in years: 5, 7, 10, 15 or 20."
    },
    "filing_status": {
      "enum": [
        "single",
        "married_joint",
        "married_separate"
      ],
      "type": "string",
      "default": "single",
      "description": "single (or head of household), married_joint or married_separate."
    },
    "household_size": {
      "type": "integer",
      "default": 1,
      "maximum": 20,
      "minimum": 1,
      "description": "Household size (borrower, spouse, dependents); sets the poverty line for IBR."
    },
    "offered_apr_pct": {
      "type": "number",
      "maximum": 30,
      "minimum": 0.01,
      "description": "APR the lender actually offered, in percent, e.g. 5.5."
    },
    "income_growth_pct": {
      "type": "number",
      "default": 3,
      "maximum": 20,
      "minimum": 0,
      "description": "Assumed yearly income growth in percent (calculator default 3)."
    },
    "poverty_growth_pct": {
      "type": "number",
      "default": 2.5,
      "maximum": 20,
      "minimum": 0,
      "description": "Assumed yearly poverty guideline growth in percent (calculator default 2.5)."
    },
    "pslf_payments_made": {
      "type": "integer",
      "default": 0,
      "maximum": 120,
      "minimum": 0,
      "description": "PSLF qualifying payments already counted, 0 to 120."
    },
    "spouse_federal_loan_balance": {
      "type": "number",
      "default": 0,
      "maximum": 5000000,
      "minimum": 0,
      "description": "Spouse's federal loan balance; prorates the payment when married_joint."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "topic": {
      "enum": [
        "rap",
        "ibr",
        "standard",
        "tiered_standard",
        "pslf",
        "parent_plus",
        "save_ending",
        "poverty_guidelines"
      ],
      "type": "string",
      "description": "One of: rap, ibr, standard, tiered_standard, pslf, parent_plus, save_ending, poverty_guidelines. Omit for a one-line summary of each."
    }
  },
  "additionalProperties": false
}