Skip to main content
POST
(Topup) Create a plan attachment

Authorizations

Authorization
string
header
required

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

Path Parameters

xid
string
required

esim ICCID or subscription id

Body

application/json

Exactly one of the planId or plan should be provided

activationType
enum<string>
required
Available options:
FIRST_USAGE,
NOW,
SCHEDULED
planId
string
plan
object
activationAt
number

Unix timestamp at which the plan should be activated. Only required when activation type is SCHEDULED.

Response

200 - application/json

OK

id
string
required
createdAt
number
required
activationAt
number
required
expirationAt
number
required
state
enum<string>
required
Available options:
CREATED,
PENDING_FOR_FIRST_USE,
SCHEDULED,
ACTIVE,
EXPIRED,
SUSPENDED
usedAllowance
Allowance · object
required
Example:
plan
PlanForAttachment · object
required
Example: