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

Get an eSIM offer

GET
/v1/esim/offers/{offer_id}
bird esim offers get <offer-id>
Resposta200
{
  "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.

Payload de resposta

id
string
obrigatório
name
string
obrigatório

Display name of the offer.

revision
integer
obrigatório

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

zone_id
string
obrigatório

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

zone
object
obrigatório

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

Mostrar atributos secundários
speed
string
obrigatório

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

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.

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

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

status
string
obrigatório
created_at
string
obrigatório

Recursos relacionados

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

Obtenha um resumo de implementação