Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Get eSIM checkout options

GET
/v1/esim/offers/{offer_id}/checkout
bird esim offers checkout-options <offer-id>
Response200
{
  "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "one_time": {
    "offer_revision": 1,
    "price": {
      "amount": "1.00",
      "currency_code": "EUR"
    },
    "funding": {
      "tax_amount": {
        "amount": "0.21",
        "currency_code": "EUR"
      },
      "total": {
        "amount": "1.21",
        "currency_code": "EUR"
      },
      "covered": true,
      "shortfall": {
        "amount": "0",
        "currency_code": "EUR"
      }
    }
  },
  "recurrence": {
    "available": true,
    "quote": {
      "delivery_mode": "exact_period",
      "offer_revision": 1,
      "recurrence_revision": 2,
      "price": {
        "amount": "2.00",
        "currency_code": "EUR"
      },
      "model": "calendar_month",
      "interval_count": 1,
      "funding": {
        "tax_amount": {
          "amount": "0.42",
          "currency_code": "EUR"
        },
        "total": {
          "amount": "2.42",
          "currency_code": "EUR"
        },
        "covered": false,
        "shortfall": {
          "amount": "1.21",
          "currency_code": "EUR"
        }
      }
    },
    "unavailable_reason": null
  }
}

Returns published one-time terms and automatic renewal availability for a new eSIM, including tax-inclusive totals and current funding shortfalls. Automatic renewal includes its own price and cadence when an eligible mobile network is available. Availability and funding are checked again when purchasing; this read reserves no funds or package.

Parameters

offer_idstring

The offer.

Response Payload

offer_id
string
required
one_time
object
required

Published one-time price and current funding requirement. The price excludes tax; funding.total includes tax.

Show child attributes
one_time.funding
object
required

Current funding needed for this purchase, including tax and approved credit. The quoted price excludes tax; total includes tax for this purchase. This read reserves no funds; payment checks funding again. Test purchases have zero tax and total and are always covered.

Show child attributes
one_time.funding.tax_amount
object
required

Tax included in the purchase total.

Show child attributes
one_time.funding.total
object
required

Total wallet charge for this purchase, including tax.

Show child attributes
one_time.funding.covered
boolean
required

Whether the wallet can currently cover this purchase after reservations and approved credit.

one_time.funding.shortfall
nullable object
required

Additional funds needed to cover this purchase, or null without organization billing read permission. Zero when covered is true.

Show child attributes
one_time.funding.shortfall.amount
string
required

Decimal amount as a string, in major currency units.

one_time.funding.shortfall.currency_code
string
required

ISO 4217 currency code.

one_time.offer_revision
integer
required

The offer revision to accept when purchasing.

one_time.price
object
required

Price before tax to accept when creating the order.

Show child attributes
recurrence
object
required

When available is true, quote contains the recurring terms and unavailable_reason is null. Otherwise quote is null and unavailable_reason explains why renewal is unavailable.

Show child attributes

Related resources

Continue with the documentation, guides and examples for this topic.

Get an implementation brief