List invoices

Changed on

Returns a paginated list of your invoices, with support for sorting.

get/invoices

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/invoices
  • Auth: HTTP bearer

Query parameters

sort'period_start' | '-period_start'
Example:period_start

Specifies the sort order for results.

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

List of invoices

Example response

{
  "meta": {
    "total_results": 20,
    "total_pages": 1,
    "page_number": 1,
    "page_size": 20
  },
  "data": [
    {
      "invoice_id": "48eff763-ea80-4345-b688-78249eb165a8",
      "file_id": "454ea3b0-9eaa-4fa9-992e-6d9f31c0a37e",
      "period_start": "2023-11-01",
      "period_end": "2023-11-30",
      "paid": true,
      "url": "https://api.telnyx.com:443/v2/invoices/48eff763-ea80-4345-b688-78249eb165a8"
    }
  ]
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status