SIM Card Orders

Preview SIM card orders

Changed on

Previews a SIM card order purchase, returning estimated costs and details before you place the order. The preview is processed asynchronously.

post/sim_card_order_preview

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/sim_card_order_preview
  • Auth: HTTP bearer

Request body

quantityinteger required

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

address_idstring required

Uniquely identifies the address for the order.

Example request

{
  "quantity": 21,
  "address_id": "1293384261075731499"
}

Response

Successful Response

Example response

{
  "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
  }
}

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