Sign in
Invoices

List all invoices

Retrieve a paginated list of invoices. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.

get/ar/invoices

Query parameters

limitinteger

Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000

order'asc' | 'desc'

Sort order. Can be 'asc' or 'desc'. Defaults to 'asc'

start_afterstring uuid

The ID of the invoice to start the page after (exclusive). When provided, results will begin with the invoice immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.

end_beforestring uuid

The ID of the invoice to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.

Response

Example response

{
  "invoices": [
    {
      "canceledAt": "2016-07-22T00:00:00Z",
      "createdAt": "2016-07-22T00:00:00Z",
      "dueDate": "2016-07-22",
      "invoiceDate": "2016-07-22",
      "updatedAt": "2016-07-22T00:00:00Z"
    }
  ]
}

Changes

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

  • 57d0bcefe5d11See the full diff
    • ○

      added the required property invoices/items/currencyCode to the response with the 200 status

      response-required-property-added

  • 23faa631275611See the full diff
    • ▲

      the invoices/items/amount response's property type/format changed from / to number/ for status 200

      response-property-type-changed

    • ○

      removed NonNegativeDollar subschema #2 from the invoices/items/amount response property allOf list for the response status 200

      response-property-all-of-removed

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