Skip to main content

Documentation Index

Fetch the complete documentation index at: https://documentation.byteful.com/llms.txt

Use this file to discover all available pages before exploring further.

The Product object represents a proxy product or service available for purchase in the Byteful system. It contains essential information about the product including its type, characteristics, pricing options, and availability.

​
Key Attributes

AttributeTypeDescription
product_idstringUnique identifier for the product
product_namestringName of the product as displayed to customers
product_typestringType of product (datacenter, isp, residential, mobile, credit)
product_protocolstringIP protocol supported by the product (ipv4, ipv6, dual)
product_is_activebooleanIndicates if the product is currently active
product_is_availablebooleanIndicates if the product is available for purchase
product_is_visiblebooleanIndicates if the product is visible in product listings
product_is_per_ipbooleanIndicates if the product is sold on a per-IP basis
product_stockintegerNumber of units available for purchase
country_idstringCountry code where the product is located (for region-specific products)
product_pricesarrayList of pricing options with different billing cycles

​
Product Prices

Each product contains an array of price objects with the following structure:
AttributeTypeDescription
price_idstringUnique identifier for the price
price_typestringType of price (recurring, one_time)
price_amountintegerCost in cents
price_is_subscriptionbooleanWhether the price represents a subscription
price_cycle_intervalstringBilling interval (month, year)
price_cycle_interval_countintegerNumber of intervals for billing cycle
price_tier_typestringType of pricing tier (volume, graduated)
price_tiersarrayArray of pricing tiers for volume pricing

​
Object Relationships

The Product object is connected to several other objects in the Byteful API:
  • Checkout Catalog: Products are summarized in the checkout catalog for purchase
  • Services: When purchased, a product creates a service
  • Countries: Products may be region-specific and tied to particular countries
EndpointDescription
GET /public/user/product/searchSearch products with various filters
GET /public/user/checkout/catalogGet simplified product listing for checkout

​
Example Response

{
  "data": [
    {
      "product_id": "prod_RCLjwcUyqkfd2f",
      "product_name": "Static Residential ISP Proxies [FR]",
      "product_type": "isp",
      "product_protocol": "ipv4",
      "product_is_active": true,
      "product_is_available": false,
      "product_is_visible": true,
      "product_is_per_ip": true,
      "product_stock": 0,
      "country_id": "fr",
      "product_image": "https://files.stripe.com/links/MDB8YWNjdF8xSDdkOEFCMkJVbHFpbTVsfGZsX2xpdmVfNU9KWUZCTnp4djA0dmpuV3F0bjM2ck9i00dSLST0rl",
      "product_description": null,
      "product_instock": false,
      "product_prices": [
        {
          "price_id": "price_1QJx2EB2BUlqim5ltggZJfyY",
          "price_type": "recurring",
          "price_is_subscription": true,
          "price_cycle_interval": "month",
          "price_cycle_interval_count": 1,
          "price_tier_type": "volume",
          "price_tiers": [
            {
              "price_tier_up_to": 1,
              "price_tier_amount": 350
            }
          ]
        }
      ]
    }
  ]
}

​
Usage Notes

  • The product_stock indicates real-time availability for purchase
  • A value of 0 for product_stock means the product is out of stock
  • A value of -1 for product_stock means the product has infinite stock (typically for residential products)
  • The product_protocol indicates which IP versions are supported (IPv4, IPv6, or both)
  • The product_prices array shows all available pricing options and billing cycles
  • For residential and mobile products, pricing is data-based rather than per-IP
  • The product_is_per_ip flag distinguishes between per-IP pricing (datacenter/ISP) and data-based pricing (residential/mobile)
  • Products with country_id are region-specific, while those without may be global
  • The price_amount and price_tier_amount are in cents (e.g., 350 means $3.50)

​
Product Types

TypeDescription
datacenterCommercial datacenter proxies with high speed
ispStatic residential ISP proxies with carrier legitimacy
residentialDynamic residential proxies from real consumer connections
mobileDynamic mobile proxies from real mobile devices
creditAccount credit that can be applied to purchases