Get invoice by ID

GET 
/invoices/:id

Retrieve a single invoice by its unique identifier.

Path Parameters

id uuidrequired

Invoice UUID

Query Parameters

action string

Possible values: [json, link]

Invoice action

200: Get invoice details

application/json

• Schema
• Example (from schema)

Schema

data

object

invoice_id uuid

file_id uuid

period_start date

period_end date

paid boolean

url uri

download_url uri

Present only if the query parameter action=link is set.

{
  "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",
    "download_url": "https://us-east-1.telnyxstorage.com/porting-documents/telnyx/..."
  }
}

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/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "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",
    "download_url": "https://us-east-1.telnyxstorage.com/porting-documents/telnyx/..."
  }
}

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