Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const subNumberOrdersReport = await client.subNumberOrdersReport.create(); console.log(subNumberOrdersReport.data);

{ "data": { "order_type": "sub_number_order", "filters": { "status": "success", "country_code": "US", "created_at_gt": "2023-04-05T10:22:08.230549Z", "created_at_lt": "2025-06-05T10:22:08.230549Z", "order_request_id": "991b8ff5-4daf-4826-9a22-e3991b444a9c", "customer_reference": "STRING" }, "status": "pending", "created_at": "2025-06-11T13:21:40.967339+00:00", "user_id": "0d7ef697-df19-413a-b724-56b0539f5397", "updated_at": "2025-06-11T13:21:45.753260+00:00", "id": "cada7e84-122b-4b47-bc66-58c7c3becd40" } }

Authorizations

Authorization

string

header

required

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

Body

application/json

status

enum<string>

Filter by order status

Available options:

pending,

success,

failure

Example:

"success"

country_code

string

Filter by country code

Example:

"US"

created_at_gt

string<date-time>

Filter for orders created after this date

Example:

"2023-04-05T10:22:08.230549Z"

created_at_lt

string<date-time>

Filter for orders created before this date

Example:

"2025-06-05T10:22:08.230549Z"

order_request_id

string<uuid>

Filter by specific order request ID

Example:

"12ade33a-21c0-473b-b055-b3c836e1c293"

customer_reference

string

Filter by customer reference

Example:

"STRING"

Response

Sub number orders report response

data

object

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

"cada7e84-122b-4b47-bc66-58c7c3becd40"

data.order_type

string

The type of order report.

Example:

"sub_number_order"

data.filters

object

The filters that were applied to generate this report

Show child attributes

data.filters.status

string

Example:

"success"

data.filters.country_code

string

Example:

"US"

data.filters.created_at_gt

string<date-time>

Example:

"2023-04-05T10:22:08.230549Z"

data.filters.created_at_lt

string<date-time>

Example:

"2025-06-05T10:22:08.230549Z"

data.filters.order_request_id

string<uuid>

Example:

"991b8ff5-4daf-4826-9a22-e3991b444a9c"

data.filters.customer_reference

string

Example:

"STRING"

data.status

enum<string>

default:pending

Indicates the completion level of the sub number orders report. The report must have a status of 'success' before it can be downloaded.

Available options:

pending,

success,

failed,

expired

Example:

"pending"

data.user_id

string<uuid>

The ID of the user who created the report.

Example:

"0d7ef697-df19-413a-b724-56b0539f5397"

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

"2025-06-11T13:21:40.967339+00:00"

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2025-06-11T13:21:45.753260+00:00"

Example:

{
  "order_type": "sub_number_order",
  "filters": {
    "status": "success",
    "country_code": "US",
    "created_at_gt": "2023-04-05T10:22:08.230549Z",
    "created_at_lt": "2025-06-05T10:22:08.230549Z",
    "order_request_id": "991b8ff5-4daf-4826-9a22-e3991b444a9c",
    "customer_reference": "STRING"
  },
  "status": "pending",
  "created_at": "2025-06-11T13:21:40.967339+00:00",
  "user_id": "0d7ef697-df19-413a-b724-56b0539f5397",
  "updated_at": "2025-06-11T13:21:45.753260+00:00",
  "id": "cada7e84-122b-4b47-bc66-58c7c3becd40"
}

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup