Skip to main content
GET
/
sub_number_orders
/
{sub_number_order_id}
JavaScript
import Telnyx from 'telnyx';

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

const subNumberOrder = await client.subNumberOrders.retrieve('sub_number_order_id');

console.log(subNumberOrder.data);
{
  "data": {
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "order_request_id": "12ade33a-21c0-473b-b055-b3c836e1c293",
    "country_code": "US",
    "phone_number_type": "local",
    "user_id": "d70873cd-7c98-401a-81b6-b1ae08246995",
    "regulatory_requirements": [
      {
        "record_type": "phone_number_regulatory_requirement",
        "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
        "field_type": "address"
      }
    ],
    "record_type": "sub_number_order",
    "phone_numbers_count": 1,
    "created_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z",
    "requirements_met": true,
    "status": "pending",
    "customer_reference": "MY REF 001",
    "is_block_sub_number_order": false
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
sub_number_order_id
string
required

The sub number order ID.

Query Parameters

​
filter
object

Consolidated filter parameter (deepObject style). Originally: filter[include_phone_numbers]

Response

Successful response with details about a sub number order.

​
data
object