Skip to main content

Create a sub number orders report

POST 
/sub_number_orders_report

Create a CSV report for sub number orders. The report will be generated asynchronously and can be downloaded once complete.

Request ​

Body

    status string

    Possible values: [pending, success, failure]

    Filter by order status

    country_code string

    Filter by country code

    created_at_gt date-time

    Filter for orders created after this date

    created_at_lt date-time

    Filter for orders created before this date

    order_request_id uuid

    Filter by specific order request ID

    customer_reference string

    Filter by customer reference

Responses ​

202: Sub number orders report response

Schema

    data

    object

    id uuid

    Identifies the resource.

    order_type string

    The type of order report.

    filters

    object

    The filters that were applied to generate this report

    status string
    country_code string
    created_at_gt date-time
    created_at_lt date-time
    order_request_id uuid
    customer_reference string

    The filters that were applied to generate this report

    status string

    Possible values: [pending, success, failed, expired]

    Default value: pending

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

    user_id uuid

    The ID of the user who created the report.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    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

    url string

    URL with additional information on the error.

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/sub_number_orders_report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "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": "12ade33a-21c0-473b-b055-b3c836e1c293",
  "customer_reference": "STRING"
}'

Response samples

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