Skip to main content
GET
/
sessions
/
{token}
/
services
/
internet
Get Internet Service Availability
curl --request GET \
  --url https://api-sandbox.letshum.com/sessions/{token}/services/internet \
  --header 'Authorization: Bearer <token>'
{
  "message": "What happened in the most recent request.",
  "request_status": "ok",
  "data": {
    "internet": [
      {
        "provider_id": "0c970c65-7b01-3fc4-91ee-4ecb31f2acb8",
        "provider_name": "Rocket Fiber",
        "offerings": [
          {
            "technology": "Fiber",
            "technology_category": "Terrestrial",
            "max_download_speed": 1000,
            "max_upload_speed": 1000
          }
        ],
        "product_catalog": [
          {
            "category": "internet",
            "category_name": "Internet Service",
            "category_description": "High-speed internet access plans",
            "products": [
              {
                "id": "8083bfe8-a53f-49eb-b0e8-a77d3e9e7577",
                "sku": "130235-INT-CBL-01",
                "name": "Internet Advantage",
                "category": "internet",
                "category_name": "Internet Service",
                "technology": "cable",
                "position": 1,
                "select_type": "radio",
                "description": "Boosted Internet for users looking to stream and share content quickly.",
                "download_speed": "50-100",
                "upload_speed": "10-25",
                "data_limit": "Unlimited",
                "channel_count": 0,
                "streaming_apps": [
                  "Disney+ Basic",
                  "ESPN+"
                ],
                "is_required_to_checkout": true,
                "is_contract_required": false,
                "is_modem_router_included": false,
                "is_bundle_qualifier": null,
                "bundle_discounts": {},
                "is_local_checkout": true,
                "required_with_plans": [],
                "included_with_plans": [],
                "only_available_with_plans": [],
                "initial_term_discount_months": 12,
                "second_term_discount_months": 6,
                "hum_rank": 85,
                "max_quantity": 1,
                "product_promo": {},
                "info": "5-year price lock guarantee",
                "pricing": {
                  "extra_data_fee": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "professional_installation_fee": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "self_installation_fee": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "activation_fee": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "initial_term_discount": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "second_term_discount": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "autopay_discount": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "paperless_billing_discount": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "combined_autopay_paperless_discount": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "net_monthly_price": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  },
                  "gross_monthly_fee": {
                    "amount_cents": 4999,
                    "currency": "USD"
                  }
                }
              }
            ]
          }
        ],
        "telephone": "+18332981433",
        "provider_icon": "<string>",
        "provider_logo": "https://harmony.letshum.com/images/providers/rocketfiber.png",
        "url": "https://provider.example.com/register?utm_source=Hum",
        "security_token": "fUdh4KG2XQDZarZvPZwSR_YRLPp5eFbD7QUTu7l-53HJ0T3nU2fjaesdOp1O2wUAO9",
        "buyflow_type": "direct",
        "button_label": "Get Started",
        "min_plan_price": {
          "amount_cents": 4999,
          "currency": "USD"
        },
        "provider_promo": {
          "promo_text": "$50 off your first month!",
          "promo_logo": "sale-badge",
          "promo_logo_url": "https://cdn.letshum.com/promo_icons/banknotes.svg"
        },
        "url_promo": {
          "promo_text": "Limited time fiber offer!",
          "promo_logo": "fiber-special",
          "promo_logo_url": "https://cdn.letshum.com/promo_icons/fiber-deal.svg"
        }
      }
    ]
  },
  "meta": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD",
    "session_status": "open",
    "responded_at": "2024-09-20T23:13:31.179Z",
    "hum_data_set": "25041808",
    "agent_status": {
      "geocoding": "matched",
      "internet": "matched",
      "checkout": "pending"
    },
    "session_params": {
      "street1": "29090 Tiffany Drive E",
      "state": "MI",
      "zip": 48034,
      "street2": "A2",
      "city": "Southfield",
      "latitude": 42.501721339274,
      "longitude": -83.286263465881,
      "campaign_id": "1iYyMxsnTy87tFOvukTi7V"
    },
    "service_address": "1420 Washington Blvd, Detroit, MI 48201",
    "created_at": "2024-09-20T23:13:31.179Z",
    "updated_at": "2024-09-20T23:13:31.179Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using JWT tokens. Include the token in the Authorization header as: Authorization: Bearer <token>

Obtain tokens through your Hum API account dashboard or contact [email protected] for access.

Path Parameters

​
token
string
required

The session token identifying the specific session The session token provided by the Hum API. Used to connect the response to the session in the client system.

Example:

"XqCmeTVgYXrbWrZFZEymkD"

Response

Internet service providers, available plans, and logos/urls for a given service address.

​
message
string
required

A message returned by the API. Includes a human-readable message about the status of the request.

Example:

"What happened in the most recent request."

​
request_status
enum<string>
required

A status code summarizing the outcome of this response.

  • ok: Request was successful
  • warning: Request was processed but with some issues
  • error: Request failed
Available options:
ok,
warning,
error
Example:

"ok"

​
data
object
required
​
meta
object
required

Metadata about the session. Can be used to track the status of the session, time since creation, and time since last update.