Remove a data package
/v1/esim/sims/{esim_id}/packages/{package_id}bird esim packages delete <esim-id> <package-id> --yescurl -X DELETE "https://us1.platform.bird.com/v1/esim/sims/{esim_id}/packages/{package_id}" \
-H "Authorization: Bearer $TOKEN" \
--url-query "acknowledge_balance_forfeit=false"{
"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.
Parámetros
esim_idstringeSIM ID.
package_idstringData package ID.
Parámetros de consulta
acknowledge_balance_forfeitbooleanConfirms you accept that the package's remaining balance is forfeited. Omitted or false while balance remains, the request fails with a conflict error.
Carga de respuesta
idorder_idThe order that purchased this package.
offer_idOffer this package was purchased from.
zone_idCoverage zone the package draws on. The name and countries below are captured at purchase time; the zone resource carries the live footprint.
zone_nameCoverage zone name, from the offer.
countriesCountries the package's zone covers, captured at purchase time so the package is meaningful without fetching the offer.
statusspeedSpeed class, from the offer.
balanceactivated_atWhen the package started consuming data (first use in its zone). Null until then.
expires_atWhen 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.
created_atRecursos relacionados
Continúa con la documentación, guías y ejemplos de este tema.