Billing

List Invoices

List your organization's finalized invoices, newest first.

Draft invoices are excluded: a draft is a bill Stripe is still assembling, so its amounts can still change and it may never be issued.

start and end are whole UTC dates (YYYY-MM-DD) and filter on the date the invoice was issued (created), not the billing period it covers. end is inclusive of that entire day.

Monetary fields are integers in the smallest currency unit (cents for USD), matching Stripe — divide by 100 before displaying.

Results are cursor-paginated: when has_more is true, pass next_cursor as starting_after. Page until has_more is false, not until a page comes back empty — drafts are removed after Stripe has counted them toward the page, so a page can hold fewer invoices than limit, or none, while has_more is still true.

Requires the billing_report permission. An API key carries the permissions of the user it belongs to.

get/payments/invoices

Request

  • Base URL: https://ai.hatz.ai/v1
  • URL: https://ai.hatz.ai/v1/payments/invoices
  • Auth: API key in header X-API-Key

Query parameters

startstring date nullable

Only invoices issued on or after this UTC date (YYYY-MM-DD).

endstring date nullable

Only invoices issued on or before this UTC date (YYYY-MM-DD), inclusive of the whole day.

limitinteger

Invoices per page (1-100).

starting_afterstring nullable

Invoice ID to page after — pass the previous response's next_cursor.

entity_idstring nullable

Which of your organizations to read. Required only if you hold billing access to more than one.

Response

Successful Response

has_moreboolean required

True when Stripe has more invoices beyond this page. Drafts are removed after the page is fetched, so the next page can hold fewer invoices than limit, or none.

next_cursorstring nullable

Opaque pagination token. Pass it back verbatim as starting_after; it may name an invoice absent from invoices (including a draft that 404s if fetched by id). Null when has_more is false.

Changes

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