COcommpeak
Invoices

List invoices

Returns the account's invoices as shown on the Invoices page in the portal, newest first, with number, date, billing period, amount and status (new, published, partially_paid, paid, …). Without time_range the last week is returned (last 3 months for accounts invoiced with monthly usage summaries); a range can span at most 1 year. Accounts with separate Voice and SMS balances can narrow the list with account. document_available tells whether the invoice document can be downloaded in the portal; for monthly usage summaries payment_demand_open tells whether an unpaid payment demand is outstanding. Pagination is by page and per_page (default 100, max 1000).

get/invoices

Request

  • Base URL
    https://api.commpeak.com/portal
  • URL
    https://api.commpeak.com/portal/invoices
  • Auth
    API key in header Authorization

Query parameters

time_rangestring nullable

Date range "YYYY-MM-DD - YYYY-MM-DD" (or a single date).

accountstring nullable

voice or sms; only for accounts with separate Voice and SMS balances.

pageinteger nullable

Page number (default 1).

per_pageinteger nullable

Items per page (default 100, max 1000).

Response

Successful Response

pageinteger nullable

Current page.

per_pageinteger nullable

Items per page.

totalinteger nullable

Total number of items.

Example response

{
  "invoices": [
    {
      "amount": 431.25,
      "currency": "USD",
      "document_available": true,
      "id": 2001,
      "invoice_date": "2026-10-01",
      "number": "INV-2026-0042",
      "period_end": "2026-09-30",
      "period_start": "2026-09-01",
      "status": "paid"
    }
  ],
  "page": 1,
  "per_page": 100,
  "total": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.