Preview SIM card orders

POST 
/sim_card_order_preview

Preview SIM card order purchases.

Request

application/json

Body

quantity integerrequired

Possible values: >= 1

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

address_id int64required

Uniquely identifies the address for the order.

Responses

202: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

total_cost

object

amount string

A string representing the cost amount.

currency currency

ISO 4217 currency string.

shipping_cost

object

amount string

A string representing the cost amount.

currency currency

ISO 4217 currency string.

sim_cards_cost

object

amount string

A string representing the cost amount.

currency currency

ISO 4217 currency string.

record_type string

Identifies the type of the resource.

quantity integer

The amount of SIM cards requested in the SIM card order.

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

422: Unprocessable entity. Check the 'detail' field in response for details.

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/sim_card_order_preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "quantity": 21,
  "address_id": "1293384261075731499"
}'

Response samples

• 202
• 422

---

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

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}