Get a unit's lease-term price matrix
Term-by-term pricing for one unit, ordered by lease start date. **Two behaviors to design around.** 1. *Live PMS fallback.* When Resi holds no stored matrix for the unit, it queries the property's PMS connection in real time and normalizes the result. That is materially slower than a database read and depends on the PMS being reachable. Set a generous client timeout; never call this in a loop across a portfolio. 2. *An empty array is a legitimate answer.* No PMS connection, no matrix from the provider, or a unit without term pricing all return `[]`. Fall back to the unit's rent range rather than showing nothing. Call it lazily on unit detail and cache per unit per day.
/api/v1/property/{property}/unit/{unit}/price-matrixTerm-by-term pricing for one unit, ordered by lease start date.
Two behaviors to design around.
- Live PMS fallback. When Resi holds no stored matrix for the unit, it queries the property's PMS connection in real time and normalizes the result. That is materially slower than a database read and depends on the PMS being reachable. Set a generous client timeout; never call this in a loop across a portfolio.
- An empty array is a legitimate answer. No PMS connection, no matrix from the provider, or a unit without term pricing all return
[]. Fall back to the unit's rent range rather than showing nothing.
Call it lazily on unit detail and cache per unit per day.
Path Parameters
Property UUID. This route is unauthenticated and unscoped, so it does not accept a slug — to address a property by slug, use /api/v1/connection/{connection}/property/{property}.
uuidUnit UUID. This route does not accept a slug. The unit must belong to the route property, or be served through a merged connection that property parents — anything else is a 404.
uuidQuery Parameters
Return only the row for this lease start date (YYYY-MM-DD). Omit for all dates.
dateResponse Body
application/json
application/json
curl -X GET "https://example.com/api/v1/property/019dbc38-d49e-7310-95d4-711a5b7a4b40/unit/019dbc39-1a4c-7002-bb31-2f9e5a77c108/price-matrix"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "unit_id": "5becc822-b69e-4e66-a762-ad8e868dcab6", "start_date": "2019-08-24", "best_rent": { "term_key": "rent_12", "months": 1, "label": "12 months", "rent": 0 }, "next_best_rent": { "term_key": "rent_12", "months": 1, "label": "12 months", "rent": 0 }, "rents": [ { "term_key": "rent_12", "months": 1, "label": "12 months", "rent": 0 } ] } ]}