Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Billing

List Invoices

List all invoices associated with the account

get/v1/billing/invoices

Query parameters

pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page (default = 10)

searchstring
sort'id' | 'date' | 'due_date' | 'dollar_amount' | 'status'
direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

status'Cancelled' | 'Collections' | 'Draft' | 'Payment Pending' | 'Paid' | 'Refunded' | 'Unpaid'

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "id": 880088,
      "date": "2024-05-21",
      "due_date": "2024-05-21",
      "payment": {
        "status": "Unpaid"
      },
      "total": 30
    }
  ]
}