v1

latestOpenAPI 3.0.02026-07-24231140.6 KB

Products

Retrieve eSIM product list.

get/products/esims

Query parameters

startinteger

Start index. (Default: 0)

limitinteger

Maximum amount of returned records (Maximum/Default: 50)

include_test_productsboolean

If the list should include test products (Default: false)

countrystring

Example:US,FR

Optional ISO 3166-1 alpha-2 country code. Comma-separated list. Use "XI" to include international products.

categorystring

Example:esim

displays the eSIM products Available categories: esim

Response

Success

Example response

{
  "meta": {
    "limit": 1,
    "_endpoint": "/products"
  },
  "data": [
    {
      "id": "test-gift-card-link",
      "name": "Test Gift Card Link",
      "country_code": "KN",
      "country_name": "St Kitts and Nevis",
      "currency": "USD",
      "created_time": "2021-10-04T17:02:22.768Z",
      "recipient_type": "none",
      "image": "https://res.cloudinary.com/bitrefill/d_operator.png/this_is_a_test",
      "in_stock": true,
      "packages": {
        "id": "test-gift-card-link<&>10",
        "price": 12
      },
      "range": {
        "min": 10,
        "max": 100,
        "step": 10,
        "price_rate": 1.2
      }
    }
  ]
}