Skip to main content
Endpoint:

Authorization

string
required
Example:Authorization | Bearer Paste-Your-API-Key-Here

Query Parameter

string
required
Sorting data results from invoice status.
  • active
  • paid
  • close

Response

Successful Response

Main Structure (Root)

integer
Status code form API.
string
Status message that describes the status code.
boolean
Information on whether there is additional data to be retrieved (true/false).
integer
Total number of data pages.
integer
Number of items per page.
integer
The page currently displayed.
array of object
List of invoices displayed.

data Structure (Array Of Object)

string<uuid>
Unique invoice ID.
integer
Invoice price or nominal value.
string | null
Product category, can be null if there is no category.
number | timestamp
Product creation time in epoch milliseconds format.
string
Product description.
Product slug/short URL.
string
Product type.
string
Product status.
string
Product name.
string | null
Redirect destination URL, can be null.
string<uuid>
The customer ID associated with this invoice.
array of object
List of invoice related transactions.
array of object
Details of the customer who paid the invoice.

transactions Structure (Array Of Object)

string <uuid>
Unique transaction ID.
string
required
Transaction status (example: “created”, “paid”).

customer Structure (Array Of Object)

string <uuid>
Unique customer ID.
string
Customer’s email address.
string
Customer’s mobile phone number.
string
Customer’s name.