Skip to content

Lending · Calculation

Debt payoff plan and dated account milestones

Builds an anchored payment calendar, account clear dates, the alternative waterfall and a minimums-only counterfactual.

Example result · totalBalance: 150 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 debt-payoff-plan-timeline.

Keep the key on your server. A successful call uses 1 calculation credit.

Production request

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-plan-timeline";
const input = {
  "strategy": "snowball",
  "firstPaymentDate": "2027-01-31",
  "extraPayment": 25,
  "debts": [
    {
      "id": "card-a",
      "balance": 100,
      "annualRate": 0,
      "minimumPayment": 25
    },
    {
      "id": "card-b",
      "balance": 50,
      "annualRate": 0,
      "minimumPayment": 25
    }
  ]
};
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-plan-timeline' \
    --header "Authorization: Bearer $HT_PRODUCTION_KEY" \
    --header 'Content-Type: application/json' \
    --header "Idempotency-Key: $request_id" \
    --data-binary @- <<'HT_INPUT'
{
  "strategy": "snowball",
  "firstPaymentDate": "2027-01-31",
  "extraPayment": 25,
  "debts": [
    {
      "id": "card-a",
      "balance": 100,
      "annualRate": 0,
      "minimumPayment": 25
    },
    {
      "id": "card-b",
      "balance": 50,
      "annualRate": 0,
      "minimumPayment": 25
    }
  ]
}
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-plan-timeline.
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.

totalBalance
150
eligibleBalance
150
excludedBalance
0
How to interpret this result
  • Each month the extra budget targets the smallest balance or highest rate. Freed minimums roll into future payments. The simulator stops at 360 months.
  • The caller supplies the first payment date. Short months use their last day, then later months resume the original day.
Full example response (JSON)
{
  "status": "available",
  "result": {
    "totalBalance": 150,
    "eligibleBalance": 150,
    "excludedBalance": 0,
    "numericRangeExceeded": false,
    "totalMinimumPayment": 50,
    "excludedIds": [],
    "selected": {
      "strategy": "snowball",
      "months": 2,
      "paysOff": true,
      "payoffDate": "2027-02-28",
      "interestAccrued": 0,
      "remainingBalance": 0,
      "cleared": [
        {
          "id": "card-b",
          "month": 1,
          "date": "2027-01-31"
        },
        {
          "id": "card-a",
          "month": 2,
          "date": "2027-02-28"
        }
      ]
    },
    "alternate": {
      "strategy": "avalanche",
      "months": 2,
      "paysOff": true,
      "payoffDate": "2027-02-28",
      "interestAccrued": 0,
      "remainingBalance": 0,
      "cleared": [
        {
          "id": "card-b",
          "month": 1,
          "date": "2027-01-31"
        },
        {
          "id": "card-a",
          "month": 2,
          "date": "2027-02-28"
        }
      ]
    },
    "minimumsOnly": {
      "strategy": "snowball",
      "months": 3,
      "paysOff": true,
      "payoffDate": "2027-03-31",
      "interestAccrued": 0,
      "remainingBalance": 0,
      "cleared": [
        {
          "id": "card-b",
          "month": 2,
          "date": "2027-02-28"
        },
        {
          "id": "card-a",
          "month": 3,
          "date": "2027-03-31"
        }
      ]
    },
    "schedule": [
      {
        "month": 1,
        "date": "2027-01-31",
        "totalBalance": 75,
        "accounts": [
          {
            "id": "card-b",
            "payment": 50,
            "balance": 0
          },
          {
            "id": "card-a",
            "payment": 25,
            "balance": 75
          }
        ]
      },
      {
        "month": 2,
        "date": "2027-02-28",
        "totalBalance": 0,
        "accounts": [
          {
            "id": "card-a",
            "payment": 75,
            "balance": 0
          }
        ]
      }
    ],
    "monthsSooner": 1,
    "interestSaved": 0,
    "interestSavedIsLowerBound": false
  },
  "formulaVersion": "debt-payoff-plan-timeline-1.0.0",
  "units": {
    "money": "USD",
    "firstPaymentDate": "UTC calendar date",
    "months": "monthly payments",
    "annualRate": "percent per year",
    "interestSaved": "whole USD"
  },
  "assumptions": [
    "Each month the extra budget targets the smallest balance or highest rate. Freed minimums roll into future payments. The simulator stops at 360 months.",
    "The caller supplies the first payment date. Short months use their last day, then later months resume the original day."
  ],
  "warnings": [],
  "creditCost": 1
}

Request contract

Accepted inputs

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

FieldType, units and limits

strategyRequired
string

Waterfall for the detailed timeline.

Allowed: "avalanche", "snowball"
firstPaymentDateRequired
string

Date of first scheduled payment (UTC YYYY-MM-DD, 1900–2199).

Format: date · Max length 10
extraPaymentRequired
number

Extra monthly principal budget (USD, cents).

Min 0 · Max 1000000000 · Step 0.01
debtsRequired
arrayMin items 0 · Max items 20
debts[].idRequired
string

Caller-assigned account ID, unique within the request.

Min length 1 · Max length 40
debts[].balanceRequired
number

Outstanding principal (USD, cents).

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

Annual interest rate (percentage points, up to 6 decimals).

Min 0 · Max 100 · Step 0.000001
debts[].minimumPaymentOptional
number

Monthly minimum payment (USD, cents).

Min 0 · Max 1000000000 · Step 0.01
Example request body (JSON)
{
  "strategy": "snowball",
  "firstPaymentDate": "2027-01-31",
  "extraPayment": 25,
  "debts": [
    {
      "id": "card-a",
      "balance": 100,
      "annualRate": 0,
      "minimumPayment": 25
    },
    {
      "id": "card-b",
      "balance": 50,
      "annualRate": 0,
      "minimumPayment": 25
    }
  ]
}
Full JSON schema
{
  "type": "object",
  "properties": {
    "strategy": {
      "type": "string",
      "enum": [
        "avalanche",
        "snowball"
      ],
      "description": "Waterfall for the detailed timeline."
    },
    "firstPaymentDate": {
      "type": "string",
      "format": "date",
      "pattern": "^(19|20|21)[0-9]{2}-[0-9]{2}-[0-9]{2}$",
      "maxLength": 10,
      "description": "Date of first scheduled payment (UTC YYYY-MM-DD, 1900–2199)."
    },
    "extraPayment": {
      "type": "number",
      "description": "Extra monthly principal budget (USD, cents).",
      "minimum": 0,
      "maximum": 1000000000,
      "multipleOf": 0.01
    },
    "debts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 40,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
            "description": "Caller-assigned account ID, unique within the request."
          },
          "balance": {
            "type": "number",
            "description": "Outstanding principal (USD, cents).",
            "minimum": 0,
            "maximum": 1000000000,
            "multipleOf": 0.01
          },
          "annualRate": {
            "type": "number",
            "description": "Annual interest rate (percentage points, up to 6 decimals).",
            "minimum": 0,
            "maximum": 100,
            "multipleOf": 0.000001
          },
          "minimumPayment": {
            "type": "number",
            "description": "Monthly minimum payment (USD, cents).",
            "minimum": 0,
            "maximum": 1000000000,
            "multipleOf": 0.01
          }
        },
        "required": [
          "id",
          "balance",
          "annualRate"
        ],
        "additionalProperties": false
      },
      "minItems": 0,
      "maxItems": 20
    }
  },
  "required": [
    "strategy",
    "firstPaymentDate",
    "extraPayment",
    "debts"
  ],
  "additionalProperties": false
}

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