Endpoint:
Authorization
Example:Authorization | Bearer Paste-Your-API-Key-Here
Query Parameters
Customer email used to filter invoices. Required. When no customer matches the
email, the endpoint returns 404 Customer Not Found.
Number of items to return per page. Defaults to 10, with a maximum of 50.
Cursor for forward pagination. Pass the nextStartingAfter value from the
previous response (a Unix timestamp in milliseconds, as a string) to fetch the
next page.
Filter invoices by status (e.g. active, paid, closed).
Filter invoices by keyword.
Response
Successful Response
Main Structure (Root)
Status message that describes the status code.
List of invoices displayed.
Information on whether there is additional data to be retrieved (true/false).
Cursor to pass as startingAfter to fetch the next page. null when there is
no further data.
data Structure (Array Of Object)
Invoice price or nominal value.
Product category, can be null if there is no category.
Invoice creation time in epoch milliseconds format.
Product type (always invoice for this endpoint).
Invoice status (e.g. paid, closed, active).
Redirect destination URL, can be null.
The customer ID associated with this invoice.
List of invoice related transactions.
Details of the customer associated with this invoice.
transactions Structure (Array Of Object)
Transaction status (example: created, paid).
Additional custom data attached to the transaction, can be null.
customer Structure (Object)
Customer’s email address.
Customer’s mobile phone number.
Errors
Returned when no customer matches the provided email:
{ "statusCode": 404, "messages": "Customer Not Found" }.