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

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

const response = await client.simCardOrderPreview.preview({
  address_id: '1293384261075731499',
  quantity: 21,
});

console.log(response.data);
{
  "data": {
    "total_cost": {
      "amount": "2.32",
      "currency": "USD"
    },
    "shipping_cost": {
      "amount": "2.32",
      "currency": "USD"
    },
    "sim_cards_cost": {
      "amount": "2.32",
      "currency": "USD"
    },
    "record_type": "sim_card_order_preview",
    "quantity": 21
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
quantity
integer
required

The amount of SIM cards that the user would like to purchase in the SIM card order.

Required range: x >= 1
Example:

21

​
address_id
string
required

Uniquely identifies the address for the order.

Example:

"1293384261075731499"

Response

Successful Response

​
data
SIMCardOrderPreview · object