SIM Cards

Purchase eSIMs

Changed on

Purchases and registers the specified amount of eSIMs to the current user's account.<br/><br/> If <code>sim_card_group_id</code> is provided, the eSIMs will be associated with that group. Otherwise, the default group for the current user will be used.<br/><br/>

post/actions/purchase/esims

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/actions/purchase/esims
  • Auth: HTTP bearer

Request body

sim_card_group_idstring uuid

The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.

tagsstring[]

Searchable tags associated with the SIM cards

productstring

Type of product to be purchased, specify "whitelabel" to use a custom SPN

whitelabel_namestring

Service Provider Name (SPN) for the Whitelabel eSIM product. It will be displayed as the mobile service name by operating systems of smartphones. This parameter must only contain letters, numbers and whitespaces.

amountinteger required

The amount of eSIMs to be purchased.

status'enabled' | 'disabled' | 'standby'

Status on which the SIM cards will be set after being successfully registered.

Example request

{
  "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "tags": [
    "personal",
    "customers",
    "active-customers"
  ],
  "product": "whitelabel",
  "whitelabel_name": "Custom SPN",
  "amount": 10,
  "status": "standby"
}

Response

Successful response

Example response

{
  "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",
      "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",
      "esim_installation_status": "released",
      "version": "4.3",
      "resources_with_in_progress_actions": [],
      "authorized_imeis": [
        "106516771852751",
        "534051870479563",
        "508821468377961"
      ]
    }
  ]
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status