---
title: "List recurring eSIM periods"
method: GET
path: "/v1/esim/subscriptions/{subscription_id}/periods"
tags: ["esims"]
---

# List recurring eSIM periods

`GET /v1/esim/subscriptions/{subscription_id}/periods`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/esim/subscriptions/{subscription_id}/periods`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns funded periods with their original charges, confirmed credits, and delivery orders. Unfunded renewals do not create a paid period.

## Query parameters

- `limit` integer
- `starting_after` string
- `ending_before` string

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

The requested resource.

- EsimRecurringPeriodList
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: Refresh anchor, the first row of this response. Pass back as `ending_before` to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-`null` whenever `data` is non-empty; `null` only on an empty page. Distinct from `prev_cursor`.
  - `data` EsimRecurringPeriod[], required
    - `delivery_mode` 'exact_period' | 'recurring_top_up', 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.
    - `period_start` string, date-time, required: Start of the funded billing period. Package activation follows the accepted delivery mode.
    - `period_end` string, date-time, required: End of the paid billing period. A recurring top-up package can expire at a different time; check the package’s expiry.
    - `status` 'pending' | 'completed' | 'failing' | 'failed', required: Delivery outcome of a paid period. - `pending`: package delivery has not been confirmed, including an uncertain network outcome. - `completed`: the package was delivered. - `failing`: delivery failed and the credit is being processed. - `failed`: failure processing is complete. Check `refund_transaction_id` for an issued credit.
    - `net_amount` Money, required
      - `amount` string, required: Decimal amount as a string, in major currency units.
      - `currency_code` string, required: ISO 4217 three-letter currency code.
    - `tax_amount` Money, required
      - `amount` string, required: Decimal amount as a string, in major currency units.
      - `currency_code` string, required: ISO 4217 three-letter currency code.
    - `total_amount` Money, required
      - `amount` string, required: Decimal amount as a string, in major currency units.
      - `currency_code` string, required: ISO 4217 three-letter currency code.
    - `wallet_transaction_id` string, required
    - `refund_transaction_id` string, required
    - `order_id` string, required
    - `order_status` 'scheduled' | 'charging' | 'provisioning' | 'pending' | 'completed' | 'failed' | 'canceled', required: Order state. - `scheduled`: reserved for a future scheduled purchase; no charge has been made. - `charging`: payment is being obtained. If funds are insufficient, inspect `funding` and your wallet balance. One-time orders retry automatically; an initial recurring purchase requires an explicit retry after adding funds. - `provisioning`: the package is being provisioned during the request. - `pending`: the purchase continues after the request returns. Read the order again to check its outcome. - `completed`: delivery completed and the eSIM and package IDs are available. This does not confirm device installation. Terminal. - `failed`: delivery failed. Any charge is credited automatically; `refund_transaction_id` identifies an issued credit. Terminal. - `canceled`: reserved for a scheduled purchase withdrawn before execution. Canceling an unfunded order currently returns `failed` with `failure_code: canceled`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `409`: Resource conflict
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/6dfce1179799?raw)