Create a recurring eSIM subscription
/v1/esim/subscriptionsbird esim recurring-subscriptions create --body-file - <<'JSON'
{
"esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg",
"offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
"offer_revision": 1,
"recurrence_revision": 1,
"accepted_price": {
"amount": "0.00995",
"currency_code": "USD"
}
}
JSONcurl -X POST "https://us1.platform.bird.com/v1/esim/subscriptions" \
-H "Authorization: Bearer $TOKEN" \
-H "Idempotency-Key: $IDEMPOTENCY_KEY" \
-H "Content-Type: application/json" \
-d '{
"esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg",
"offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
"offer_revision": 1,
"recurrence_revision": 1,
"accepted_price": {
"amount": "0.00995",
"currency_code": "USD"
}
}'{
"delivery_mode": "exact_period",
"id": "ers_01krdgeqcxet5s7t44vh8rt9mg",
"esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg",
"initial_order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
"subscriber_id": "esub_01krdgeqcxet5s7t44vh8rt9mg",
"offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
"status": "pending",
"latest_order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
"price": {
"amount": "0.00995",
"currency_code": "USD"
},
"model": "calendar_month",
"stop_reason": "canceled"
}
Starts a recurring package on an assigned eSIM and purchases the first period. Each accepted period is funded from your organization's wallet. A changed price requires new acceptance; an unfunded renewal or confirmed delivery failure stops future renewal.
An Idempotency-Key is required. Reuse the same key and request to recover the enrollment, including after the original response is no longer retained. Reusing the key with different enrollment details returns 409. Read the subscription and its period history to check payment and package delivery separately.
Corps de la requête
esim_idAssigned eSIM receiving the recurring package.
offer_idOffer whose recurring terms the buyer accepted.
offer_revisionThe accepted offer revision.
recurrence_revisionThe accepted recurring configuration revision.
accepted_priceContenu de la réponse
delivery_modeRelationship 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.
Possible values: exact_period, recurring_top_up
idesim_idThe provisioned eSIM, or null while the initial purchase is pending.
initial_order_idThe initial purchase order, or null when recurrence was enrolled on an existing eSIM.
subscriber_idoffer_idstatusDelivery state of the recurring service. Check payment and renewal fields separately.
pending: enrollment or the initial purchase is still being processed.active: the service has delivered a package and remains active.needs_attention: delivery or a related credit remains unresolved. Check period history and the associated order before purchasing a replacement.ended: recurrence has ended. Previously delivered packages keep their own validity.
Possible values: pending, active, needs_attention, ended
billing_statusThe financial subscription state, or null while acceptance is pending.
current_period_startThe authoritative billing period boundary, or null while acceptance is pending.
current_period_endThe authoritative billing period boundary, or null while acceptance is pending.
cancel_at_period_endWhether future renewal is stopped at the current paid boundary.
latest_order_idThe order for the current billing period, or null before fulfillment starts.
created_atWhen the recurring service was requested.
priceAccepted package price before tax, in its published currency. Null before Billing accepts enrollment.
Afficher les attributs enfants
price.amountDecimal amount as a string, in major currency units.
price.currency_codeISO 4217 currency code.
modelAccepted cadence, or null before Billing accepts enrollment.
interval_countNumber of calendar months or fixed 24-hour days in each accepted period. Null before acceptance.
next_renewal_atNext scheduled renewal boundary. Null when enrollment is pending or future renewals have stopped.
cancellation_effective_atWhen canceled recurrence ends: the paid boundary for scheduled cancellation, or the recorded cancellation time for an immediate stop. Null when renewal has not been stopped or no period was accepted. Paid packages remain available under their own validity.
stop_reasonFirst recorded reason future renewal stopped. Null when no reason has been recorded. Delivery outcomes are available separately in period history.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.