Input schema (JSON)
{
"type": "object",
"required": [
"plan_type"
],
"properties": {
"sort": {
"enum": [
"price",
"data",
"value"
],
"type": "string",
"description": "price = lowest ongoing price first (default); data = most data first; value = lowest price per GB first"
},
"limit": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Plans to return, up to 10 (default 10)"
},
"offset": {
"type": "integer",
"maximum": 40,
"minimum": 0,
"description": "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": {
"enum": [
"telstra",
"optus",
"vodafone",
"any"
],
"type": "string",
"description": "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": {
"type": "array",
"items": {
"enum": [
"5g",
"esim",
"data_rollover",
"international_calls"
],
"type": "string"
},
"maxItems": 4,
"description": "All listed features must be included. Mobile, prepaid and mobile broadband only; not valid with internet"
},
"plan_type": {
"enum": [
"mobile",
"prepaid",
"mobile_broadband",
"internet"
],
"type": "string",
"description": "Which catalogue to search"
},
"speed_tier": {
"enum": [
12,
25,
50,
100,
250,
500,
750,
1000,
2000
],
"type": "integer",
"description": "nbn speed tier in Mbps, internet only"
},
"technology": {
"enum": [
"nbn",
"fixed_wireless",
"home_5g",
"home_4g",
"satellite"
],
"type": "string",
"description": "Internet only"
},
"expiry_days": {
"enum": [
7,
28,
30,
60,
90,
180,
365
],
"type": "integer",
"description": "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": {
"type": "number",
"maximum": 5000,
"minimum": 0,
"description": "Minimum included data in GB; ignored for unlimited plans"
},
"max_price_aud": {
"type": "number",
"maximum": 500,
"minimum": 0,
"description": "Ongoing price ceiling in AUD per billing period"
},
"provider_slug": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{0,199}$",
"maxLength": 200,
"description": "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": {
"type": "boolean",
"description": "Only plans with unlimited data"
},
"contract_months": {
"enum": [
0,
12,
24
],
"type": "integer",
"description": "Contract term in months. 0 = month-to-month, with no fixed-term contract. Leave out unless the user asks about contract length"
}
},
"additionalProperties": false
}