v1
latestOpenAPI 3.0.12026-07-265331168.0 KBProduct
Search Product
Search Products entries using various filters.
get/public/user/product/search
Query parameters
product_idstring
Unique identifier of the Product
product_type'credit' | 'datacenter' | 'isp' | 'residential' | 'mobile'
Type associated with the Product
product_protocol'ipv4' | 'ipv6' | 'dual'
Protocol associated with the Product
country_idstring
Country ID for the region of the product
product_is_activeboolean
Whether the Product is active
product_is_one_per_customerboolean
Whether the Product is one per customer
product_is_one_active_per_customerboolean
Whether the Product is one active per customer
product_is_per_ipboolean
Whether the Product is one per IP
per_pageinteger
Number of items per page for pagination
pageinteger
Page number for pagination
sort_bystring
Key for sorting or random.
Response
Product search with stock successfully retrieved.
Example response
{
"data": [
{
"country_id": "fr",
"product_description": "null",
"product_id": "prod_RCLjwcUyqkfd2f",
"product_image": "https://files.stripe.com/links/MDB8YWNjdF8xSDdkOEFCMkJVbHFpbTVsfGZsX2xpdmVfNU9KWUZCTnp4djA0dmpuV3F0bjM2ck9i00dSLST0rl",
"product_is_active": true,
"product_is_per_ip": true,
"product_is_visible": true,
"product_name": "Static Residential ISP Proxies [FR]",
"product_prices": [
{
"price_cycle_interval": "month",
"price_cycle_interval_count": 1,
"price_id": "price_1QJx2EB2BUlqim5ltggZJfyY",
"price_is_subscription": true,
"price_tier_type": "volume",
"price_tiers": [
{
"price_tier_amount": 350,
"price_tier_up_to": 1
}
],
"price_type": "recurring"
}
],
"product_type": "isp"
}
],
"item_count": 1,
"message": "Product search with stock successfully completed.",
"page": 1,
"per_page": 100,
"total_count": 1
}