SaaS APIbilling

List invoices

View as Markdown

List invoices with optional filters. owner, billing_admin, admin can read.

Headers

AuthorizationstringRequired

Bearer {access_token}

X-Workspace-IdstringRequired
Workspace UUID

Query parameters

pageintegerOptional

Page number (default 1)

pageSizeintegerOptional

Page size 1-100 (default 20)

statusstringOptional
draft, open, paid, void, uncollectible
typestringOptional

subscription, overage, vk_expansion, one_time

dateFromstringOptional

ISO date YYYY-MM-DD

dateTostringOptional

ISO date YYYY-MM-DD

Response

data: invoice list, meta: pagination

Errors

400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error