Skip to content

List an employer's billing invoices

GET/v1/employers/{employer_id}/invoices

Returns a cursor-paginated page of the employer’s billing invoices, newest first. Pass the next_offset from a previous page as offset to fetch the next page. The caller must be authorized for the employer; an unknown or unauthorized employer returns 404.

Path ParametersExpand Collapse
employer_id: string

Unique employer identifier (empr_*)

Query ParametersExpand Collapse
limit: optional number

Maximum number of invoices per page

minimum1
maximum100
offset: optional string

Opaque cursor from a previous page’s next_offset

minLength1
ReturnsExpand Collapse
data: array of { invoice_id, period, status, total }
invoice_id: string

Chargebee invoice id (external id, not a prefixed UUID).

period: string

Invoice date as an ISO string, or null.

status: string

Chargebee invoice status (e.g. paid), or null.

total: number

Invoice total in dollars, or null.

formatdouble

List an employer's billing invoices

curl https://api.vitablehealth.com/v1/employers/$EMPLOYER_ID/invoices \
    -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY"
{
  "data": [
    {
      "invoice_id": "INV-00042",
      "period": "2026-05-01T00:00:00+00:00",
      "total": 1234.56,
      "status": "paid"
    }
  ],
  "pagination": {
    "next_offset": "[\"1748736000000\", \"INV-00042\"]"
  }
}
Returns Examples
{
  "data": [
    {
      "invoice_id": "INV-00042",
      "period": "2026-05-01T00:00:00+00:00",
      "total": 1234.56,
      "status": "paid"
    }
  ],
  "pagination": {
    "next_offset": "[\"1748736000000\", \"INV-00042\"]"
  }
}