Skip to main content
POST
Create a subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Exactly one of the plan or planId must be provided.

planId
string
required

The unique id of a plan. The plan must not be archived or an addon.

plan
object

Response

Returns the created subscription.

id
string
required
esimIccid
string
required
planId
string
required
deprecated
plan
PlanForAttachment · object
required
Example:
createdAt
integer
required
activatedAt
integer | null
required
expireAt
integer | null
required
purchasedAllowance
Allowance · object
required
Example:
remainingAllownace
Allowance · object
required
Example:
state
enum<string>
required
Available options:
active,
expired,
ready
metadata
object
required