Find plans on coverage and price
find_plansThe plan finder. Ranks every eligible VHIS plan on what it covers and what it really costs, and returns three explained picks (lowest cost over the period, best coverage for the money, most comprehensive) with a ranked list behind them. Coverage is read from each plan's Benefit Schedule; cost is the published premium for every year from this age, and the same again with the insurer's own filed rate changes applied. Age is the only thing it needs; pass whatever else the person has actually said.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| age | Yes | Age last birthday, as the premium schedules state it | |
| room | No | Minimum hospital room class wanted: Ward | Semi-private | Private | |
| limit | No | ||
| needs | No | Must-haves they named, any of: full_cover, no_annual_limit, mental_health, cancer, outpatient_general, dental, maternity, chinese_medicine, health_check, emergency_assistance, cash_benefit, second_opinion, home_nursing, deductible_waiver | |
| years | No | Period the cost is totalled over | |
| gender | No | M or F, as the schedules rate it | F |
| smoker | No | True only if the person said they smoke; a few plans rate for it | |
| currency | No | HKD | |
| insurers | No | Restrict to these brands, e.g. ["Bupa","AXA"] | |
| priority | No | What matters most to them | balanced |
| territory | No | Where cover is needed: hong_kong | greater_china | asia | worldwide_ex_us | worldwide | |
| budget_annual | No | Most they want to pay in the first year, in the plan currency | |
| max_deductible | No | 0 for no deductible; leave empty to allow deductible plans, which cost less |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||