---
title: "Create a sub number orders report"
method: POST
path: "/sub_number_orders/report"
tags: ["Phone Number Orders"]
---

# Create a sub number orders report

`POST /sub_number_orders/report`

## Request

- Base URL: `https://api.telnyx.com/v2`
- URL: `https://api.telnyx.com/v2/sub_number_orders/report`
- Auth: HTTP bearer

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

## Request body

- CreateSubNumberOrdersReportRequest
  - `status` 'pending' | 'success' | 'failure': Filter by order status
  - `country_code` string: Filter by country code
  - `created_at_gt` string, date-time: Filter for orders created after this date
  - `created_at_lt` string, date-time: Filter for orders created before this date
  - `order_request_id` string, uuid: Filter by specific order request ID
  - `customer_reference` string: Filter by customer reference

## Response `202`

Report generation accepted. Poll GET /sub_number_orders/report/{report_id} with the returned report id until the report is ready.

- object
  - `data` SubNumberOrdersReport
    - `id` string, 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` string, date-time
      - `created_at_lt` string, date-time
      - `order_request_id` string, uuid
      - `customer_reference` string
    - `status` 'pending' | 'success' | 'failed' | 'expired': 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` string, uuid: The ID of the user who created the report.
    - `created_at` string, date-time: ISO 8601 formatted date indicating when the resource was created.
    - `updated_at` string, date-time: ISO 8601 formatted date indicating when the resource was updated.

## Other responses

- `400`: Bad request, the request was unacceptable, often due to missing a required parameter.
- `401`: Unauthorized
- `422`: Unprocessable entity. Check the 'detail' field in response for details.
- `500`: Unexpected error

## Changes

- **2026-10-15** `a72569d69430`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/team-telnyx/apis/telnyx-api/changes/sub_number_orders/report/post.md)

---

[API](https://skmtc.dev/team-telnyx/apis/telnyx-api.md) - [All operations](https://skmtc.dev/team-telnyx/apis/telnyx-api/llms.txt) - [OpenAPI document](https://skmtc.dev/team-telnyx/apis/telnyx-api/revisions/0f17b8167873?raw)