Search Australian telco plans
search_plansRead-onlyIdempotent
Search current Australian mobile, prepaid, mobile broadband and nbn home internet plans from providers listed on Wireless Choices. Filter by price, included data, network, speed tier, contract and features. Results are ordered by lowest ongoing price among matching plans and each one carries the date it was last updated on Wireless Choices. Returns up to 10 plans, each with a link to its detail page; use offset for the next plans among the first 50 matches. Use list_providers first if you are unsure which providers exist.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | price = lowest ongoing price first (default); data = most data first; value = lowest price per GB first | |
| limit | No | Plans to return, up to 10 (default 10) | |
| offset | No | Skip this many matches, to see the next plans in the same order. Pass next_offset from the previous result. Only the first 50 matches can be paged | |
| network | No | Mobile network the provider sells access to. Mobile, prepaid and mobile broadband only; not valid with internet. Use only when the user asks for plans on a network; a named provider goes in provider_slug | |
| features | No | All listed features must be included. Mobile, prepaid and mobile broadband only; not valid with internet | |
| plan_type | Yes | Which catalogue to search | |
| speed_tier | No | nbn speed tier in Mbps, internet only | |
| technology | No | Internet only | |
| expiry_days | No | Recharge length in days. Prepaid and mobile broadband only. 28 and 30 are different lengths and match exactly; 180 covers recharges of 180 to 186 days and 365 covers 360 to 365 days | |
| min_data_gb | No | Minimum included data in GB; ignored for unlimited plans | |
| max_price_aud | No | Ongoing price ceiling in AUD per billing period | |
| provider_slug | No | Restrict to one provider. Use when the user names a provider, e.g. telstra, optus, boost-mobile; slugs are listed by list_providers | |
| unlimited_data | No | Only plans with unlimited data | |
| contract_months | No | Contract term in months. 0 = month-to-month, with no fixed-term contract. Leave out unless the user asks about contract length |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | ||
| error | No | Error code, present only on an error result | |
| plans | No | ||
| offset | No | Position of the first returned plan among the matches, from 0 | |
| message | No | User-facing error message, present only on an error result | |
| cta_label | No | ||
| plan_type | No | ||
| disclosure | No | ||
| next_steps | No | ||
| next_offset | No | Offset for the next plans; null when there are no more, or the 50-match paging limit is reached | |
| result_count | No | Plans returned, at most 10 | |
| contract_note | No | Present only when the search filtered on contract length: how many listed plans of this type have no fixed-term contract | |
| coverage_note | No | ||
| ranking_method | No | The ordering applied to the results, in words | |
| total_matching | No | Plans that matched the filters | |
| filters_applied | No | The filters that were applied, echoed from the request | |
| catalogue_updated | No | Date the catalogue copy was generated, ISO date |