COcommpeak
Payments

List payment history

Returns the account's balance movements as shown on the Payment History page in the portal: top-ups, deductions, subscriptions and temporary credits, newest first. scope narrows the list to one kind (all, purchase, deductions, subscriptions, temp_credits). Without time_range the last 3 months are returned; 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 a credit note or receipt document exists for the payment in the portal. Pagination is by page and per_page (default 100, max 1000).

get/payments

Request

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

Query parameters

scopestring nullable

Kind of payments: all (default), purchase, deductions, subscriptions, temp_credits.

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

{
  "page": 1,
  "payments": [
    {
      "account": "voice",
      "amount": 500,
      "currency": "USD",
      "date": "2026-10-01T09:00:00.000Z",
      "description": "Balance top-up",
      "document_available": true,
      "id": 1001,
      "type": "purchase"
    }
  ],
  "per_page": 100,
  "total": 1
}

Changes

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