Purchase eSIMs
POST/actions/purchase/esims
Purchases and registers the specified amount of eSIMs to the current user's account.
If sim_card_group_id
is provided, the eSIMs will be associated with that group. Otherwise, the default group for the current user will be used.
Request
- application/json
Body
required
sim_card_group_id uuid
The group SIMCardGroup identification. This attribute can be null
when it's present in an associated resource.
tags string[]
Searchable tags associated with the SIM cards
amount integerrequired
Possible values: >= 1
The amount of eSIMs to be purchased.
status string
Possible values: [enabled
, disabled
, standby
]
Default value: enabled
Status on which the SIM cards will be set after being successfully registered.
Responses
202: Successful response
- application/json
401: Unauthorized
Request samples
curl -L 'https://api.telnyx.com/v2/actions/purchase/esims' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"tags": [
"personal",
"customers",
"active-customers"
],
"amount": 10,
"status": "standby"
}'
Response samples
{
"data": [
{
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card",
"status": {
"value": "enabled",
"reason": "The SIM card is active, ready to connect to networks and consume data."
},
"type": "physical",
"iccid": "89310410106543789301",
"imsi": "081932214823362973",
"msisdn": "+13109976224",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"tags": [
"personal",
"customers",
"active-customers"
],
"data_limit": {
"amount": "2048.0",
"unit": "MB"
},
"current_billing_period_consumed_data": {
"amount": "2049.0",
"unit": "MB"
},
"actions_in_progress": true,
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}