Get full details for one deal
get_deal_detailsUse when the user asks for more detail about ONE specific deal already returned by another tool: setup costs, price-rise terms, what happens after the intro period and availability at their address. Pass the deal_id from the earlier result, plus the user's postcode, uprn and address_label when known so availability is confirmed at their address. total_contract_cost here is the whole-contract figure over contract_months.
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. | |
| deal_id | Yes | The deal_id from a previous find_broadband_deals or check_if_overpaying result. | |
| postcode | No | Pass the user's postcode when known so availability is checked at their address. | |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| gift | No | Provider incentive shown on the deal card: a gift card / reward, or a switching credit. NOT included in any cost figure. A switching credit (e.g. 'up to £300') only offsets early-termination fees the user owes their CURRENT provider — worth £0 to someone out of contract, so explain it as conditional, never as a discount. Gift cards are real value but not bill money. | |
| deal_id | Yes | ||
| provider | Yes | ||
| setup_fee | Yes | ||
| checked_at | Yes | ||
| switch_time | No | ||
| upload_mbps | Yes | ||
| availability | Yes | ||
| continue_url | Yes | ||
| intro_months | No | ||
| package_name | Yes | ||
| download_mbps | Yes | ||
| monthly_price | Yes | ||
| connection_type | No | ||
| contract_months | Yes | ||
| price_rise_terms | No | ||
| mid_contract_rise | Yes | ||
| price_after_intro | No | ||
| switching_downtime | No | ||
| total_contract_cost | Yes | ||
| effective_monthly_cost | Yes | ||
| estimated_speed_at_address_mbps | No |