Sign inGet Started
Começar
Guias
Referência de API
SDKs
CLI
Base de conhecimento
Changelog

List offers an eSIM can take

GET
/v1/esim/sims/{esim_id}/compatible-offers
bird esim compatible-offers <esim-id>
Resposta200
{
  "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.

Payload de resposta

data
array of object
obrigatório

Orderable top-up offers for this eSIM.

Mostrar atributos secundários
data.id
string
obrigatório
data.name
string
obrigatório

Display name of the offer.

data.revision
integer
obrigatório

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

data.zone_id
string
obrigatório

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

data.speed
string
obrigatório

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

data.stackable
boolean
obrigatório

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
obrigatório

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 secundários
data.pricing
object
obrigatório

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 secundários
data.pricing.type
string
obrigatório

Pricing type.

Value: bundle

data.pricing.data
object
obrigatório
Mostrar atributos secundários
data.pricing.data.amount_bytes
integer
obrigatório

Total data allowance in bytes.

data.pricing.data.throttled_after_bytes
nullable integer

Data amount in bytes after which speed is reduced instead of cut off. Null when the allowance is a hard cap.

data.pricing.validity
object
obrigatório

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 secundários
data.pricing.price
object
obrigatório

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

Mostrar atributos secundários
data.product
string
obrigatório

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

data.status
string
obrigatório
data.created_at
string
obrigatório
as_of
string
obrigatório

When this answer was computed.

Recursos relacionados

Continue com a documentação, guias e exemplos sobre este tópico.

Obtenha um resumo de implementação