Catalog/get_hosting_plan
Tool · Catalog

get_hosting_plan

Get one orderable product (hosting plan, add-on service, server) by its product id (pid): pricing, allowed_cycles, config_options, custom_fields, addons, free_domain and stock. allowed_cycles and config_options[].options[].id are the values create_checkout accepts. A product with server_fields_required: true needs hostname, ns1prefix and ns2prefix on its checkout item; do NOT give it a rootpw (one is generated and delivered by the welcome email). Catalog prices are in the brand's default currency (USD); a checkout reports the customer's own currency. Call list_hosting_plans first to find the pid. Data may be up to 60 seconds stale. Requires the read:product_catalog scope.

Read-onlyIdempotentOpen‑worldscope read:product_catalog

Invoked over the MCP transport with a tools/call request naming this tool.

Authorization #

Requires a valid OAuth 2.1 bearer access_token whose grant includes the read:product_catalog scope — View JetHost's hosting plans with USD pricing. The broker resolves the caller from the token and returns only records the account owns.

Parameters #

pidintegerRequired
The WHMCS product id (pid) of the hosting plan to retrieve. Obtain this from list_hosting_plans. Must be a positive integer.

Response #

200 · application/json

planobject
pidinteger
gidinteger
namestring
taglinestring
short_descriptionstring
descriptionstring
product_urlstring
currencystring
pricingarray<object>
cyclestring
base_pricestring
new_pricestring
discount_pctnumber
partner_pricestring
The recurring price the caller pays; present only when the caller has a partner price-list discount.
partner_discount_pctnumber
The partner discount percentage; present only alongside partner_price.
typestring · null
requires_domainboolean
server_fields_requiredboolean
stockobject · null
paytypestring · null
allowed_cyclesarray<string>
free_domainobject · null
config_optionsarray<object>
idinteger
namestring
typestring
requiredboolean
min_qtyinteger · null
max_qtyinteger · null
default_option_idinteger · null
optionsarray<object>
custom_fieldsarray<object>
idinteger
namestring
typestring
requiredboolean
optionsarray<string>
regexstring · null
descriptionstring
addonsarray<object>
idinteger
namestring
billingstring
One of: recurring onetime free
priceobject · array

Errors #

ResultWhen
{ "error": "not_found" }The requested item does not exist, or it belongs to another account. Cross-account IDs are indistinguishable from missing ones by design.