---
title: "Create a recurring eSIM subscription"
canonical: "https://bird.com/docs/api/reference/create-esim-recurring-subscription"
---

# Create a recurring eSIM subscription

`POST /v1/esim/subscriptions`

Starts a recurring package on an assigned eSIM and purchases the first period. Each accepted period is funded from your organization's wallet. A changed price requires new acceptance; an unfunded renewal or confirmed delivery failure stops future renewal.

An `Idempotency-Key` is required. Reuse the same key and request to recover the enrollment, including after the original response is no longer retained. Reusing the key with different enrollment details returns `409`. Read the subscription and its period history to check payment and package delivery separately.

## Code samples

**CLI**

```sh
bird esim recurring-subscriptions create --body-file - <<'JSON'
{
  "esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg",
  "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "offer_revision": 1,
  "recurrence_revision": 1,
  "accepted_price": {
    "amount": "0.00995",
    "currency_code": "USD"
  }
}
JSON
```

Examples: [CLI](/docs/api/reference/create-esim-recurring-subscription.cli.md) · [MCP](/docs/api/reference/create-esim-recurring-subscription.mcp.md) · [cURL](/docs/api/reference/create-esim-recurring-subscription.curl.md)

## Example response `200`

```json
{
  "delivery_mode": "exact_period",
  "id": "ers_01krdgeqcxet5s7t44vh8rt9mg",
  "esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg",
  "initial_order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
  "subscriber_id": "esub_01krdgeqcxet5s7t44vh8rt9mg",
  "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "status": "pending",
  "latest_order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
  "price": {
    "amount": "0.00995",
    "currency_code": "USD"
  },
  "model": "calendar_month",
  "stop_reason": "canceled"
}
```

## Request body

- `esim_id` (string, required): Assigned eSIM receiving the recurring package.
- `offer_id` (string, required): Offer whose recurring terms the buyer accepted.
- `offer_revision` (integer, required): The accepted offer revision.
- `recurrence_revision` (integer, required): The accepted recurring configuration revision.
- `accepted_price` (object, required)
- `accepted_price.amount` (string, required): Decimal amount as a string, in major currency units.
- `accepted_price.currency_code` (string, required): ISO 4217 currency code.

## Response body

- `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`
- `id` (string, required)
- `esim_id` (nullable string, required): The provisioned eSIM, or null while the initial purchase is pending.
- `initial_order_id` (nullable string, required): The initial purchase order, or null when recurrence was enrolled on an existing eSIM.
- `subscriber_id` (string, required)
- `offer_id` (string, required)
- `status` (string, required)

  Delivery state of the recurring service. Check payment and renewal fields separately.

  - `pending`: enrollment or the initial purchase is still being processed.
  - `active`: the service has delivered a package and remains active.
  - `needs_attention`: delivery or a related credit remains unresolved. Check period history and the associated order before purchasing a replacement.
  - `ended`: recurrence has ended. Previously delivered packages keep their own validity.

  Possible values: `pending`, `active`, `needs_attention`, `ended`
- `billing_status` (nullable string, required): The financial subscription state, or null while acceptance is pending.
- `current_period_start` (nullable string, required): The authoritative billing period boundary, or null while acceptance is pending.
- `current_period_end` (nullable string, required): The authoritative billing period boundary, or null while acceptance is pending.
- `cancel_at_period_end` (boolean, required): Whether future renewal is stopped at the current paid boundary.
- `latest_order_id` (nullable string, required): The order for the current billing period, or null before fulfillment starts.
- `created_at` (string, required): When the recurring service was requested.
- `price` (nullable object, required): Accepted package price before tax, in its published currency. Null before Billing accepts enrollment.
- `price.amount` (string, required): Decimal amount as a string, in major currency units.
- `price.currency_code` (string, required): ISO 4217 currency code.
- `model` (nullable string, required): Accepted cadence, or null before Billing accepts enrollment.
- `interval_count` (nullable integer, required): Number of calendar months or fixed 24-hour days in each accepted period. Null before acceptance.
- `next_renewal_at` (nullable string, required): Next scheduled renewal boundary. Null when enrollment is pending or future renewals have stopped.
- `cancellation_effective_at` (nullable string, required): When canceled recurrence ends: the paid boundary for scheduled cancellation, or the recorded cancellation time for an immediate stop. Null when renewal has not been stopped or no period was accepted. Paid packages remain available under their own validity.
- `stop_reason` (nullable string, required): First recorded reason future renewal stopped. Null when no reason has been recorded. Delivery outcomes are available separately in period history.

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)