v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Invoices

Get an invoice

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_invoices

OAuth Scopes

ResourceScopes
Organizationread_invoices
get/organizations/{organization}/invoices/{id}

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

idstring required

Invoice public ID from list_invoices. Example: aabb12123434.

Response

Returns an invoice

idstring required

The ID of the invoice

totalstring required

The total amount of the invoice, as a stringified decimal to preserve precision

billing_period_startstring required

Start of the billing period

billing_period_endstring required

End of the billing period

paidboolean required

Whether the invoice has been paid

overdueboolean required

Whether the invoice is past due and unpaid