Personal finance · Calculation
Student loan deferment
Calculate repayment principal and payment after the entered deferment. The fee is withheld from proceeds. Subsidy status determines whether deferment interest accrues. loanType is fixed to STUDENT and loanTerm is in years.
Example result · principalAndInterest: 264.8041182236 USD/month See output
- Cost per success
- 1 calculation credit
- Production plans
- Standard, Business, Scale, Enterprise
Plan allowances - Free sandbox
- Not available
Integration example
Make a request
Use a production key scoped to student-loan-deferment.
Keep the key on your server. A successful call uses 1 calculation credit.
Set HT_PRODUCTION_KEY on your server. Save as example.mjs and run node example.mjs with Node.js 18 or later.
import { randomUUID } from "node:crypto";
const key = process.env.HT_PRODUCTION_KEY;
if (!key) throw new Error("Set HT_PRODUCTION_KEY on your server.");
const endpoint = "https://calc.hasstechapi.com/v2/calc/student-loan-deferment";
const input = {
"params": {
"loanAmount": 20000,
"interestRate": 5.5,
"loanTerm": 10,
"originationFee": 1.057,
"defermentMonths": 48,
"loanSubtype": "unsubsidized"
},
"loanType": "STUDENT"
};
const requestId = process.env.HT_REQUEST_ID || Date.now() + "." + randomUUID();
// Keep this ID to look up usage if the connection is interrupted.
console.error("Usage lookup ID:", requestId);
const response = await fetch(endpoint, {
method: "POST",
redirect: "error",
headers: {
"Authorization": "Bearer " + key,
"Content-Type": "application/json",
"Idempotency-Key": requestId
},
body: JSON.stringify(input)
});
if (!response.ok) {
const problem = await response.json().catch(() => null);
const code = problem?.error?.code || response.statusText;
const delay = response.headers.get("retry-after");
if (delay) console.error("Retry-After (seconds):", delay);
console.error("HTTP " + response.status + " " + code + ". Usage lookup ID: " + requestId);
if (Array.isArray(problem?.error?.details)) {
for (const issue of problem.error.details) console.error("Input issue:", JSON.stringify(issue));
}
process.exitCode = 1;
} else {
console.log(JSON.stringify(await response.json(), null, 2));
} cURL (shell)
(
set -eu
: "${HT_PRODUCTION_KEY:?Set HT_PRODUCTION_KEY on your server}"
request_id="${HT_REQUEST_ID:-}"
if [ -z "$request_id" ]; then
request_id=$(python3 -c 'import time, uuid; print(str(time.time_ns() // 1000000) + "." + str(uuid.uuid4()))')
fi
printf 'Usage lookup ID: %s\n' "$request_id" >&2
# On INVALID_INPUT, read error.details in the JSON response body.
curl --disable --silent --show-error --fail-with-body --include \
--request POST 'https://calc.hasstechapi.com/v2/calc/student-loan-deferment' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"params": {
"loanAmount": 20000,
"interestRate": 5.5,
"loanTerm": 10,
"originationFee": 1.057,
"defermentMonths": 48,
"loanSubtype": "unsubsidized"
},
"loanType": "STUDENT"
}
HT_INPUT
) If your request fails
400 INVALID_INPUT-
Read
error.detailswhen present. Node prints each issue. cURL returns the JSON body. Eachpathpoints into your request. An empty path refers to the whole body.Check the accepted inputs for required fields, units and ranges. Send the corrected JSON as a new request.
401or403- Check that the server has the bearer key for the endpoint’s environment and that the key includes
student-loan-deferment. 429- Read the service error code, check your allowance, and wait for the
Retry-Afterinterval when supplied before trying again. - Lost response,
409or503 - Open Request lookup, select the same environment and enter the printed usage lookup ID. A settled ID has already consumed credits. To retry the same calculation, set
HT_REQUEST_IDto the original ID and reuse the same inputs. A settled request does not return its result again. Unset the variable for a new request, which can consume credits.
The usage lookup ID is the Idempotency-Key your server sends. The response’s x-request-id identifies the HTTP exchange for support.
Output
Example result
These values come from running this operation on the example inputs.
principalAndInterest- 264.8041182236 USD/month
monthlyTax- 0
monthlyInsurance- 0
Full example response (JSON)
{
"status": "available",
"result": {
"principalAndInterest": 264.8041182236,
"monthlyTax": 0,
"monthlyInsurance": 0,
"monthlyPMI": 0,
"monthlyPayment": 264.8041182236,
"monthlyPrincipal": 152.9707848902667,
"monthlyInterest": 111.83333333333333,
"totalPayment": 31776.494186832002,
"totalFinancingPayment": 31776.494186832002,
"totalInterest": 7376.494186832002,
"loanAmount": 24400,
"upfrontFees": 0,
"originationFeeAmount": 211.39999999999998,
"feeDeductedFromProceeds": 211.39999999999998,
"capitalizedInterest": 4400,
"businessDscr": 0
},
"formulaVersion": "student-loan-deferment-htcalc-719df2c0e105",
"units": {
"principalAndInterest": "USD/month",
"loanAmount": "USD",
"capitalizedInterest": "USD",
"feeDeductedFromProceeds": "USD"
},
"assumptions": [],
"warnings": [],
"creditCost": 1
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
loanTypeRequiredFixed calculation branch.
Must equal "STUDENT"paramsRequiredparams.defermentMonthsOptionalDeferment before repayment begins. In whole months.
Min 0 · Max 120 · Default: 0params.interestRateRequiredAnnual note rate. In percentage points (6.5 means 6.5%).
Min 0 · Max 100params.loanAmountRequiredGross principal before any origination fee is withheld. In USD.
Min 1 · Max 500000params.loanSubtypeOptionalTreatment of interest during deferment.
Allowed: "subsidized", "unsubsidized" · Default: "unsubsidized"params.loanTermRequiredRepayment term following deferment. In whole years.
Min 1 · Max 100params.originationFeeOptionalOrigination fee withheld from proceeds. In percentage points (6.5 means 6.5%).
Min 0 · Max 10 · Default: 0Example request body (JSON)
{
"params": {
"loanAmount": 20000,
"interestRate": 5.5,
"loanTerm": 10,
"originationFee": 1.057,
"defermentMonths": 48,
"loanSubtype": "unsubsidized"
},
"loanType": "STUDENT"
} Full JSON schema
{
"additionalProperties": false,
"properties": {
"loanType": {
"const": "STUDENT",
"description": "Fixed calculation branch.",
"type": "string"
},
"params": {
"additionalProperties": false,
"properties": {
"defermentMonths": {
"default": 0,
"description": "Deferment before repayment begins. In whole months.",
"maximum": 120,
"minimum": 0,
"type": "integer"
},
"interestRate": {
"anyOf": [
{
"const": 0
},
{
"minimum": 0.000001
}
],
"description": "Annual note rate. In percentage points (6.5 means 6.5%).",
"maximum": 100,
"minimum": 0,
"type": "number"
},
"loanAmount": {
"description": "Gross principal before any origination fee is withheld. In USD.",
"maximum": 500000,
"minimum": 1,
"type": "number"
},
"loanSubtype": {
"default": "unsubsidized",
"description": "Treatment of interest during deferment.",
"enum": [
"subsidized",
"unsubsidized"
],
"type": "string"
},
"loanTerm": {
"description": "Repayment term following deferment. In whole years.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"originationFee": {
"default": 0,
"description": "Origination fee withheld from proceeds. In percentage points (6.5 means 6.5%).",
"maximum": 10,
"minimum": 0,
"type": "number"
}
},
"required": [
"loanAmount",
"interestRate",
"loanTerm"
],
"type": "object"
}
},
"required": [
"loanType",
"params"
],
"type": "object"
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/student-loan-deferment
Formula: student-loan-deferment-htcalc-719df2c0e105