Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

List offers an eSIM can take

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

Paramètres

esim_idstring

Identifier of the eSIM.

Paramètres de requête

recurring_onlyboolean

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

Contenu de la réponse

data
array of object
obligatoire

Orderable top-up offers for this eSIM.

Afficher les attributs enfants
data.id
string
obligatoire
data.name
string
obligatoire

Display name of the offer.

data.revision
integer
obligatoire

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

data.zone_id
string
obligatoire

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

data.speed
string
obligatoire

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

data.stackable
boolean
obligatoire

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
obligatoire

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.

Afficher les attributs enfants
data.pricing
object
obligatoire

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.

Afficher les attributs enfants
data.pricing.type
string
obligatoire

Pricing type.

Value: bundle

data.pricing.data
object
obligatoire
Afficher les attributs enfants
data.pricing.validity
object
obligatoire

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.

Afficher les attributs enfants
data.pricing.price
object
obligatoire

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

Afficher les attributs enfants
data.pricing.price.amount
string
obligatoire

Decimal amount as a string, in major currency units.

data.pricing.price.currency_code
string
obligatoire

ISO 4217 currency code.

data.product
string
obligatoire

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

data.status
string
obligatoire
data.created_at
string
obligatoire
as_of
string
obligatoire

When this answer was computed.

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation