List billing history

Paginated invoice history for the caller's organization with optional filters and sort.

limitinteger

max items per page

offsetinteger

pagination offset

searchstring

free-text search across invoice number/description

billing_cyclestring

filter by billing cycle

sort_bystring

column to sort by

sort_orderstring

asc or desc

statusstring

invoice status filter (lowercase)

date_fromstring

RFC3339 lower bound for invoice_date

date_tostring

RFC3339 upper bound for invoice_date (with date_from = an exact calendar month)

plan_namestring

filter by plan name

phone_idstring

filter to invoices for a dedicated phone

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

limitinteger required

Page size used for this response.

offsetinteger required

Pagination offset used for this response.

totalinteger required

Total number of invoices matching the query.

{
  "$schema": "/api/v1/BillingHistoryResponse.json"
}