Skip to main content
POST
Purchase a plan (synchronous)

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /api/v1.1/auth/token.

Headers

Idempotency-Key
string

Any string unique to this logical request. On a retry with the same key and the same request body, the original response is replayed verbatim (with an Idempotency-Replayed: true response header) instead of the action repeating. Reusing the key with a different body or on a different route returns 409 IDEMPOTENCY_KEY_REUSED. A replay attempted while the original call is still in flight returns 409 CONFLICT. Optional — omit it and the endpoint behaves exactly as it would otherwise.

Example:

"a1b2c3d4-idem-key-001"

Body

application/json
iccid
string
required
Example:

"8901260853182965429"

productName
string
required
Example:

"AT&T 5GB"

activateNow
boolean
required

No default — must be sent explicitly.

Example:

true

scheduleDate
string

YYYY-MM-DD; required when activateNow=false.

Example:

"2026-08-01"

Response

Purchased.