Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

Suspend an eSIM

POST
/v1/esim/sims/{esim_id}/suspend
bird esim suspend <esim-id>
Réponse202
{
  "subscriber_id": "esub_01krdgeqcxet5s7t44vh8rt9mg",
  "id": "esm_01krdgeqcxet5s7t44vh8rt9mg",
  "status": "provisioning",
  "mode": "live",
  "iccid": "8944500212345678912",
  "phone_number": "+31612345678",
  "capabilities": {
    "data": "yes",
    "sms_inbound": "yes",
    "sms_outbound": "yes",
    "voice_inbound": "yes",
    "voice_outbound": "yes"
  },
  "order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
  "display_name": "Amsterdam trip, order 8812",
  "installation": {
    "state": "pending"
  },
  "packages": [
    {
      "id": "epk_01krdgeqcxet5s7t44vh8rt9mg",
      "order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
      "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
      "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
      "zone_name": "Europe",
      "countries": [
        "US"
      ],
      "status": "provisioning",
      "speed": "full",
      "price": {
        "amount": "0.00995",
        "currency_code": "USD"
      }
    }
  ],
  "zone_balances": [
    {
      "zone_id": "ezn_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "available_actions": [
    {
      "action": "suspend",
      "operation": "suspendEsim",
      "reason": "permission_denied",
      "requires": [
        "acknowledge_balance_forfeit"
      ]
    }
  ],
  "package_limit": 3,
  "usage_available": true,
  "balance_reporting": "available",
  "last_attachment": {
    "country_code": "US"
  },
  "tags": [
    {
      "name": "category",
      "value": "welcome"
    }
  ],
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Suspends the eSIM's data service, for example during a payment dispute or a suspected-fraud hold. Suspension is reversible: use Resume an eSIM to restore service. The suspension does not pause validity: package expiry and the eSIM's service period keep running while suspended. Completes asynchronously; the esim.suspended webhook event confirms it.

Paramètres

esim_idstring

eSIM ID.

Contenu de la réponse

subscriber_id
nullable string
obligatoire

The assigned service user, or null when the eSIM has no person assignment.

id
string
obligatoire
status
string
obligatoire
mode
string
obligatoire
iccid
nullable string
obligatoire

ICCID of the eSIM profile. Null while no profile is allocated yet, for example when provisioning failed before allocation.

phone_number
nullable string
obligatoire

Phone number attached to this eSIM, in E.164 format, as the supplier reports it. Null while none is on record: a data-only plan comes with no number, and a plan that includes one reports it after provisioning.

capabilities
object
Afficher les attributs enfants
order_id
string
obligatoire

The order that created this eSIM.

display_name
nullable string

Free-text label for your own reference, for example a traveler or order reference.

installation
object
obligatoire
Afficher les attributs enfants
packages
array of object
obligatoire

Current data packages, one per purchase.

Afficher les attributs enfants
packages.id
string
obligatoire
packages.order_id
string
obligatoire

The order that purchased this package.

packages.offer_id
string
obligatoire

Offer this package was purchased from.

packages.zone_id
string
obligatoire

Coverage zone the package draws on. The name and countries below are captured at purchase time; the zone resource carries the live footprint.

packages.zone_name
string
obligatoire

Coverage zone name, from the offer.

packages.countries
array of string
obligatoire

Countries the package's zone covers, captured at purchase time so the package is meaningful without fetching the offer.

packages.status
string
obligatoire
packages.speed
string
obligatoire

Speed class, from the offer.

packages.balance
object
obligatoire
Afficher les attributs enfants
packages.activated_at
nullable string

When the package started consuming data (first use in its zone). Null until then.

packages.expires_at
nullable string

When the package's validity ends and unused balance expires. Already capped by the eSIM's service period, so this is always the effective expiry. Null until the package activates.

packages.price
object
obligatoire

What your workspace was billed for this package.

Afficher les attributs enfants
packages.created_at
string
obligatoire
zone_balances
array of object
obligatoire

Remaining data per coverage zone, combined across the zone's packages. Derived; the packages are the source of truth.

Afficher les attributs enfants
available_actions
array of object

Actions currently available to you on this eSIM, with reasons for unavailable actions. Returned by the individual eSIM read. Use this to display controls and explain restrictions. Each action rechecks permissions and state when submitted, so availability is not a guarantee of success.

Afficher les attributs enfants
package_limit
integer
obligatoire

Maximum number of concurrent data packages this eSIM can hold, counted across all zones; several packages may share one zone. Enforced when packages are added.

usage_available
boolean
obligatoire

Whether daily usage history is supported for this eSIM. The daily usage endpoint is currently unavailable; read package balances for reported consumption.

balance_reporting
string
obligatoire

Whether ongoing package consumption reporting is available. Separate from daily usage history. Null package consumption values mean no measurement is available.

ready_until
nullable string

Activate (first network use) before this moment or the eSIM expires. Null once activated.

activated_at
nullable string

When the eSIM first used a mobile network. Null until then.

active_until
nullable string

When the eSIM's service period ends. The period starts at activation and data packages cannot outlive it. Null until activated.

last_attachment
nullable object

Most recent network attachment, or null before first attach.

Afficher les attributs enfants
tags
array of object

Tags for routing, filtering, and stats grouping, echoed on webhook events for the eSIM.

Afficher les attributs enfants
metadata
object

Your own key-value data, echoed on webhook events for the eSIM. Maximum 2 KB serialized.

created_at
string
obligatoire
updated_at
string
obligatoire

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation