`bird esim release`

Usage

Code example

bird esim release <esim-id> [flags]

Permanently release an eSIM. Irreversible: it can never be installed or used again, remaining package balances are forfeited, and release never credits anything back. Use release when responding to fraud or closing out a trip; to pause service temporarily use suspend instead.

This is destructive and cannot be undone; pass --yes to confirm.

Examples

Code example

bird esim release <id> --yes

Options

Safety

Name	Description
`--idempotency-key`	Deduplication key; a retry with the same key won't act twice
`--yes`	Confirm a destructive action (required; the CLI never prompts)

Options

Name	Description
`--acknowledge-balance-forfeit`	Confirms you accept that remaining package balances are forfeited. Omitted or false while unexpired balance remains, the request fails with a conflict error.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird esim compatible-offers`	List offers an eSIM can take
`bird esim get`	Get an eSIM
`bird esim list`	List eSIMs
`bird esim resume`	Resume an eSIM
`bird esim suspend`	Suspend an eSIM
`bird esim update`	Update an eSIM

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

Get an implementation brief

Related resources