Investment · Calculation
Rent renewal versus turnover scenario
Compares renewal and turnover cash receipts including retention probability, concessions, downtime and growth. Supply your own maximum increase and market rent for a provisional scenario.
This HT Calc screen includes a Pro sample for visitors.
Example result · state: available See output
- Cost per success
- 10 calculation credits
- Production plans
- Standard, Business, Scale, Enterprise
Plan allowances - Free sandbox
- Not available
Integration example
Make a request
Use a production key scoped to investor-rent-renewal.
Keep the key on your server. A successful call uses 10 calculation credits.
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/investor-rent-renewal";
const input = {
"currentRent": 1500,
"marketRent": 1600,
"renewalIncreasePct": 4,
"turnoverCost": 1000,
"vacancyMonths": 1,
"concessionMonths": 0.5,
"renewalConcessionMonths": 0,
"retentionProbabilityPct": 75,
"assumedMaxIncreasePct": 5,
"annualRentGrowthPct": 2,
"horizonYears": 2,
"calculationDate": "2026-01-01"
};
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/investor-rent-renewal' \
--header "Authorization: Bearer $HT_PRODUCTION_KEY" \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $request_id" \
--data-binary @- <<'HT_INPUT'
{
"currentRent": 1500,
"marketRent": 1600,
"renewalIncreasePct": 4,
"turnoverCost": 1000,
"vacancyMonths": 1,
"concessionMonths": 0.5,
"renewalConcessionMonths": 0,
"retentionProbabilityPct": 75,
"assumedMaxIncreasePct": 5,
"annualRentGrowthPct": 2,
"horizonYears": 2,
"calculationDate": "2026-01-01"
}
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
investor-rent-renewal. 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.
state- available
formulaVersion- rent-renewal-expected-value-1.0.0
scope- caller-assumption
How to interpret this result
- Compares renewal and turnover cash receipts including retention probability, concessions, downtime and growth. Supply your own maximum increase and market rent for a provisional scenario.
Full example response (JSON)
{
"status": "available",
"result": {
"state": "available",
"formulaVersion": "rent-renewal-expected-value-1.0.0",
"scope": "caller-assumption",
"value": {
"renewalProbability": "0.75",
"turnoverProbability": "0.25",
"renewalPathValue": "37814.4",
"turnoverPathValue": "35384",
"expectedValue": "37206.8",
"compMode": "manual-override",
"assumedMaximumRent": "1575",
"higherValuePath": "renewal-higher-expected-value"
},
"professionalReviewRequired": true
},
"formulaVersion": "rent-renewal-expected-value-1.0.0",
"units": {
"currentRent": "USD per month",
"marketRent": "USD per month",
"renewalIncreasePct": "percent of current rent",
"assumedMaxIncreasePct": "percent of current rent",
"turnoverCost": "USD once",
"retentionProbabilityPct": "percent",
"renewalProbability": "fraction",
"turnoverProbability": "fraction",
"annualRentGrowthPct": "annual percent",
"pathValues": "USD cumulative nominal receipts over the selected horizon"
},
"assumptions": [
"Compares renewal and turnover cash receipts including retention probability, concessions, downtime and growth. Supply your own maximum increase and market rent for a provisional scenario."
],
"warnings": [],
"creditCost": 10
}Request contract
Accepted inputs
Fields for this example. Expand the schema for all supported combinations and limits.
FieldType, units and limits
currentRentRequiredCurrent rent, in USD per month.
Min 0.01 · Max 1000000000marketRentRequiredCaller-assumed new-lease rent, in USD per month.
Min 0.01 · Max 1000000000renewalIncreasePctRequiredProposed change from current monthly rent, in percent.
Min -99 · Max 100turnoverCostRequiredOne-time turnover expense before rent concessions, in USD.
Min 0 · Max 1000000000vacancyMonthsRequiredInitial empty months on the turnover path, in whole months.
Min 0 · Max 36concessionMonthsRequiredFree-rent concession on the new-lease path, in months of the supplied market rent.
Min 0 · Max 36renewalConcessionMonthsOptionalFree-rent concession on the renewal path, in months of the proposed renewal rent. Default zero.
Min 0 · Max 36retentionProbabilityPctRequiredProbability of the renewal path, in percent (75 means a 0.75 probability).
Min 0 · Max 100assumedMaxIncreasePctRequiredCaller’s scenario ceiling on the rent increase, in percent of current rent.
Min 0 · Max 100annualRentGrowthPctRequiredYear-over-year rent growth after year one on both paths, in percent.
Min -100 · Max 100horizonYearsRequiredDuration of both rent streams, in whole years.
Min 1 · Max 20calculationDateRequiredGregorian calendar date, YYYY-MM-DD.
Format: date · Min length 10 · Max length 10Example request body (JSON)
{
"currentRent": 1500,
"marketRent": 1600,
"renewalIncreasePct": 4,
"turnoverCost": 1000,
"vacancyMonths": 1,
"concessionMonths": 0.5,
"renewalConcessionMonths": 0,
"retentionProbabilityPct": 75,
"assumedMaxIncreasePct": 5,
"annualRentGrowthPct": 2,
"horizonYears": 2,
"calculationDate": "2026-01-01"
} Full JSON schema
{
"type": "object",
"properties": {
"currentRent": {
"type": "number",
"minimum": 0.01,
"maximum": 1000000000,
"description": "Current rent, in USD per month."
},
"marketRent": {
"type": "number",
"minimum": 0.01,
"maximum": 1000000000,
"description": "Caller-assumed new-lease rent, in USD per month."
},
"renewalIncreasePct": {
"type": "number",
"minimum": -99,
"maximum": 100,
"description": "Proposed change from current monthly rent, in percent."
},
"turnoverCost": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "One-time turnover expense before rent concessions, in USD."
},
"vacancyMonths": {
"type": "integer",
"minimum": 0,
"maximum": 36,
"description": "Initial empty months on the turnover path, in whole months."
},
"concessionMonths": {
"type": "number",
"minimum": 0,
"maximum": 36,
"description": "Free-rent concession on the new-lease path, in months of the supplied market rent."
},
"renewalConcessionMonths": {
"type": "number",
"minimum": 0,
"maximum": 36,
"description": "Free-rent concession on the renewal path, in months of the proposed renewal rent. Default zero."
},
"retentionProbabilityPct": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Probability of the renewal path, in percent (75 means a 0.75 probability)."
},
"assumedMaxIncreasePct": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Caller’s scenario ceiling on the rent increase, in percent of current rent."
},
"annualRentGrowthPct": {
"type": "number",
"minimum": -100,
"maximum": 100,
"description": "Year-over-year rent growth after year one on both paths, in percent."
},
"horizonYears": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"description": "Duration of both rent streams, in whole years."
},
"calculationDate": {
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10,
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Gregorian calendar date, YYYY-MM-DD."
}
},
"required": [
"currentRent",
"marketRent",
"renewalIncreasePct",
"turnoverCost",
"vacancyMonths",
"concessionMonths",
"retentionProbabilityPct",
"assumedMaxIncreasePct",
"annualRentGrowthPct",
"horizonYears",
"calculationDate"
],
"additionalProperties": false,
"description": "Compares renewal and turnover cash receipts including retention probability, concessions, downtime and growth. Supply your own maximum increase and market rent for a provisional scenario."
}Production endpoint: POST https://calc.hasstechapi.com/v2/calc/investor-rent-renewal
Formula: rent-renewal-expected-value-1.0.0