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
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
recurrence.available
boolean
required

Whether automatic renewal is currently available for a new eSIM.

recurrence.quote
nullable object
required
Show child attributes
recurrence.quote.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
recurrence.quote.funding.tax_amount
object
required

Tax included in the purchase total.

Show child attributes
recurrence.quote.funding.total
object
required

Total wallet charge for this purchase, including tax.

Show child attributes
recurrence.quote.funding.covered
boolean
required

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

recurrence.quote.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
recurrence.quote.delivery_mode
string
required

Relationship between the paid period and package delivery.

  • exact_period: the package covers the accepted paid interval.
  • recurring_top_up: each funded period purchases a standard package. Activation, expiry, and accumulation follow that package’s terms.

Possible values: exact_period, recurring_top_up

recurrence.quote.offer_revision
integer
required

The offer revision to accept when purchasing.

recurrence.quote.recurrence_revision
integer
required

The recurring configuration revision to accept when purchasing.

recurrence.quote.price
object
required

Price before tax for the first period and each renewal.

Show child attributes
recurrence.quote.model
string
required

Billing cadence for recurring packages.

  • calendar_month: periods follow calendar months from the billing anchor.
  • fixed_days: each period lasts the stated number of 24-hour days.

Possible values: calendar_month, fixed_days

recurrence.quote.interval_count
integer
required

The number of calendar months or fixed 24-hour days per period.

recurrence.unavailable_reason
nullable string
required

Related resources

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

Get an implementation brief