Products & pricing

Read one product

One product by its id, or by any id it used to carry, with its lifecycle. A retired product answers 200 with state: "retired" and successorId, never a 404, so a menu built from an old catalog can tell its customer what to buy now. state is active, parked (listed, orders answer 409 product_unavailable until it is back) or retired. family names the umbrella (residential, isp, mobile, ipv4, ipv6) so a storefront groups products without guessing from the name. shape says what buying and delivery look like, and it is what to key an integration on, never a list of ids: gateway_gb and gateway_time are a plan you generate lines from (delivery is lines), addresses and addresses_mobile are dedicated IPs that land in proxies (delivery is addresses). renewal is topup (order again, the units land on the plan you hold), repurchase (a fresh plan for a fresh period) or extend (an extension naming the addresses to keep). howTo spells the exact calls for that shape, from the price to the first use, with the targeting fields its network takes. A product we add on a known shape works in your code the day it lands.

get/api/v1/products/{id}

Request

  • Base URL: https://hproxy.com
  • URL: https://hproxy.com/api/v1/products/{id}
  • Auth: API key in header X-API-Key

Path parameters

idstring required

Response

Success

object required

Changes

No recorded changes to this operation across all 1 revision of this API.