Get invoice by ID

Changed on

Retrieve a single invoice by its unique identifier.

get/invoices/{id}

Request

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

Path parameters

idstring uuid required

Invoice UUID

Query parameters

action'json' | 'link'
Example:json

Invoice action

Response

Get invoice details

Example response

{
  "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/..."
  }
}

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

    • 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

    • 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

    • 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