`bird esim recurring-subscriptions create`

Usage

Code example

bird esim recurring-subscriptions create [flags]

Purchase the first recurring period on an assigned eSIM. Reuse the required Idempotency-Key and identical request to recover enrollment. Check subscription and period history for payment and delivery outcomes. Changed prices, unfunded renewal, or confirmed delivery failure stop future renewal.

Build the request from flags, a JSON EsimRecurringSubscriptionCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Browser confirmation: the review link goes to stderr, not stdout, as next[].url in a JSON line that also carries confirmation_id. The command then waits and prints the result on stdout; --confirmation-id waits on an existing one.

Examples

Code example

# print the body shape (no credentials needed)
bird esim recurring-subscriptions create --example

# the body it prints:

Code example

{
  "accepted_price": {
    "amount": "0.00995",
    "currency_code": "USD"
  },
  "esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg",
  "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
  "offer_revision": 1,
  "recurrence_revision": 1
}

Options

Request

Name	Description
`--body-file`	Read the JSON request body from this file; "-" reads stdin
`--example`	Print a complete example request body, then exit
`--dry-run`	Print the resolved request without sending it, then exit
`--idempotency-key`	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
`--esim-id`	Assigned eSIM receiving the recurring package. (required; or in --body-file)
`--offer-id`	Offer whose recurring terms the buyer accepted. (required; or in --body-file)
`--offer-revision <n>`	The accepted offer revision. (required; or in --body-file)
`--recurrence-revision <n>`	The accepted recurring configuration revision. (required; or in --body-file)
`--response-schema`	Print the fields this command returns, then exit
`--confirmation-id`	Wait for an existing confirmation of this exact request

Name	Description
`bird esim recurring-subscriptions cancel`	Cancel recurring eSIM renewal
`bird esim recurring-subscriptions get`	Get a recurring eSIM subscription
`bird esim recurring-subscriptions list`	List recurring eSIM subscriptions
`bird esim recurring-subscriptions periods`	List recurring eSIM periods

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

Get an implementation brief

Related resources