Sign in
Phone Number Orders

Create a sub number orders report

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

post/sub_number_orders_report

Request body

country_codestring

Filter by country code

created_at_gtstring date-time

Filter for orders created after this date

created_at_ltstring date-time

Filter for orders created before this date

customer_referencestring

Filter by customer reference

order_request_idstring uuid

Filter by specific order request ID

status'pending' | 'success' | 'failure'

Filter by order status

Example request

{
  "country_code": "US",
  "created_at_gt": "2023-04-05T10:22:08.230549Z",
  "created_at_lt": "2025-06-05T10:22:08.230549Z",
  "customer_reference": "STRING",
  "order_request_id": "12ade33a-21c0-473b-b055-b3c836e1c293",
  "status": "success"
}

Response

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

Example response

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

Changes

Changed in 2 of the 61 revisions of this API.16412

  • 1571b0380bd7124See the full diff
    • ▲

      the response property errors/items/code became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 500

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 500

      response-property-became-optional

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 500

      response-property-type-changed

    • ○

      added the optional property errors/items/meta/url to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 500 status

      response-optional-property-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e537994448See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 500

      response-property-type-changed

    • ●

      removed the optional property errors/items/meta/url from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 500 status

      response-optional-property-removed

    • ○

      the response property errors/items/code became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 500

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 500

      response-property-became-required

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog