Sign inGet Started
Comenzar
Guías
Referencia de API
SDKs
CLI
Base de conocimientos
Registro de cambios

List offers an eSIM can take

GET
/v1/esim/sims/{esim_id}/compatible-offers
bird esim compatible-offers <esim-id>
Respuesta200
{
  "data": [
    {
      "id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
      "name": "Europe 10 GB / 30 days",
      "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
      "speed": "full",
      "phone": {
        "included": "always",
        "voice_inbound": false,
        "voice_outbound": false,
        "sms_inbound": true,
        "sms_outbound": false
      },
      "pricing": {
        "data": {
          "amount_bytes": 10737418240
        },
        "validity": {
          "type": "one_time",
          "unit": "day",
          "value": 30
        },
        "price": {
          "amount": "0.00995",
          "currency_code": "USD"
        }
      },
      "product": "email_sends",
      "status": "draft"
    }
  ]
}

Returns offers currently compatible with this eSIM’s network, package capacity, and existing packages. Use these offers for top-ups. Availability can change before purchase; refresh the list before ordering. An incompatible top-up returns 409.

Parámetros

esim_idstring

Identifier of the eSIM.

Parámetros de consulta

recurring_onlyboolean

Keep only offers with recurring service configured. Enrollment still checks supplier support and the published recurring price.

Carga de respuesta

data
array of object
obligatorio

Orderable top-up offers for this eSIM.

Mostrar atributos secundarios
data.id
string
obligatorio
data.name
string
obligatorio

Display name of the offer.

data.revision
integer
obligatorio

Increments whenever the offer's terms change. Orders lock the revision they were quoted at.

data.zone_id
string
obligatorio

Coverage zone the offer sells. Offers for the same footprint share one zone.

data.speed
string
obligatorio

Speed class. For reduced-speed offers, the bundle's data.throttled_after_bytes carries the full-speed allowance.

data.stackable
boolean
obligatorio

Whether packages from this offer can be held alongside packages from other zones on the same eSIM, subject to the eSIM's package_limit.

data.phone
nullable object
obligatorio

Phone service that comes with the plan, or null when the plan includes no phone number. When present, included says how the number is provided and the flags state which call and text directions work.

Mostrar atributos secundarios
data.pricing
object
obligatorio

Commercial terms of the offer. Every offer in the current catalog is a bundle: a fixed allowance with a validity period for a fixed price. Match on the pricing type; treat an unrecognized type as an offer your integration cannot order yet.

Mostrar atributos secundarios
data.pricing.type
string
obligatorio

Pricing type.

Value: bundle

data.pricing.data
object
obligatorio
Mostrar atributos secundarios
data.pricing.validity
object
obligatorio

Validity of packages created from this offer. The period starts at activation, which happens on first use in the coverage zone. The effective validity is capped by the eSIM's service period: see the package's expires_at for the real expiry.

Mostrar atributos secundarios
data.pricing.price
object
obligatorio

What your workspace is billed per package provisioned from this offer.

Mostrar atributos secundarios
data.product
string
obligatorio

Billing product the offer's charges post under, as it appears on your invoice line items.

data.status
string
obligatorio
data.created_at
string
obligatorio
as_of
string
obligatorio

When this answer was computed.

Recursos relacionados

Continúa con la documentación, guías y ejemplos de este tema.

Obtener un resumen de implementación