Skip to main content
POST
/
sim_card_orders
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const simCardOrder = await client.simCardOrders.create({
  address_id: '1293384261075731499',
  quantity: 23,
});

console.log(simCardOrder.data);
{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sim_card_order",
    "quantity": 21,
    "cost": {
      "amount": "2.52",
      "currency": "USD"
    },
    "order_address": {
      "id": "1293384261075731499",
      "street_address": "600 Congress Avenue",
      "extended_address": "14th Floor",
      "locality": "Austin",
      "administrative_area": "TX",
      "country_code": "US",
      "postal_code": "78701"
    },
    "tracking_url": "http://www.example.com/",
    "status": "pending",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
address_id
string
required

Uniquely identifies the address for the order.

Example:

"1293384261075731499"

​
quantity
integer
required

The amount of SIM cards to order.

Required range: x >= 1
Example:

23

Response

Successful Response

​
data
SIMCardOrder · object