Sign inGet Started

Get recurring eSIM offer terms

GET
/v1/esim/offers/{offer_id}/recurrence
bird esim offers recurrence <offer-id>
Response200
{
  "delivery_mode": "exact_period",
  "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "model": "calendar_month",
  "price": {
    "amount": "0.00995",
    "currency_code": "USD"
  }
}

Returns the published whole-package recurring price and calendar-month or fixed-day cadence. Enrollment additionally checks that the assigned eSIM mobile network supports these terms.

Parameters

offer_idstring

The offer.

Response Payload

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

offer_id
string
required
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

interval_count
integer
required

The number of calendar months or fixed days in each period.

revision
integer
required

The recurring configuration revision to accept.

price
object
required
Show child attributes
price.amount
string
required

Decimal amount as a string, in major currency units.

price.currency_code
string
required

ISO 4217 currency code.

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