Get a list of invoices
Requires the INVOICE.VIEW permission.
Authentication
X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
version
version
Headers
x-platform-id
Platform ID.
Query parameters
customer_id
Filter based of customer ID
statuses[]
Filter invoices based on invoice status(es)
invoice_date
Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
paid
Filter invoices based on whether they’re paid or not (true or false)
on_hold
Filter invoices based on whether they’re on hold or not (true or false)
pricing_plan_subscription_id
Filter invoices by the pricing plan subscription id
include_periods
Indicates whether the response should include period and group data (true or false)
include_lines
Indicates whether the response should include invoice lines (true or false)
limit
The amount of records shown in the list
page
The page which is going to be shown
order_by
The parameter by which the response is ordered.
order_direction
The order direction by which the response is ordered.
Response
OK
data
page
limit
links
total_number_of_pagesDeprecated
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error