Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Remove a data package

DELETE
/v1/esim/sims/{esim_id}/packages/{package_id}
bird esim packages delete <esim-id> <package-id> --yes
Response202
{
  "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"
  }
}

Removes a data package and frees capacity under the eSIM's package_limit. Remaining data is forfeited without a refund. If usable balance remains, the request returns 409 unless acknowledge_balance_forfeit=true.

A 202 response returns the package in removing. Use Get a data package to confirm removed. If the network rejects removal, the package returns to its previous status.

Parameters

esim_idstring

eSIM ID.

package_idstring

Data package ID.

Query Parameters

acknowledge_balance_forfeitboolean

Confirms you accept that the package's remaining balance is forfeited. Omitted or false while balance remains, the request fails with a conflict error.

Response Payload

id
string
required
order_id
string
required

The order that purchased this package.

offer_id
string
required

Offer this package was purchased from.

zone_id
string
required

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

zone_name
string
required

Coverage zone name, from the offer.

countries
array of string
required

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

status
string
required
speed
string
required

Speed class, from the offer.

balance
object
required
Show child attributes
activated_at
nullable string

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

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.

price
object
required

What your workspace was billed for this package.

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.

created_at
string
required

Related resources

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

Get an implementation brief