Sign inGet Started
Mulai sekarang
Panduan
Referensi API
SDK
CLI
Basis Pengetahuan
Changelog

List offers an eSIM can take

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

Parameter

esim_idstring

Identifier of the eSIM.

Parameter Kueri

recurring_onlyboolean

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

Payload Respons

data
array of object
wajib

Orderable top-up offers for this eSIM.

Tampilkan atribut turunan
data.id
string
wajib
data.name
string
wajib

Display name of the offer.

data.revision
integer
wajib

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

data.zone_id
string
wajib

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

data.speed
string
wajib

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

data.stackable
boolean
wajib

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
wajib

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.

Tampilkan atribut turunan
data.phone.included
string
wajib

How the plan provides a phone number.

  • always: a phone number is included with each eSIM purchased from the offer.
  • on_request: reserved for offers with an optional phone number; currently unavailable.

Possible values: always, on_request

data.phone.voice_inbound
boolean
wajib

The eSIM can receive calls on its phone number.

data.phone.voice_outbound
boolean
wajib

The eSIM can place calls.

data.phone.sms_inbound
boolean
wajib

The eSIM can receive text messages on its phone number.

data.phone.sms_outbound
boolean
wajib

The eSIM can send text messages.

data.pricing
object
wajib

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.

Tampilkan atribut turunan
data.product
string
wajib

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

data.status
string
wajib
data.created_at
string
wajib
as_of
string
wajib

When this answer was computed.

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini.

Dapatkan ringkasan implementasi