Sign in
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

Changes

Changed in 2 of the 24 revisions of this API.12

  • 72506953f3671See the full diff
    • ▲

      the total response's property type/format changed from number/ to string/ for status 200

      response-property-type-changed

  • ed1825db11c62See the full diff
    • ○

      added the required property overdue to the response with the 200 status

      response-required-property-added

    • ○

      added the required property paid to the response with the 200 status

      response-required-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog