`bird numbers orders create`

Usage

Exemple de code

bird numbers orders create [flags]

Buys a number and starts its recurring charge. The available number’s pricing is the current price and sets the cadence: each charge bills recurring_price times intervals_per_charge, covering that many recurring_periods. The order resolves the price again when charging. Most orders settle inline; one waiting on a carrier comes back pending and is followed with bird numbers orders get. A setup fee already taken is not refunded if the order then fails, unless the carrier delivered the number and it is released, no sooner than 72 hours after the order was placed, because it could not be charged. A compliance block files ownership answers that are a legal representation under the business's name. Review them before you order with one; an agent running this command on someone's behalf confirms them with that person first.

Build the request from flags, a JSON NumbersOrderCreate 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.

Procedure

Step 3 of 5 of "Buy a phone number". Previous: bird numbers available get. Next: bird numbers orders get.

Examples

Exemple de code

# print the body shape (no credentials needed)
bird numbers orders create --example

# the body it prints:

Exemple de code

{
  "number": "+18005550100",
  "reference": "STORE-042"
}

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
`--number`	The number to acquire, in E.164 format, as returned by GET /v1/numbers/available. (required; or in --body-file)
`--reference`	Your own reference to set on the number when this purchase completes. Leading and trailing whitespace is removed. A pending order keeps the reference until the number is allocated.
`--response-schema`	Print the fields this command returns, then exit
`--confirmation-id`	Wait for an existing confirmation of this exact request

Name	Description
`bird numbers orders get`	Get a number order
`bird numbers orders list`	List your number orders

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation

Ressources associées