Get the customer's broadband package and add-ons
Returns the package name, speeds, minimum guaranteed speed, router model, TV or mobile add-ons and the contract end date. Use it before quoting any speed or price.
Response
200 application/json
Response
Successful Response
Get recent bills and the current balance
Returns the last bills (amount in pence, status paid or overdue, due date), the outstanding balance and whether service is restricted for non payment.
Query Parameters
How many bills to return, newest first
Default:3
>= 1<= 12
Response
application/json
Response
Successful Response
Get the customer's line and router health
Returns line sync speeds against the package, drops and errors in the last 24 hours, whether the router is online, the last reboot time and wifi channel details. Use it to decide whether a problem is the line, the router or wifi.
Response
200 application/json
Response
Successful Response
Check for outages and planned work at the customer's postcode
Returns live incidents and planned work affecting the customer’s postcode, each with status, summary and the estimated fix time. Always call this before saying anything about an outage or a fix time.
Response
200 application/json
Response
Successful Response
List the customer's support tickets
Returns the customer’s tickets, newest first, with reference, category, status and summary. Call this before creating a ticket so you can add a note to an existing open one instead of raising a duplicate.
Query Parameters
Filter by status
Allowed values:openclosedall
Default:all
Response
application/json
Response
Successful Response