Invoices
List invoices
GET

/api/invoices/

X-API-KEY*
Authorization*
curl --request GET \
  --url https://api.uselotus.io/api/invoices/ \
  --header 'Authorization: <authorization>' \
  --header 'X-API-KEY: <x-api-key>'

Retrieves an array of invoice objects.

lotus.list_invoices(
    customer_id="cus_1234567890",
)

lotus.list_invoices(
    status=["unpaid"],
)

Authorizations

Authorization[header]required
string

Token-based authentication with required prefix "Token"

Query Parameters

customer_id
string

A filter for invoices for a specific customer

payment_statusDefault: ["paid"]
array

A filter for invoices with a specific payment status

Response

array