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

Get an eSIM offer

GET
/v1/esim/offers/{offer_id}
bird esim offers get <offer-id>
Respuesta200
{
  "id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Europe 10 GB / 30 days",
  "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
  "zone": {
    "id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
    "name": "Europe",
    "type": "local",
    "countries": [
      "US"
    ]
  },
  "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 one eSIM offer with its pricing and embedded coverage zone.

Parámetros

offer_idstring

Offer ID.

Carga de respuesta

id
string
obligatorio
name
string
obligatorio

Display name of the offer.

revision
integer
obligatorio

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

zone_id
string
obligatorio

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

zone
object
obligatorio

The offer's coverage zone, embedded so one read answers "where does this work". The zone resource is authoritative.

Mostrar atributos secundarios
speed
string
obligatorio

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

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.

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
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
pricing.type
string
obligatorio

Pricing type.

Value: bundle

pricing.data
object
obligatorio
Mostrar atributos secundarios
pricing.data.amount_bytes
integer
obligatorio

Total data allowance in bytes.

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.

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
pricing.price
object
obligatorio

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

Mostrar atributos secundarios
product
string
obligatorio

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

status
string
obligatorio
created_at
string
obligatorio

Recursos relacionados

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

Obtener un resumen de implementación