{ "openapi": "3.0.3", "info": { "title": "Monthly Payment API", "version": "2026-10-13", "description": "Build your own \"estimated monthly payment\" widget. One call returns loan payments (Upgrade and Thrive Financial) and SmartPay rent-to-own payments for a structure, using exactly the same rules as the brand's live financing estimator. JSON in, JSON out, no API key.\n\n**Quick start**\n1. On page load: `GET /v1/{brand}/options` — build the two dropdowns (credit score, property ownership) from `questions.*.options`.\n2. With the customer's answers plus the delivery ZIP and total price: `POST /v1/{brand}/estimate` (or the GET form with a query string).\n3. Show what comes back. Rates, eligibility, terms, payments, APRs, Apply links and disclosure text are all pre-computed — never recompute or retype them.\n\n**Always in sync — fails closed.** The API mirrors the brand's live estimator (for Stoltzfus: https://shedlender.com/estimator.html). Rates, limits, eligibility rules, Apply links and disclosures are read live from that page. If the estimator's calculation logic changes, the API switches itself off and returns **HTTP 503 `estimates_unavailable`** until the change is confirmed. Handle it by hiding the payment section or showing a short \"unavailable\" note. `GET /v1/{brand}/health` shows the current state.\n\n**Display rules (please follow)**\n- Always show a loan payment together with its APR and term (`monthlyPaymentDisplay` + `aprDisplay` + `label`). Never a payment by itself.\n- Keep the `*` on APRs and the `†` (`footnote`) on interest-only Thrive terms, and put the matching disclosures on the page.\n- Never show an APR or interest rate for rent-to-own — it is a lease, not a loan.\n- Do not name the lender on the payment choices (`loans.terms`). Show lender names only at the Apply step (`loans.terms[].offers[].lenderName`).\n- Point every Apply button at `applyLink` (it counts the click anonymously, then redirects to the lender) and open it in a new tab when `applyOpensNewTab` is true. Show the matching `applyHint` next to the button.\n- Show every block in `disclosures.forThisWidget`, in order (use `html` to keep bold text and superscripts). They are copied word-for-word from the estimator and update automatically.\n- Show `loans.notice` and any `overMaxText` (per lender in `loans.byLender`, and `rentToOwn.overMaxText`) beside the payments they describe. When `loans.available` is false show `loans.message`; when `rentToOwn.available` is false show `rentToOwn.reasonText`.\n- Never call these products \"unsecured\". Do not call the API for custom-quote structures with no set price.\n\n**Error simulator.** Add `simulate=` (query string or JSON body) to /estimate to get a canned outcome for testing: `unavailable` (503), `invalid` (400), `origin_blocked` (403), `rto_unavailable` (200 with rent-to-own unavailable), `slow` (200 after ~4 s). Simulated responses carry an `X-Simulated` header and the body echoes `simulated`; they are not counted in usage statistics. Never send `simulate` in production.\n\n**Errors.** Every error body is `{\"ok\": false, \"error\": \"\", ...}`: `invalid_input` (400, with customer-ready `fields` messages), `invalid_json` (400), `origin_not_allowed` (403), `brand_not_enabled` (404, with `liveBrands`), `not_found` (404 for an unknown route, with `routes`), `unknown_product` (404 from /apply), `method_not_allowed` (405, e.g. POST /options), `estimates_unavailable` (503), `server_error` (500).\n\n**CORS.** Browser calls are allowed from `https://*.mysheds.com`, `http://localhost:*` and the API's own site. Calls from a server (no `Origin` header) are always allowed. Any other browser origin gets 403 `origin_not_allowed` without CORS headers. Ask Tim Brazil (Lending Manager) to add a domain.\n\n**Forward compatibility.** New fields may be added to any response object; ignore fields you do not use. (The published schemas therefore do not set `additionalProperties: false`; validation against live responses was run with it forced on.)\n\n**Apply links count clicks.** Never request `/v1/{brand}/apply/...` from scripts, tests or monitors — each request is recorded as a customer click.", "contact": { "name": "Tim Brazil, Lending Manager", "url": "https://payment-estimate-api.pages.dev/" } }, "externalDocs": { "description": "Guide and live test page", "url": "https://payment-estimate-api.pages.dev/" }, "servers": [ { "url": "https://payment-estimate-api.pages.dev", "description": "Production" } ], "tags": [ { "name": "Estimates", "description": "Form options and payment estimates — what your widget calls." }, { "name": "Apply", "description": "Click-counting redirects to lender applications. Link to them; never request them from code." }, { "name": "Discovery", "description": "Which brands are live." }, { "name": "Diagnostics", "description": "Health and the mirrored rules." } ], "paths": { "/v1/brands": { "get": { "tags": [ "Discovery" ], "operationId": "listBrands", "summary": "List live brands", "description": "Brands whose estimator is live in this API.", "responses": { "200": { "description": "Live brands.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandsResponse" }, "examples": { "live": { "$ref": "#/components/examples/Brands" } } } }, "headers": { "Cache-Control": { "$ref": "#/components/headers/Cache-Control" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" } } }, "403": { "$ref": "#/components/responses/OriginNotAllowed" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/{brand}/options": { "parameters": [ { "$ref": "#/components/parameters/Brand" } ], "get": { "tags": [ "Estimates" ], "operationId": "getOptions", "summary": "Questions, lender limits and disclosures", "description": "Call once on page load. Build your two dropdowns from `questions.creditScore.options` and `questions.ownProperty.options`, and send the chosen `value` back to /estimate.", "responses": { "200": { "description": "Form options.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionsResponse" }, "examples": { "stoltzfus": { "$ref": "#/components/examples/Options" } } } }, "headers": { "Cache-Control": { "$ref": "#/components/headers/Cache-Control" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" } } }, "403": { "$ref": "#/components/responses/OriginNotAllowed" }, "404": { "$ref": "#/components/responses/BrandNotEnabled" }, "500": { "$ref": "#/components/responses/ServerError" } } } }, "/v1/{brand}/estimate": { "parameters": [ { "$ref": "#/components/parameters/Brand" } ], "get": { "tags": [ "Estimates" ], "operationId": "getEstimate", "summary": "Estimate payments (query string)", "description": "Loan payments (Upgrade, Thrive Financial) and rent-to-own payments (SmartPay) for one structure. Only call once the ZIP has 5 digits, price > 0 and both questions are answered; debounce about 0.4 s and ignore out-of-order responses. Switching terms needs no new call — every term is in the response. Rent-to-own quotes are limited to 120 per visitor every 10 minutes. The GET form is handy for testing in a browser tab; it returns exactly the same body as POST.", "parameters": [ { "$ref": "#/components/parameters/Zip" }, { "$ref": "#/components/parameters/Price" }, { "$ref": "#/components/parameters/CreditScore" }, { "$ref": "#/components/parameters/OwnProperty" }, { "$ref": "#/components/parameters/Simulate" } ], "responses": { "200": { "description": "Payments calculated. With `simulate=rto_unavailable` or `simulate=slow` the body also carries `simulated`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateResponse" }, "examples": { "loansAndRentToOwn": { "$ref": "#/components/examples/EstBase" }, "noLoans": { "$ref": "#/components/examples/Est500" } } } }, "headers": { "Cache-Control": { "$ref": "#/components/headers/Cache-Control" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "X-Simulated": { "$ref": "#/components/headers/X-Simulated" } } }, "400": { "description": "Invalid input (or `simulate=invalid`).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorInvalidInput" }, "examples": { "badZipAndPrice": { "$ref": "#/components/examples/BadInput" }, "zip00000": { "$ref": "#/components/examples/EstZip00000" }, "simulated": { "$ref": "#/components/examples/SimInvalid" } } } }, "headers": { "Cache-Control": { "$ref": "#/components/headers/Cache-Control" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "X-Simulated": { "$ref": "#/components/headers/X-Simulated" } } }, "403": { "$ref": "#/components/responses/OriginNotAllowed" }, "404": { "$ref": "#/components/responses/BrandNotEnabled" }, "500": { "$ref": "#/components/responses/ServerError" }, "503": { "$ref": "#/components/responses/EstimatesUnavailable" } } }, "post": { "tags": [ "Estimates" ], "operationId": "postEstimate", "summary": "Estimate payments (JSON body)", "description": "Loan payments (Upgrade, Thrive Financial) and rent-to-own payments (SmartPay) for one structure. Only call once the ZIP has 5 digits, price > 0 and both questions are answered; debounce about 0.4 s and ignore out-of-order responses. Switching terms needs no new call — every term is in the response. Rent-to-own quotes are limited to 120 per visitor every 10 minutes.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateRequest" }, "examples": { "basic": { "value": { "zip": "19310", "price": 16820, "creditScore": "720", "ownProperty": "own" } }, "simulateRentToOwnDown": { "value": { "zip": "19310", "price": 16820, "creditScore": "720", "ownProperty": "own", "simulate": "rto_unavailable" } } } } } }, "responses": { "200": { "description": "Payments calculated. With `simulate=rto_unavailable` or `simulate=slow` the body also carries `simulated`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateResponse" }, "examples": { "loansAndRentToOwn": { "$ref": "#/components/examples/EstBase" }, "noLoans": { "$ref": "#/components/examples/Est500" } } } }, "headers": { "Cache-Control": { "$ref": "#/components/headers/Cache-Control" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "X-Simulated": { "$ref": "#/components/headers/X-Simulated" } } }, "400": { "description": "Invalid input, or the body is not valid JSON.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorInvalidInput" }, { "$ref": "#/components/schemas/ErrorInvalidJson" } ] }, "examples": { "missingFields": { "$ref": "#/components/examples/PostMissing" }, "invalidJson": { "$ref": "#/components/examples/PostBadjson" }, "simulated": { "$ref": "#/components/examples/PostSimInvalid" } } } }, "headers": { "Cache-Control": { "$ref": "#/components/headers/Cache-Control" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "X-Simulated": { "$ref": "#/components/headers/X-Simulated" } } }, "403": { "$ref": "#/components/responses/OriginNotAllowed" }, "404": { "$ref": "#/components/responses/BrandNotEnabled" }, "500": { "$ref": "#/components/responses/ServerError" }, "503": { "$ref": "#/components/responses/EstimatesUnavailable" } } }, "options": { "tags": [ "Estimates" ], "operationId": "preflightEstimate", "summary": "CORS preflight", "description": "Sent automatically by browsers before a JSON POST. Allowed origins get 204 with CORS headers; others get 403.", "responses": { "204": { "description": "Origin allowed.", "headers": { "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" }, "Access-Control-Allow-Methods": { "schema": { "type": "string", "example": "GET, POST, OPTIONS" } }, "Access-Control-Allow-Headers": { "schema": { "type": "string", "example": "Content-Type" } }, "Access-Control-Max-Age": { "schema": { "type": "integer", "example": 86400 } }, "Vary": { "$ref": "#/components/headers/Vary" } } }, "403": { "description": "Origin not allowed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorOriginNotAllowed" }, "examples": { "evil": { "$ref": "#/components/examples/PreflightEvil" } } } } } } } }, "/v1/{brand}/health": { "parameters": [ { "$ref": "#/components/parameters/Brand" } ], "get": { "tags": [ "Diagnostics" ], "operationId": "getHealth", "summary": "Is the API serving estimates?", "description": "200 with `ok: true` while estimates are served; 503 when the API has switched itself off because the estimator changed.", "responses": { "200": { "description": "Healthy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" }, "examples": { "healthy": { "$ref": "#/components/examples/Health" } } } }, "headers": { "Cache-Control": { "$ref": "#/components/headers/Cache-Control" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" } } }, "403": { "$ref": "#/components/responses/OriginNotAllowed" }, "404": { "$ref": "#/components/responses/BrandNotEnabled" }, "503": { "description": "Switched off (same shape, `ok: false`; not observed live).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } } } } }, "/v1/{brand}/rules": { "parameters": [ { "$ref": "#/components/parameters/Brand" } ], "get": { "tags": [ "Diagnostics" ], "operationId": "getRules", "summary": "Snapshot of the mirrored estimator rules", "description": "For diagnostics: the normalized rules the API read from the estimator. Do not build pricing from this — use /estimate.", "responses": { "200": { "description": "Rules in use.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulesResponse" }, "examples": { "current": { "$ref": "#/components/examples/Rules" } } } }, "headers": { "Cache-Control": { "$ref": "#/components/headers/Cache-Control" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" } } }, "403": { "$ref": "#/components/responses/OriginNotAllowed" }, "404": { "$ref": "#/components/responses/BrandNotEnabled" }, "503": { "description": "Switched off (same shape, `ok: false`; not observed live).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulesResponse" } } } } } } }, "/v1/{brand}/apply/{product}": { "parameters": [ { "$ref": "#/components/parameters/Brand" } ], "get": { "tags": [ "Apply" ], "operationId": "apply", "summary": "Apply redirect (counts a click)", "description": "**Do not call this from code, tests or monitors — every request counts one Apply click in production statistics.** Use it only as the `href` of a real Apply button (take the URL from `applyLink` in the estimate). It counts the click anonymously, then answers 302 with a `Location` header pointing to the lender's application.", "parameters": [ { "name": "product", "in": "path", "required": true, "description": "Which application to open.", "schema": { "type": "string", "enum": [ "upgrade", "thrive", "rto" ] } }, { "name": "term", "in": "query", "required": false, "description": "Term in months the customer chose (added automatically in `loans.terms[].offers[].applyLink`).", "schema": { "type": "integer", "example": 60 } } ], "responses": { "302": { "description": "Redirect to the lender's application.", "headers": { "Location": { "description": "Lender application URL.", "schema": { "type": "string", "format": "uri" } } } }, "404": { "description": "Unknown product, or brand not live.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorUnknownProduct" }, { "$ref": "#/components/schemas/ErrorBrandNotEnabled" } ] }, "examples": { "unknownProduct": { "summary": "Documented shape (not requested live — it would count a click)", "value": { "ok": false, "error": "unknown_product", "products": [ "upgrade", "thrive", "rto" ] } } } } } } } } } }, "components": { "schemas": { "ApplyHint": { "type": "object", "description": "The small print the estimator shows under this lender's Apply button. Show it next to your Apply button.", "required": [ "text", "html" ], "properties": { "text": { "type": "string", "description": "Plain-text small print (footnote markers printed as ¹ etc.).", "example": "Soft credit check to see your offers — checking offers does not affect your credit score.¹" }, "html": { "type": "string", "description": "Same text as HTML. Sanitized server-side: only ``, ``, ``, `` tags and HTML entities, so it is safe to insert as HTML.", "example": "Soft credit check to see your offers — checking offers does not affect your credit score.1" } } }, "RulesFrom": { "type": "object", "description": "Where and when the API read the rules it used for this response.", "required": [ "estimator", "estimatorVersion", "readAt", "source" ], "properties": { "estimator": { "type": "string", "description": "The published estimator page the rules were read from.", "format": "uri", "example": "https://shedlender.com/estimator.html" }, "estimatorVersion": { "type": "string", "description": "Short hash of the estimator version the rules came from. Changes whenever the estimator page changes.", "example": "e29cbbafc3fb90f1" }, "readAt": { "type": "string", "description": "When the rules were read from the estimator (UTC, ISO 8601).", "format": "date-time", "example": "2026-10-13T14:50:13.708Z" }, "source": { "type": "string", "description": "How the rules were obtained for this response, e.g. `live` (just read from the estimator page) or `cache` (a recent read is being reused).", "example": "cache" } } }, "DisclosureParagraph": { "type": "object", "description": "One paragraph of disclosure text.", "required": [ "text", "html" ], "properties": { "text": { "type": "string", "description": "Plain-text paragraph, word-for-word from the estimator page." }, "html": { "type": "string", "description": "Same paragraph as sanitized HTML (only ``, ``, ``, `` and entities). Prefer this to keep the bold text and superscript markers." } } }, "DisclosureCatalogParagraph": { "type": "object", "description": "One paragraph of disclosure text in the full catalog, tagged with the products it relates to.", "required": [ "text", "html", "products" ], "properties": { "text": { "type": "string", "description": "Plain-text paragraph, word-for-word from the estimator page." }, "html": { "type": "string", "description": "Same paragraph as sanitized HTML (only ``, ``, ``, `` and entities)." }, "products": { "type": "array", "items": { "type": "string" }, "description": "Product keys this paragraph is about (e.g. `upgrade`, `thrive`, `rto`, `figure`, `pure`). Empty = applies to everything.", "example": [ "rto" ] } } }, "DisclosureParagraphBlock": { "type": "object", "description": "Free-standing paragraph(s) — render as plain paragraphs.", "required": [ "type", "id", "title", "titleHtml", "paragraphs" ], "properties": { "type": { "type": "string", "description": "Block type.", "enum": [ "paragraph" ] }, "id": { "type": "string", "description": "Anchor id of the block on the estimator page (e.g. `disc-credit`), or null.", "example": "disc-credit", "nullable": true }, "title": { "type": "string", "description": "Optional title (plain text), or null.", "nullable": true }, "titleHtml": { "type": "string", "description": "Optional title as sanitized HTML, or null.", "nullable": true }, "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureParagraph" }, "description": "Paragraphs to show, in order." } } }, "DisclosureHeadingBlock": { "type": "object", "description": "A heading — render as a heading above the blocks that follow.", "required": [ "type", "text" ], "properties": { "type": { "type": "string", "description": "Block type.", "enum": [ "heading" ] }, "text": { "type": "string", "description": "Heading text.", "example": "Important Disclosures" } } }, "DisclosureSectionBlock": { "type": "object", "description": "A titled disclosure section — render the title, then its paragraphs.", "required": [ "type", "id", "title", "titleHtml", "paragraphs" ], "properties": { "type": { "type": "string", "description": "Block type.", "enum": [ "section" ] }, "id": { "type": "string", "description": "Anchor id on the estimator page, e.g. `disc-payments`. Footnotes point here via `disclosureId`.", "example": "disc-payments" }, "title": { "type": "string", "description": "Section title (plain text). May begin with a marker such as `*` or `²`.", "example": "* Payment & APR Estimates" }, "titleHtml": { "type": "string", "description": "Section title as sanitized HTML (HTML-escaped, e.g. `&`; may contain ``/``).", "example": "* Payment & APR Estimates" }, "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureParagraph" }, "description": "Paragraphs to show under the title, in order." } } }, "DisclosureBlock": { "description": "One block of `disclosures.forThisWidget`. Check `type` and render every block, in order.", "oneOf": [ { "$ref": "#/components/schemas/DisclosureParagraphBlock" }, { "$ref": "#/components/schemas/DisclosureHeadingBlock" }, { "$ref": "#/components/schemas/DisclosureSectionBlock" } ], "discriminator": { "propertyName": "type", "mapping": { "paragraph": "#/components/schemas/DisclosureParagraphBlock", "heading": "#/components/schemas/DisclosureHeadingBlock", "section": "#/components/schemas/DisclosureSectionBlock" } } }, "DisclosureCatalogParagraphBlock": { "type": "object", "description": "Free-standing paragraph(s) in the full catalog.", "required": [ "type", "id", "products", "paragraphs" ], "properties": { "type": { "type": "string", "description": "Block type.", "enum": [ "paragraph" ] }, "id": { "type": "string", "description": "Anchor id on the estimator page, or null.", "nullable": true }, "products": { "type": "array", "items": { "type": "string" }, "description": "Product keys this block relates to (empty = all)." }, "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureCatalogParagraph" }, "description": "Paragraphs, in order." } } }, "DisclosureCatalogSectionBlock": { "type": "object", "description": "A titled section in the full catalog.", "required": [ "type", "id", "title", "titleHtml", "products", "paragraphs" ], "properties": { "type": { "type": "string", "description": "Block type.", "enum": [ "section" ] }, "id": { "type": "string", "description": "Anchor id on the estimator page.", "example": "disc-figure-funding" }, "title": { "type": "string", "description": "Section title (plain text)." }, "titleHtml": { "type": "string", "description": "Section title as sanitized HTML." }, "products": { "type": "array", "items": { "type": "string" }, "description": "Product keys this section relates to (empty = all)." }, "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureCatalogParagraph" }, "description": "Paragraphs, in order." } } }, "DisclosureCatalogCompanyBlock": { "type": "object", "description": "Company / legal footer lines from the estimator page.", "required": [ "type", "id", "products", "paragraphs" ], "properties": { "type": { "type": "string", "description": "Block type.", "enum": [ "company" ] }, "id": { "type": "string", "description": "Anchor id on the estimator page, or null.", "nullable": true }, "products": { "type": "array", "items": { "type": "string" }, "description": "Product keys this block relates to (empty = all)." }, "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureCatalogParagraph" }, "description": "Paragraphs, in order." } } }, "DisclosureCatalogBlock": { "description": "One block of `disclosures.all` — the estimator's whole disclosure footer, including products this widget does not offer. For reference; show `forThisWidget` on your page.", "oneOf": [ { "$ref": "#/components/schemas/DisclosureCatalogParagraphBlock" }, { "$ref": "#/components/schemas/DisclosureHeadingBlock" }, { "$ref": "#/components/schemas/DisclosureCatalogSectionBlock" }, { "$ref": "#/components/schemas/DisclosureCatalogCompanyBlock" } ], "discriminator": { "propertyName": "type", "mapping": { "paragraph": "#/components/schemas/DisclosureCatalogParagraphBlock", "heading": "#/components/schemas/DisclosureHeadingBlock", "section": "#/components/schemas/DisclosureCatalogSectionBlock", "company": "#/components/schemas/DisclosureCatalogCompanyBlock" } } }, "Footnote": { "type": "object", "description": "Maps a footnote marker used in payments / Apply hints to the disclosure that explains it.", "required": [ "marker", "display", "disclosureId", "title", "appliesToThisWidget" ], "properties": { "marker": { "type": "string", "description": "Footnote marker as a plain character: `1`, `*`, `2`, `3`, `†` …", "example": "*" }, "display": { "type": "string", "description": "How the marker is printed: `¹`, `*`, `²`, `³`, `†` …", "example": "*" }, "disclosureId": { "type": "string", "description": "Id of the disclosure block that explains this marker.", "example": "disc-payments" }, "title": { "type": "string", "description": "Title of that disclosure block, or null when it has none.", "example": "* Payment & APR Estimates", "nullable": true }, "appliesToThisWidget": { "type": "boolean", "description": "True when the explaining block is part of `forThisWidget` (so it will be on your page)." }, "note": { "type": "string", "description": "Extra explanation. Present only on the `†` (interest-only) marker, which has no block of its own — it is explained inside the `disc-payments` section and in each term's `paymentNote`." } } }, "Disclosures": { "type": "object", "description": "Disclosure text for the page, read live from the estimator.", "required": [ "source", "forThisWidget", "all", "footnotes", "notALender", "representativeExample", "rentToOwnStructures" ], "properties": { "source": { "type": "string", "description": "Where the disclosure text was copied from.", "example": "https://shedlender.com/estimator.html (footer, \"Important Disclosures\") — copied word-for-word, updates automatically" }, "forThisWidget": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureBlock" }, "description": "The disclosures your page must show, in this order. Copied word-for-word from the estimator and updated automatically — never edit or retype them." }, "all": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureCatalogBlock" }, "description": "The estimator's complete disclosure footer (reference only)." }, "footnotes": { "type": "array", "items": { "$ref": "#/components/schemas/Footnote" }, "description": "Every footnote marker and which disclosure explains it." }, "notALender": { "type": "string", "description": "The \"not a lender\" statement on its own, for tight layouts." }, "representativeExample": { "type": "string", "description": "The representative-example sentence on its own." }, "rentToOwnStructures": { "type": "string", "description": "Which structures do not qualify for rent-to-own." } } }, "QuestionOption": { "type": "object", "description": "One dropdown choice.", "required": [ "value", "label" ], "properties": { "value": { "type": "string", "description": "Send this value back to /estimate.", "example": "720" }, "label": { "type": "string", "description": "Show this text in the dropdown.", "example": "720 – 799" } } }, "Question": { "type": "object", "description": "One customer question, ready to render as a `