List invoices

GET 
/invoices

Retrieve a paginated list of invoices.

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

sort string

Possible values: [period_start, -period_start]

Specifies the sort order for results.

200: List of invoices

application/json

• Schema
• Example (from schema)

Schema

meta

object

total_results integer

total_pages integer

page_number integer

page_size integer

data

object[]

Array [

invoice_id uuid

file_id uuid

period_start date

period_end date

paid boolean

url uri

]

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

default: Unexpected error

application/json

• Schema
• Example (from schema)

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

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/invoices' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

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

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}