Sign inGet Started
Inizia ora
Guide
Riferimento API
SDK
CLI
Knowledge Base
Changelog

List offers an eSIM can take

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

Parametri

esim_idstring

Identifier of the eSIM.

Parametri di query

recurring_onlyboolean

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

Payload di risposta

data
array of object
obbligatorio

Orderable top-up offers for this eSIM.

Mostra attributi secondari
data.id
string
obbligatorio
data.name
string
obbligatorio

Display name of the offer.

data.revision
integer
obbligatorio

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

data.zone_id
string
obbligatorio

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

data.speed
string
obbligatorio

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

data.stackable
boolean
obbligatorio

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
obbligatorio

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.

Mostra attributi secondari
data.pricing
object
obbligatorio

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.

Mostra attributi secondari
data.pricing.type
string
obbligatorio

Pricing type.

Value: bundle

data.pricing.data
object
obbligatorio
Mostra attributi secondari
data.pricing.validity
object
obbligatorio

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.

Mostra attributi secondari
data.pricing.price
object
obbligatorio

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

Mostra attributi secondari
data.pricing.price.amount
string
obbligatorio

Decimal amount as a string, in major currency units.

data.pricing.price.currency_code
string
obbligatorio

ISO 4217 currency code.

data.product
string
obbligatorio

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

data.status
string
obbligatorio
data.created_at
string
obbligatorio
as_of
string
obbligatorio

When this answer was computed.

Risorse correlate

Continua con la documentazione, le guide e gli esempi per questo argomento.

Ottieni un brief di implementazione