Skip to main content
GET
Returns monthly ONS V3.0 affordability estimates for a user
Monthly cost of living and housing estimates from the Teal V3.0 ONS Family Spending model (table A6). expenditures is newest month first. Cost of living is age-adjusted from each payroll period’s identity_information.date_of_birth, falling back to the user’s date_of_birth. Housing is region-adjusted from each period’s identity_information.address.post_code, falling back to the user’s first post_codes entry that has an ONS region. Age is calculated as of the last day of each month. Some months are left out of expenditures:
  • Months whose net pay is zero or negative (refunds, reversals). They are skipped rather than returned as 0.00 or negative amounts.
  • Months where neither the payroll period’s postcode nor any of the user’s post_codes has an ONS region (for example GY, JE, IM or an unknown postcode).
404 returns { "errors": [...] } with one string per missing or invalid input:

Authorizations

X-API-KEY
string
header
required

Path Parameters

user_id
string<uuid>
required

ID of the user to estimate expenditure for

Response

Monthly expenditure estimates

expenditures
object[]
required

One row per calendar month that has allocated net pay