Skip to content

Personal finance · Calculation

Debt payoff

Compare avalanche and snowball with the same committed monthly budget.

Example result · avalanche.remainingBalance: 0 See output

Cost per success
2 calculation credits
Production plans
Standard, Business, Scale, Enterprise
Plan allowances
Free sandbox
Available · see example

Integration example

Make a request

Use a free sandbox key scoped to debt-payoff-comparison. New developer? Create a workspace and register an application to issue your key.

Keep the key on your server. A successful call uses 2 calculation credits from the selected environment.

Free sandbox request

Set HT_SANDBOX_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_SANDBOX_KEY;
if (!key) throw new Error("Set HT_SANDBOX_KEY on your server.");
const endpoint = "https://sandbox.hasstechapi.com/v2/calc/debt-payoff-comparison";
const input = {
  "debts": [
    {
      "balance": 100,
      "annualRate": 0,
      "minimumPayment": 100
    }
  ],
  "extraPayment": 100
};
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 HT_SANDBOX_KEY on your server. Run in a POSIX shell with cURL 7.76+ and Python 3.7+ to create a request ID.

(
  set -eu
  : "${HT_SANDBOX_KEY:?Set HT_SANDBOX_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://sandbox.hasstechapi.com/v2/calc/debt-payoff-comparison' \
    --header "Authorization: Bearer $HT_SANDBOX_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "debts": [
    {
      "balance": 100,
      "annualRate": 0,
      "minimumPayment": 100
    }
  ],
  "extraPayment": 100
}
HT_INPUT
)
Production request

Run in production

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/debt-payoff-comparison";
const input = {
  "debts": [
    {
      "balance": 100,
      "annualRate": 0,
      "minimumPayment": 100
    }
  ],
  "extraPayment": 100
};
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 HT_PRODUCTION_KEY on your server. Run in a POSIX shell with cURL 7.76+ and Python 3.7+ to create a request ID.

(
  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/debt-payoff-comparison' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "debts": [
    {
      "balance": 100,
      "annualRate": 0,
      "minimumPayment": 100
    }
  ],
  "extraPayment": 100
}
HT_INPUT
)
If your request fails
400 INVALID_INPUT

Read error.details when present. Node prints each issue. cURL returns the JSON body. Each path points 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.

401 or 403
Check that the server has the bearer key for the endpoint’s environment and that the key includes debt-payoff-comparison.
429
Read the service error code, check your allowance, and wait for the Retry-After interval when supplied before trying again.
Lost response, 409 or 503
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_ID to 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.

avalanche.remainingBalance
0
avalanche.months
1
snowball.remainingBalance
0
How to interpret this result
  • Canonical waterfall, rounded monthly interest; freed minimums roll into later months.
  • Two requested strategies cost two credits; internal minimum-only helpers are not additional public scenarios.
  • 360-month cap; ordinal IDs; no dates or clock reads.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "avalanche": {
      "schedule": [
        {
          "month": 1,
          "totalBalance": 0,
          "accounts": [
            {
              "id": "debt-1",
              "payment": 100,
              "balance": 0
            }
          ]
        }
      ],
      "remainingBalance": 0,
      "complete": true,
      "months": 1
    },
    "snowball": {
      "schedule": [
        {
          "month": 1,
          "totalBalance": 0,
          "accounts": [
            {
              "id": "debt-1",
              "payment": 100,
              "balance": 0
            }
          ]
        }
      ],
      "remainingBalance": 0,
      "complete": true,
      "months": 1
    },
    "scenarioCount": 2
  },
  "formulaVersion": "debt-payoff-1.0.0",
  "units": {
    "avalanche/snowball.schedule[].month": "months",
    "avalanche/snowball.schedule[].accounts[].payment": "USD",
    "avalanche/snowball.schedule[].accounts[].balance": "USD",
    "avalanche/snowball.schedule[].totalBalance": "USD",
    "avalanche/snowball.remainingBalance": "USD",
    "avalanche/snowball.months": "months",
    "scenarioCount": "count"
  },
  "assumptions": [
    "Canonical waterfall, rounded monthly interest; freed minimums roll into later months.",
    "Two requested strategies cost two credits; internal minimum-only helpers are not additional public scenarios.",
    "360-month cap; ordinal IDs; no dates or clock reads."
  ],
  "warnings": [],
  "creditCost": 2
}

Request contract

Accepted inputs

Fields for this example. Expand the schema for all supported combinations and limits.

FieldType, units and limits

debtsRequired
array

Debts to compare using the same monthly extra payment.

Min items 1 · Max items 20
debts[].balanceRequired
number · USD

Outstanding balance of this debt.

Min 0 · Max 1000000000 · Step 0.01
debts[].annualRateRequired
number · percentage-points

Nominal annual rate. Enter 6.5 for 6.5%.

Min 0 · Max 100 · Step 1e-9
debts[].minimumPaymentRequired
number · USD/month

Monthly minimum payment on this debt.

Min 0 · Max 1000000000 · Step 0.01
extraPaymentRequired
number · USD/month

Additional payment made each month.

Min 0 · Max 1000000000 · Step 0.01
Example request body (JSON)
{
  "debts": [
    {
      "balance": 100,
      "annualRate": 0,
      "minimumPayment": 100
    }
  ],
  "extraPayment": 100
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "debts": {
      "type": "array",
      "description": "Debts to compare using the same monthly extra payment.",
      "items": {
        "type": "object",
        "properties": {
          "balance": {
            "type": "number",
            "description": "Outstanding balance of this debt.",
            "x-unit": "USD",
            "minimum": 0,
            "maximum": 1000000000,
            "multipleOf": 0.01,
            "x-core-refinement": true
          },
          "annualRate": {
            "type": "number",
            "description": "Nominal annual rate. Enter 6.5 for 6.5%.",
            "x-unit": "percentage-points",
            "minimum": 0,
            "maximum": 100,
            "multipleOf": 1e-9,
            "x-core-refinement": true
          },
          "minimumPayment": {
            "type": "number",
            "description": "Monthly minimum payment on this debt.",
            "x-unit": "USD/month",
            "minimum": 0,
            "maximum": 1000000000,
            "multipleOf": 0.01,
            "x-core-refinement": true
          }
        },
        "required": [
          "balance",
          "annualRate",
          "minimumPayment"
        ],
        "additionalProperties": false
      },
      "minItems": 1,
      "maxItems": 20
    },
    "extraPayment": {
      "type": "number",
      "description": "Additional payment made each month.",
      "x-unit": "USD/month",
      "minimum": 0,
      "maximum": 1000000000,
      "multipleOf": 0.01,
      "x-core-refinement": true
    }
  },
  "required": [
    "debts",
    "extraPayment"
  ],
  "additionalProperties": false
}

Production endpoint: POST https://calc.hasstechapi.com/v2/calc/debt-payoff-comparison
Formula: debt-payoff-1.0.0

Related PDF reports