Hum Internet Availability
Check internet providers, plans, speeds, and known pricing at a specific U.S. street address.
Should I use this
Quality & Safety
A
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
~10,261Tokens (tool definitions)
~28.9 KBTypical response size
Significant attention impact (8.02% of 128k context)
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"internet-availability": {
"url": "https://mcp.letshum.com/mcp"
}
}
}Remote endpoints
https://mcp.letshum.com/mcpstreamable-httpWhat it can do
Tool inventory
Tools (4)
🟢 Read-only🟡 Write🔴 Delete⚪ Unknown
🟢check_availability(address, candidate_id, unit, lookup_id, question_set_id, ...)
Start with {address}; continue only with a returned candidate_id and requested unit, {lookup_id} to poll, or the current question_set_id and answers. FCC findings are area-level evidence. Select only returned executable offer_id values.
Input Schema
{
"type": "object",
"properties": {
"address": {
"anyOf": [
{
"maxLength": 300,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Address"
},
"candidate_id": {
"anyOf": [
{
"maxLength": 2048,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Candidate Id"
},
"unit": {
"anyOf": [
{
"maxLength": 100,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"lookup_id": {
"anyOf": [
{
"maxLength": 256,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lookup Id"
},
"question_set_id": {
"anyOf": [
{
"maxLength": 256,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Question Set Id"
},
"answers": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Answers"
}
},
"title": "check_availabilityArguments",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"schema_version": {
"const": 4,
"title": "Schema Version",
"type": "integer"
},
"status": {
"enum": [
"checking",
"needs_information",
"complete",
"failed",
"error"
],
"title": "Status",
"type": "string"
},
"lookup_id": {
"anyOf": [
{
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lookup Id"
},
"revision": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Revision"
},
"expires_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Expires At"
},
"normalized_address": {
"anyOf": [
{
"$ref": "#/$defs/NormalizedAddress"
},
{
"type": "null"
}
],
"default": null
},
"sources": {
"anyOf": [
{
"$ref": "#/$defs/Sources"
},
{
"type": "null"
}
],
"default": null
},
"providers": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Provider"
},
"maxItems": 500,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Providers"
},
"candidates": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Candidate"
},
"maxItems": 5,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Candidates"
},
"clarification_type": {
"anyOf": [
{
"enum": [
"candidate_selection",
"unit_required"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Clarification Type"
},
"required_field": {
"anyOf": [
{
"const": "unit",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Required Field"
},
"message": {
"anyOf": [
{
"maxLength": 500,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message"
},
"question_set_id": {
"anyOf": [
{
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Question Set Id"
},
"questions": {
"items": {
"$ref": "#/$defs/Question"
},
"maxItems": 100,
"title": "Questions",
"type": "array"
},
"retry_after_seconds": {
"anyOf": [
{
"maximum": 300,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Retry After Seconds"
},
"warnings": {
"items": {
"type": "string"
},
"maxItems": 20,
"title": "Warnings",
"type": "array"
},
"next_action": {
"anyOf": [
{
"maxLength": 1000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Action"
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/ErrorDetail"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"schema_version",
"status"
],
"$defs": {
"Candidate": {
"additionalProperties": false,
"properties": {
"candidate_id": {
"maxLength": 2048,
"minLength": 1,
"title": "Candidate Id",
"type": "string"
},
"display": {
"maxLength": 500,
"minLength": 1,
"title": "Display",
"type": "string"
},
"requires_unit": {
"title": "Requires Unit",
"type": "boolean"
}
},
"required": [
"candidate_id",
"display",
"requires_unit"
],
"title": "Candidate",
"type": "object"
},
"ContractTerms": {
"additionalProperties": false,
"properties": {
"required": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Required"
},
"months": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Months"
}
},
"title": "ContractTerms",
"type": "object"
},
"ErrorDetail": {
"additionalProperties": false,
"properties": {
"code": {
"enum": [
"invalid_request",
"invalid_address",
"invalid_answer",
"not_found",
"expired",
"offer_changed",
"offer_unavailable",
"validation_required",
"confirmation_required",
"idempotency_conflict",
"duplicate_order",
"rate_limited",
"temporarily_unavailable"
],
"title": "Code",
"type": "string"
},
"message": {
"maxLength": 500,
"minLength": 1,
"title": "Message",
"type": "string"
},
"retryable": {
"title": "Retryable",
"type": "boolean"
},
"retry_after_seconds": {
"anyOf": [
{
"maximum": 300,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Retry After Seconds"
},
"field_errors": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Field Errors"
},
"next_action": {
"maxLength": 500,
"minLength": 1,
"title": "Next Action",
"type": "string"
},
"correlation_id": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Correlation Id"
}
},
"required": [
"code",
"message",
"retryable",
"next_action"
],
"title": "ErrorDetail",
"type": "object"
},
"FccMatch": {
"additionalProperties": false,
"properties": {
"granularity": {
"enum": [
"census_block",
"census_tract"
],
"title": "Granularity",
"type": "string"
},
"data_as_of": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Data As Of"
}
},
"required": [
"granularity"
],
"title": "FccMatch",
"type": "object"
},
"FeeFacts": {
"additionalProperties": false,
"properties": {
"self_installation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Installation Cents"
},
"professional_installation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Professional Installation Cents"
},
"activation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Cents"
},
"recurring_equipment_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Recurring Equipment Cents"
},
"currency": {
"pattern": "^[A-Z]{3}$",
"title": "Currency",
"type": "string"
}
},
"required": [
"currency"
],
"title": "FeeFacts",
"type": "object"
},
"InformationalPlan": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 300,
"minLength": 1,
"title": "Name",
"type": "string"
},
"technology": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Technology"
},
"download_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Download Mbps"
},
"upload_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Mbps"
},
"pricing": {
"$ref": "#/$defs/MoneyFacts"
},
"fees": {
"$ref": "#/$defs/FeeFacts"
},
"contract_terms": {
"$ref": "#/$defs/ContractTerms"
},
"data_limit": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Data Limit"
},
"conditions": {
"items": {
"type": "string"
},
"maxItems": 50,
"title": "Conditions",
"type": "array"
}
},
"required": [
"name",
"pricing",
"fees",
"contract_terms"
],
"title": "InformationalPlan",
"type": "object"
},
"MoneyFacts": {
"additionalProperties": false,
"properties": {
"monthly_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Monthly Cents"
},
"regular_monthly_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Regular Monthly Cents"
},
"intro_months": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Intro Months"
},
"currency": {
"pattern": "^[A-Z]{3}$",
"title": "Currency",
"type": "string"
}
},
"required": [
"currency"
],
"title": "MoneyFacts",
"type": "object"
},
"NormalizedAddress": {
"additionalProperties": false,
"properties": {
"display": {
"maxLength": 500,
"minLength": 1,
"title": "Display",
"type": "string"
},
"street_line": {
"maxLength": 300,
"minLength": 1,
"title": "Street Line",
"type": "string"
},
"unit": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"city": {
"maxLength": 100,
"minLength": 1,
"title": "City",
"type": "string"
},
"state": {
"pattern": "^[A-Z]{2}$",
"title": "State",
"type": "string"
},
"postal_code": {
"pattern": "^\\d{5}(?:-\\d{4})?$",
"title": "Postal Code",
"type": "string"
}
},
"required": [
"display",
"street_line",
"city",
"state",
"postal_code"
],
"title": "NormalizedAddress",
"type": "object"
},
"Offer": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 300,
"minLength": 1,
"title": "Name",
"type": "string"
},
"technology": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Technology"
},
"download_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Download Mbps"
},
"upload_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Mbps"
},
"pricing": {
"$ref": "#/$defs/MoneyFacts"
},
"fees": {
"$ref": "#/$defs/FeeFacts"
},
"contract_terms": {
"$ref": "#/$defs/ContractTerms"
},
"data_limit": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Data Limit"
},
"conditions": {
"items": {
"type": "string"
},
"maxItems": 50,
"title": "Conditions",
"type": "array"
},
"offer_id": {
"maxLength": 256,
"minLength": 1,
"title": "Offer Id",
"type": "string"
},
"provider_id": {
"maxLength": 256,
"minLength": 1,
"title": "Provider Id",
"type": "string"
},
"qualification_revision": {
"minimum": 1,
"title": "Qualification Revision",
"type": "integer"
},
"qualified_at": {
"format": "date-time",
"title": "Qualified At",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"orderable_through_hum": {
"const": true,
"title": "Orderable Through Hum",
"type": "boolean"
}
},
"required": [
"name",
"pricing",
"fees",
"contract_terms",
"offer_id",
"provider_id",
"qualification_revision",
"qualified_at",
"expires_at",
"orderable_through_hum"
],
"title": "Offer",
"type": "object"
},
"Provider": {
"additionalProperties": false,
"properties": {
"provider_id": {
"maxLength": 256,
"minLength": 1,
"title": "Provider Id",
"type": "string"
},
"name": {
"maxLength": 300,
"minLength": 1,
"title": "Name",
"type": "string"
},
"provenance": {
"items": {
"enum": [
"fcc",
"live_provider_check"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Provenance",
"type": "array"
},
"fcc_match": {
"anyOf": [
{
"$ref": "#/$defs/FccMatch"
},
{
"type": "null"
}
],
"default": null
},
"qualification_status": {
"enum": [
"not_checked",
"checking",
"needs_information",
"qualified",
"not_qualified",
"failed"
],
"title": "Qualification Status",
"type": "string"
},
"orderable_through_hum": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Orderable Through Hum"
},
"offers": {
"items": {
"$ref": "#/$defs/Offer"
},
"maxItems": 500,
"title": "Offers",
"type": "array"
},
"catalog_plans": {
"items": {
"$ref": "#/$defs/InformationalPlan"
},
"maxItems": 500,
"title": "Catalog Plans",
"type": "array"
}
},
"required": [
"provider_id",
"name",
"provenance",
"qualification_status"
],
"title": "Provider",
"type": "object"
},
"Question": {
"additionalProperties": false,
"properties": {
"question_id": {
"maxLength": 256,
"minLength": 1,
"title": "Question Id",
"type": "string"
},
"prompt": {
"maxLength": 500,
"minLength": 1,
"title": "Prompt",
"type": "string"
},
"type": {
"enum": [
"string",
"boolean",
"single_choice",
"date"
],
"title": "Type",
"type": "string"
},
"choices": {
"anyOf": [
{
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Choices"
},
"required": {
"title": "Required",
"type": "boolean"
},
"sensitivity": {
"enum": [
"none",
"personal",
"sensitive"
],
"title": "Sensitivity",
"type": "string"
}
},
"required": [
"question_id",
"prompt",
"type",
"required",
"sensitivity"
],
"title": "Question",
"type": "object"
},
"SourceState": {
"additionalProperties": false,
"properties": {
"status": {
"enum": [
"checking",
"needs_information",
"complete",
"failed",
"timed_out"
],
"title": "Status",
"type": "string"
},
"checked_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Checked At"
},
"data_as_of": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Data As Of"
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/ErrorDetail"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"status"
],
"title": "SourceState",
"type": "object"
},
"Sources": {
"additionalProperties": false,
"properties": {
"fcc": {
"$ref": "#/$defs/SourceState"
},
"live_provider_check": {
"$ref": "#/$defs/SourceState"
}
},
"required": [
"fcc",
"live_provider_check"
],
"title": "Sources",
"type": "object"
}
},
"additionalProperties": false,
"title": "AvailabilityEnvelope"
}🟡validate_order(lookup_id, offer_id, checkout_id, expected_revision, details)
Start: {"lookup_id":"<returned lookup_id>","offer_id":"<returned offer_id>"}. Poll: {"checkout_id":"<returned checkout_id>"}. Edit: {"checkout_id":"<returned checkout_id>","expected_revision":<current revision>,"details":{<changed fields>}}. Use exactly one shape. Customer, installation, consents and internet_addons belong inside details, never at the root. While checking, wait retry_after_seconds and poll without details. Edits restart validation. On stale expected_revision, retrieve with checkout_id only before editing at the current revision. required_fields defines the contract; field_errors identifies actual missing/invalid fields relative to details. Refreshes the offer and returns an exact review without submitting an order. When preferred installation dates are required, provide both first and second choices using a time_window value allowed by the input schema. Installation type must be self or professional. Record the customer's explicit true or false choices for auto-pay and paperless billing; never enable them silently. Match the customer's equipment preference using returned equipment_options and catalog facts. Customer-owned equipment, included provider equipment and optional paid equipment are different choices. A free provider gateway does not satisfy an own-equipment request. Price or included status alone does not establish ownership. If an offer lacks the requested option, inspect another qualified offer or explain the limitation and ask the customer to choose; never fabricate an option. Send the complete selection in details.internet_addons using returned option_id and quantity values. Omit it to preserve current/default selections; [] declines optional items. Select at most one radio option and retain dependent parents. Ready means technically valid, not necessarily correct for the customer. Compare the entire review with the customer's budget, speed, equipment, billing and installation choices. Resolve mismatches before requesting authorization. Present every returned charge, discount, condition and unknown; do not invent a price adjustment for declined auto-pay or paperless billing. Never repeat the service PIN or full date of birth, even if supplied earlier. Keep capability IDs, terms_hash and validation_token out of customer-facing prose. Obtain explicit authorization for this exact current review before create_order; shopping intent or validation alone is not authorization.
Input Schema
{
"type": "object",
"properties": {
"lookup_id": {
"anyOf": [
{
"maxLength": 256,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lookup Id"
},
"offer_id": {
"anyOf": [
{
"maxLength": 256,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Offer Id"
},
"checkout_id": {
"anyOf": [
{
"maxLength": 256,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Checkout Id"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Expected Revision"
},
"details": {
"anyOf": [
{
"$ref": "#/$defs/OrderDetails"
},
{
"type": "null"
}
],
"default": null
}
},
"$defs": {
"BillingPreferences": {
"additionalProperties": false,
"properties": {
"paperless_billing": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Paperless Billing"
},
"auto_pay": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Auto Pay"
}
},
"title": "BillingPreferences",
"type": "object"
},
"CustomerDetails": {
"additionalProperties": false,
"properties": {
"first_name": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"email": {
"anyOf": [
{
"maxLength": 254,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"phone_number": {
"anyOf": [
{
"maxLength": 40,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Phone Number"
},
"service_pin": {
"anyOf": [
{
"pattern": "^\\d{4}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service Pin"
},
"date_of_birth": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Of Birth"
},
"preferences": {
"anyOf": [
{
"$ref": "#/$defs/BillingPreferences"
},
{
"type": "null"
}
],
"default": null
},
"mailing_address": {
"anyOf": [
{
"$ref": "#/$defs/MailingAddress"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "CustomerDetails",
"type": "object"
},
"EquipmentSelection": {
"additionalProperties": false,
"properties": {
"option_id": {
"maxLength": 256,
"minLength": 1,
"title": "Option Id",
"type": "string"
},
"quantity": {
"minimum": 1,
"title": "Quantity",
"type": "integer"
}
},
"required": [
"option_id",
"quantity"
],
"title": "EquipmentSelection",
"type": "object"
},
"InstallationChoice": {
"additionalProperties": false,
"properties": {
"date": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date"
},
"time_window": {
"anyOf": [
{
"enum": [
"8:00 AM - 12:00 PM (Local Time)",
"12:00 PM - 5:00 PM (Local Time)"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Time Window"
}
},
"title": "InstallationChoice",
"type": "object"
},
"InstallationDetails": {
"additionalProperties": false,
"properties": {
"type": {
"anyOf": [
{
"enum": [
"self",
"professional"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"desired_service_start_date": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Desired Service Start Date"
},
"preferred_dates": {
"anyOf": [
{
"$ref": "#/$defs/PreferredDates"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "InstallationDetails",
"type": "object"
},
"MailingAddress": {
"additionalProperties": false,
"properties": {
"same_as_service": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Same As Service"
},
"line1": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Line1"
},
"line2": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Line2"
},
"city": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "City"
},
"state": {
"anyOf": [
{
"pattern": "^[A-Z]{2}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"postal_code": {
"anyOf": [
{
"pattern": "^\\d{5}(?:-\\d{4})?$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Postal Code"
}
},
"title": "MailingAddress",
"type": "object"
},
"OrderDetails": {
"additionalProperties": false,
"description": "Edit payload nested inside validate_order.details, never root tool arguments.",
"properties": {
"customer": {
"anyOf": [
{
"$ref": "#/$defs/CustomerDetails"
},
{
"type": "null"
}
],
"default": null
},
"installation": {
"anyOf": [
{
"$ref": "#/$defs/InstallationDetails"
},
{
"type": "null"
}
],
"default": null
},
"consents": {
"anyOf": [
{
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Customer consent choices at details.consents, using returned consent names.",
"title": "Consents"
},
"internet_addons": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/EquipmentSelection"
},
"maxItems": 100,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Complete equipment selection at details.internet_addons using returned option IDs and quantities; retain dependent parents. Omit to keep current selections/defaults; send [] to decline optional equipment. A free provider gateway is not owned equipment.",
"title": "Internet Addons"
}
},
"title": "OrderDetails",
"type": "object"
},
"PreferredDates": {
"additionalProperties": false,
"properties": {
"first": {
"anyOf": [
{
"$ref": "#/$defs/InstallationChoice"
},
{
"type": "null"
}
],
"default": null
},
"second": {
"anyOf": [
{
"$ref": "#/$defs/InstallationChoice"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "PreferredDates",
"type": "object"
}
},
"title": "validate_orderArguments",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"schema_version": {
"const": 4,
"title": "Schema Version",
"type": "integer"
},
"checkout_id": {
"anyOf": [
{
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Checkout Id"
},
"revision": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Revision"
},
"status": {
"enum": [
"checking",
"needs_information",
"ready",
"offer_changed",
"unavailable",
"expired",
"failed",
"error"
],
"title": "Status",
"type": "string"
},
"equipment_options": {
"items": {
"$ref": "#/$defs/EquipmentOption"
},
"maxItems": 100,
"title": "Equipment Options",
"type": "array"
},
"required_fields": {
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Required Fields",
"type": "array"
},
"field_errors": {
"additionalProperties": {
"type": "string"
},
"title": "Field Errors",
"type": "object"
},
"review": {
"anyOf": [
{
"$ref": "#/$defs/ReadyOrderReview"
},
{
"$ref": "#/$defs/OfferChangedReview"
},
{
"type": "null"
}
],
"default": null,
"title": "Review"
},
"terms_hash": {
"anyOf": [
{
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Terms Hash"
},
"validation_token": {
"anyOf": [
{
"maxLength": 512,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Validation Token"
},
"expires_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Expires At"
},
"retry_after_seconds": {
"anyOf": [
{
"maximum": 300,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Retry After Seconds"
},
"next_action": {
"anyOf": [
{
"maxLength": 1000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Action"
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/ErrorDetail"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"schema_version",
"status"
],
"$defs": {
"BillingPreferences": {
"additionalProperties": false,
"properties": {
"paperless_billing": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Paperless Billing"
},
"auto_pay": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Auto Pay"
}
},
"title": "BillingPreferences",
"type": "object"
},
"CartReview": {
"additionalProperties": false,
"properties": {
"selected_plan": {
"$ref": "#/$defs/IncludedProduct"
},
"included_products": {
"$ref": "#/$defs/IncludedProducts"
},
"one_time_fees": {
"items": {
"$ref": "#/$defs/OneTimeFee"
},
"maxItems": 100,
"title": "One Time Fees",
"type": "array"
},
"total_amount": {
"$ref": "#/$defs/OrderAmount"
},
"bundle_discount": {
"anyOf": [
{
"$ref": "#/$defs/OrderAmount"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"selected_plan",
"included_products",
"one_time_fees",
"total_amount"
],
"title": "CartReview",
"type": "object"
},
"ContractTerms": {
"additionalProperties": false,
"properties": {
"required": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Required"
},
"months": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Months"
}
},
"title": "ContractTerms",
"type": "object"
},
"EquipmentOption": {
"additionalProperties": false,
"properties": {
"option_id": {
"maxLength": 256,
"minLength": 1,
"title": "Option Id",
"type": "string"
},
"name": {
"maxLength": 300,
"minLength": 1,
"title": "Name",
"type": "string"
},
"selection_type": {
"enum": [
"radio",
"checkbox"
],
"title": "Selection Type",
"type": "string"
},
"included": {
"title": "Included",
"type": "boolean"
},
"unit_pricing": {
"$ref": "#/$defs/OrderAmount"
},
"max_quantity": {
"minimum": 1,
"title": "Max Quantity",
"type": "integer"
},
"selected_quantity": {
"minimum": 0,
"title": "Selected Quantity",
"type": "integer"
}
},
"required": [
"option_id",
"name",
"selection_type",
"included",
"unit_pricing",
"max_quantity",
"selected_quantity"
],
"title": "EquipmentOption",
"type": "object"
},
"ErrorDetail": {
"additionalProperties": false,
"properties": {
"code": {
"enum": [
"invalid_request",
"invalid_address",
"invalid_answer",
"not_found",
"expired",
"offer_changed",
"offer_unavailable",
"validation_required",
"confirmation_required",
"idempotency_conflict",
"duplicate_order",
"rate_limited",
"temporarily_unavailable"
],
"title": "Code",
"type": "string"
},
"message": {
"maxLength": 500,
"minLength": 1,
"title": "Message",
"type": "string"
},
"retryable": {
"title": "Retryable",
"type": "boolean"
},
"retry_after_seconds": {
"anyOf": [
{
"maximum": 300,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Retry After Seconds"
},
"field_errors": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Field Errors"
},
"next_action": {
"maxLength": 500,
"minLength": 1,
"title": "Next Action",
"type": "string"
},
"correlation_id": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Correlation Id"
}
},
"required": [
"code",
"message",
"retryable",
"next_action"
],
"title": "ErrorDetail",
"type": "object"
},
"FeeFacts": {
"additionalProperties": false,
"properties": {
"self_installation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Installation Cents"
},
"professional_installation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Professional Installation Cents"
},
"activation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Cents"
},
"recurring_equipment_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Recurring Equipment Cents"
},
"currency": {
"pattern": "^[A-Z]{3}$",
"title": "Currency",
"type": "string"
}
},
"required": [
"currency"
],
"title": "FeeFacts",
"type": "object"
},
"IncludedProduct": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 300,
"minLength": 1,
"title": "Name",
"type": "string"
},
"quantity": {
"minimum": 1,
"title": "Quantity",
"type": "integer"
},
"unit_pricing": {
"$ref": "#/$defs/OrderAmount"
},
"total_pricing": {
"$ref": "#/$defs/OrderAmount"
}
},
"required": [
"name",
"quantity",
"unit_pricing",
"total_pricing"
],
"title": "IncludedProduct",
"type": "object"
},
"IncludedProducts": {
"additionalProperties": false,
"properties": {
"internet": {
"items": {
"$ref": "#/$defs/IncludedProduct"
},
"maxItems": 100,
"title": "Internet",
"type": "array"
},
"television": {
"items": {
"$ref": "#/$defs/IncludedProduct"
},
"maxItems": 100,
"title": "Television",
"type": "array"
},
"television_add_ons": {
"items": {
"$ref": "#/$defs/IncludedProduct"
},
"maxItems": 100,
"title": "Television Add Ons",
"type": "array"
}
},
"title": "IncludedProducts",
"type": "object"
},
"InstallationChoice": {
"additionalProperties": false,
"properties": {
"date": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date"
},
"time_window": {
"anyOf": [
{
"enum": [
"8:00 AM - 12:00 PM (Local Time)",
"12:00 PM - 5:00 PM (Local Time)"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Time Window"
}
},
"title": "InstallationChoice",
"type": "object"
},
"InstallationDetails": {
"additionalProperties": false,
"properties": {
"type": {
"anyOf": [
{
"enum": [
"self",
"professional"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"desired_service_start_date": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Desired Service Start Date"
},
"preferred_dates": {
"anyOf": [
{
"$ref": "#/$defs/PreferredDates"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "InstallationDetails",
"type": "object"
},
"MoneyFacts": {
"additionalProperties": false,
"properties": {
"monthly_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Monthly Cents"
},
"regular_monthly_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Regular Monthly Cents"
},
"intro_months": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Intro Months"
},
"currency": {
"pattern": "^[A-Z]{3}$",
"title": "Currency",
"type": "string"
}
},
"required": [
"currency"
],
"title": "MoneyFacts",
"type": "object"
},
"OfferChangedReview": {
"additionalProperties": false,
"properties": {
"previous_offer": {
"$ref": "#/$defs/PlanFacts"
},
"current_offer": {
"$ref": "#/$defs/PlanFacts"
},
"changed_fields": {
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"title": "Changed Fields",
"type": "array"
},
"previous_cart": {
"anyOf": [
{
"$ref": "#/$defs/CartReview"
},
{
"type": "null"
}
],
"default": null
},
"current_cart": {
"anyOf": [
{
"$ref": "#/$defs/CartReview"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"previous_offer",
"current_offer",
"changed_fields"
],
"title": "OfferChangedReview",
"type": "object"
},
"OneTimeFee": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 300,
"minLength": 1,
"title": "Name",
"type": "string"
},
"description": {
"maxLength": 1000,
"minLength": 1,
"title": "Description",
"type": "string"
},
"pricing": {
"$ref": "#/$defs/OrderAmount"
},
"fee_type": {
"maxLength": 100,
"minLength": 1,
"title": "Fee Type",
"type": "string"
}
},
"required": [
"name",
"description",
"pricing",
"fee_type"
],
"title": "OneTimeFee",
"type": "object"
},
"OrderAmount": {
"additionalProperties": false,
"properties": {
"amount_cents": {
"minimum": 0,
"title": "Amount Cents",
"type": "integer"
},
"amount_currency": {
"pattern": "^[A-Z]{3}$",
"title": "Amount Currency",
"type": "string"
}
},
"required": [
"amount_cents",
"amount_currency"
],
"title": "OrderAmount",
"type": "object"
},
"PlanFacts": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 300,
"minLength": 1,
"title": "Name",
"type": "string"
},
"technology": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Technology"
},
"download_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Download Mbps"
},
"upload_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Mbps"
},
"pricing": {
"$ref": "#/$defs/MoneyFacts"
},
"fees": {
"$ref": "#/$defs/FeeFacts"
},
"contract_terms": {
"$ref": "#/$defs/ContractTerms"
},
"data_limit": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Data Limit"
},
"conditions": {
"items": {
"type": "string"
},
"maxItems": 50,
"title": "Conditions",
"type": "array"
}
},
"required": [
"name",
"pricing",
"fees",
"contract_terms"
],
"title": "PlanFacts",
"type": "object"
},
"PreferredDates": {
"additionalProperties": false,
"properties": {
"first": {
"anyOf": [
{
"$ref": "#/$defs/InstallationChoice"
},
{
"type": "null"
}
],
"default": null
},
"second": {
"anyOf": [
{
"$ref": "#/$defs/InstallationChoice"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "PreferredDates",
"type": "object"
},
"ReadyOrderReview": {
"additionalProperties": false,
"properties": {
"provider_name": {
"maxLength": 300,
"minLength": 1,
"title": "Provider Name",
"type": "string"
},
"selected_offer": {
"$ref": "#/$defs/PlanFacts"
},
"included_products": {
"$ref": "#/$defs/IncludedProducts"
},
"one_time_fees": {
"items": {
"$ref": "#/$defs/OneTimeFee"
},
"maxItems": 100,
"title": "One Time Fees",
"type": "array"
},
"total_amount": {
"$ref": "#/$defs/OrderAmount"
},
"bundle_discount": {
"anyOf": [
{
"$ref": "#/$defs/OrderAmount"
},
{
"type": "null"
}
],
"default": null
},
"service_address": {
"$ref": "#/$defs/ReviewAddress"
},
"installation": {
"anyOf": [
{
"$ref": "#/$defs/InstallationDetails"
},
{
"type": "null"
}
],
"default": null
},
"billing_preferences": {
"anyOf": [
{
"$ref": "#/$defs/BillingPreferences"
},
{
"type": "null"
}
],
"default": null
},
"consents": {
"additionalProperties": {
"type": "boolean"
},
"title": "Consents",
"type": "object"
},
"unknown_charges_remain_unknown": {
"const": true,
"title": "Unknown Charges Remain Unknown",
"type": "boolean"
}
},
"required": [
"provider_name",
"selected_offer",
"included_products",
"one_time_fees",
"total_amount",
"service_address",
"unknown_charges_remain_unknown"
],
"title": "ReadyOrderReview",
"type": "object"
},
"ReviewAddress": {
"additionalProperties": false,
"properties": {
"display": {
"maxLength": 500,
"minLength": 1,
"title": "Display",
"type": "string"
},
"unit": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
}
},
"required": [
"display"
],
"title": "ReviewAddress",
"type": "object"
}
},
"additionalProperties": false,
"title": "ValidationEnvelope"
}🔴create_order(checkout_id, validation_token, idempotency_key, confirmation)
Only after presenting the current review and obtaining authorization for its terms_hash, commit with its validation_token and one stable idempotency_key. After a lost or uncertain response, call get_order first; do not blindly resubmit.
Input Schema
{
"type": "object",
"properties": {
"checkout_id": {
"maxLength": 256,
"minLength": 1,
"title": "Checkout Id",
"type": "string"
},
"validation_token": {
"maxLength": 256,
"minLength": 1,
"title": "Validation Token",
"type": "string"
},
"idempotency_key": {
"maxLength": 128,
"minLength": 1,
"title": "Idempotency Key",
"type": "string"
},
"confirmation": {
"$ref": "#/$defs/Confirmation"
}
},
"required": [
"checkout_id",
"validation_token",
"idempotency_key",
"confirmation"
],
"$defs": {
"Confirmation": {
"additionalProperties": false,
"properties": {
"terms_hash": {
"maxLength": 256,
"minLength": 1,
"title": "Terms Hash",
"type": "string"
},
"confirmed": {
"const": true,
"title": "Confirmed",
"type": "boolean"
}
},
"required": [
"terms_hash",
"confirmed"
],
"title": "Confirmation",
"type": "object"
}
},
"title": "create_orderArguments",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"schema_version": {
"const": 4,
"title": "Schema Version",
"type": "integer"
},
"order_id": {
"anyOf": [
{
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Order Id"
},
"status": {
"enum": [
"queued",
"submitting",
"accepted_by_fulfillment",
"rejected_by_fulfillment",
"submission_unknown",
"not_submitted",
"error"
],
"title": "Status",
"type": "string"
},
"submitted_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Submitted At"
},
"last_checked_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Checked At"
},
"provider_name": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Provider Name"
},
"selected_offer_summary": {
"anyOf": [
{
"$ref": "#/$defs/PlanFacts"
},
{
"type": "null"
}
],
"default": null
},
"evidence": {
"anyOf": [
{
"$ref": "#/$defs/Evidence"
},
{
"type": "null"
}
],
"default": null
},
"next_action": {
"anyOf": [
{
"maxLength": 1000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Action"
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/ErrorDetail"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"schema_version",
"status"
],
"$defs": {
"ContractTerms": {
"additionalProperties": false,
"properties": {
"required": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Required"
},
"months": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Months"
}
},
"title": "ContractTerms",
"type": "object"
},
"ErrorDetail": {
"additionalProperties": false,
"properties": {
"code": {
"enum": [
"invalid_request",
"invalid_address",
"invalid_answer",
"not_found",
"expired",
"offer_changed",
"offer_unavailable",
"validation_required",
"confirmation_required",
"idempotency_conflict",
"duplicate_order",
"rate_limited",
"temporarily_unavailable"
],
"title": "Code",
"type": "string"
},
"message": {
"maxLength": 500,
"minLength": 1,
"title": "Message",
"type": "string"
},
"retryable": {
"title": "Retryable",
"type": "boolean"
},
"retry_after_seconds": {
"anyOf": [
{
"maximum": 300,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Retry After Seconds"
},
"field_errors": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Field Errors"
},
"next_action": {
"maxLength": 500,
"minLength": 1,
"title": "Next Action",
"type": "string"
},
"correlation_id": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Correlation Id"
}
},
"required": [
"code",
"message",
"retryable",
"next_action"
],
"title": "ErrorDetail",
"type": "object"
},
"Evidence": {
"additionalProperties": false,
"properties": {
"kind": {
"maxLength": 100,
"minLength": 1,
"title": "Kind",
"type": "string"
},
"recorded_at": {
"format": "date-time",
"title": "Recorded At",
"type": "string"
}
},
"required": [
"kind",
"recorded_at"
],
"title": "Evidence",
"type": "object"
},
"FeeFacts": {
"additionalProperties": false,
"properties": {
"self_installation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Installation Cents"
},
"professional_installation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Professional Installation Cents"
},
"activation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Cents"
},
"recurring_equipment_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Recurring Equipment Cents"
},
"currency": {
"pattern": "^[A-Z]{3}$",
"title": "Currency",
"type": "string"
}
},
"required": [
"currency"
],
"title": "FeeFacts",
"type": "object"
},
"MoneyFacts": {
"additionalProperties": false,
"properties": {
"monthly_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Monthly Cents"
},
"regular_monthly_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Regular Monthly Cents"
},
"intro_months": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Intro Months"
},
"currency": {
"pattern": "^[A-Z]{3}$",
"title": "Currency",
"type": "string"
}
},
"required": [
"currency"
],
"title": "MoneyFacts",
"type": "object"
},
"PlanFacts": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 300,
"minLength": 1,
"title": "Name",
"type": "string"
},
"technology": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Technology"
},
"download_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Download Mbps"
},
"upload_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Mbps"
},
"pricing": {
"$ref": "#/$defs/MoneyFacts"
},
"fees": {
"$ref": "#/$defs/FeeFacts"
},
"contract_terms": {
"$ref": "#/$defs/ContractTerms"
},
"data_limit": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Data Limit"
},
"conditions": {
"items": {
"type": "string"
},
"maxItems": 50,
"title": "Conditions",
"type": "array"
}
},
"required": [
"name",
"pricing",
"fees",
"contract_terms"
],
"title": "PlanFacts",
"type": "object"
}
},
"additionalProperties": false,
"title": "OrderEnvelope"
}🟢get_order(checkout_id)
Retrieve recorded fulfillment evidence with checkout_id, especially after a lost or uncertain create_order response. Public statuses do not prove ISP acceptance or installation confirmation.
Input Schema
{
"type": "object",
"properties": {
"checkout_id": {
"maxLength": 256,
"minLength": 1,
"title": "Checkout Id",
"type": "string"
}
},
"required": [
"checkout_id"
],
"title": "get_orderArguments",
"additionalProperties": false
}Output Schema
{
"type": "object",
"properties": {
"schema_version": {
"const": 4,
"title": "Schema Version",
"type": "integer"
},
"order_id": {
"anyOf": [
{
"maxLength": 256,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Order Id"
},
"status": {
"enum": [
"queued",
"submitting",
"accepted_by_fulfillment",
"rejected_by_fulfillment",
"submission_unknown",
"not_submitted",
"error"
],
"title": "Status",
"type": "string"
},
"submitted_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Submitted At"
},
"last_checked_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Checked At"
},
"provider_name": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Provider Name"
},
"selected_offer_summary": {
"anyOf": [
{
"$ref": "#/$defs/PlanFacts"
},
{
"type": "null"
}
],
"default": null
},
"evidence": {
"anyOf": [
{
"$ref": "#/$defs/Evidence"
},
{
"type": "null"
}
],
"default": null
},
"next_action": {
"anyOf": [
{
"maxLength": 1000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Action"
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/ErrorDetail"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"schema_version",
"status"
],
"$defs": {
"ContractTerms": {
"additionalProperties": false,
"properties": {
"required": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Required"
},
"months": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Months"
}
},
"title": "ContractTerms",
"type": "object"
},
"ErrorDetail": {
"additionalProperties": false,
"properties": {
"code": {
"enum": [
"invalid_request",
"invalid_address",
"invalid_answer",
"not_found",
"expired",
"offer_changed",
"offer_unavailable",
"validation_required",
"confirmation_required",
"idempotency_conflict",
"duplicate_order",
"rate_limited",
"temporarily_unavailable"
],
"title": "Code",
"type": "string"
},
"message": {
"maxLength": 500,
"minLength": 1,
"title": "Message",
"type": "string"
},
"retryable": {
"title": "Retryable",
"type": "boolean"
},
"retry_after_seconds": {
"anyOf": [
{
"maximum": 300,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Retry After Seconds"
},
"field_errors": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Field Errors"
},
"next_action": {
"maxLength": 500,
"minLength": 1,
"title": "Next Action",
"type": "string"
},
"correlation_id": {
"anyOf": [
{
"maxLength": 128,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Correlation Id"
}
},
"required": [
"code",
"message",
"retryable",
"next_action"
],
"title": "ErrorDetail",
"type": "object"
},
"Evidence": {
"additionalProperties": false,
"properties": {
"kind": {
"maxLength": 100,
"minLength": 1,
"title": "Kind",
"type": "string"
},
"recorded_at": {
"format": "date-time",
"title": "Recorded At",
"type": "string"
}
},
"required": [
"kind",
"recorded_at"
],
"title": "Evidence",
"type": "object"
},
"FeeFacts": {
"additionalProperties": false,
"properties": {
"self_installation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Installation Cents"
},
"professional_installation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Professional Installation Cents"
},
"activation_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Cents"
},
"recurring_equipment_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Recurring Equipment Cents"
},
"currency": {
"pattern": "^[A-Z]{3}$",
"title": "Currency",
"type": "string"
}
},
"required": [
"currency"
],
"title": "FeeFacts",
"type": "object"
},
"MoneyFacts": {
"additionalProperties": false,
"properties": {
"monthly_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Monthly Cents"
},
"regular_monthly_cents": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Regular Monthly Cents"
},
"intro_months": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Intro Months"
},
"currency": {
"pattern": "^[A-Z]{3}$",
"title": "Currency",
"type": "string"
}
},
"required": [
"currency"
],
"title": "MoneyFacts",
"type": "object"
},
"PlanFacts": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 300,
"minLength": 1,
"title": "Name",
"type": "string"
},
"technology": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Technology"
},
"download_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Download Mbps"
},
"upload_mbps": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Upload Mbps"
},
"pricing": {
"$ref": "#/$defs/MoneyFacts"
},
"fees": {
"$ref": "#/$defs/FeeFacts"
},
"contract_terms": {
"$ref": "#/$defs/ContractTerms"
},
"data_limit": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Data Limit"
},
"conditions": {
"items": {
"type": "string"
},
"maxItems": 50,
"title": "Conditions",
"type": "array"
}
},
"required": [
"name",
"pricing",
"fees",
"contract_terms"
],
"title": "PlanFacts",
"type": "object"
}
},
"additionalProperties": false,
"title": "OrderEnvelope"
}Community
Evidence
Recent observations
verifiedversion not recorded4 tools
verifiedversion not recorded1 tools