Check if the user is overpaying for broadband
check_if_overpayingUse when the user asks whether their CURRENT broadband bill or plan, or a RENEWAL or retention offer their provider quoted, is expensive, competitive or worth switching from. Compares what they pay against comparable deals actually available at their address and returns a computed verdict with true 24-month savings. Present the verdict and figures verbatim rather than deriving your own. Each alternative's cost_24_months is its true cost over the 24-month comparison window; ask get_deal_details for a specific deal's whole-contract total. Set quote_type to 'renewal_offer' when evaluating a renewal quote.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uprn | No | Property identifier from search_addresses. Pass it whenever the user has picked an address so results become address-precise instead of postcode-wide. Never show this number to the user. | |
| postcode | Yes | UK postcode, e.g. 'SS13 1HJ'. When asking, request the postcode and house number or name together in one question rather than two rounds. | |
| quote_type | No | 'renewal_offer' when the user is evaluating a renewal or retention price their provider quoted; 'current_bill' (default) when it is what they pay today. | |
| monthly_bill | Yes | What the user currently pays per month in GBP (or the renewal price quoted to them). | |
| address_label | No | The display_address the user picked from search_addresses, passed back verbatim. Carried into the switch link so the FindBroadband site greets the user with their address instead of asking again. | |
| current_provider | Yes | The user's current broadband provider, as they said it, e.g. 'Sky' or 'Virgin Media'. | |
| current_speed_mbps | Yes | The user's current download speed in Mbps. If they only know their package name, ask or estimate from the provider's naming (e.g. 'M125' is about 132). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| current | Yes | ||
| verdict | Yes | ||
| precision | Yes | ||
| checked_at | Yes | ||
| quote_type | Yes | ||
| runners_up | Yes | ||
| alternatives | Yes | ||
| provider_note | No | ||
| best_alternative | Yes | ||
| speed_floor_used | Yes | ||
| total_deals_at_address | Yes |