Invoices
List Invoices
List invoices for the merchant with pagination. Includes PDF availability and any tax line item descriptions extracted from stored tax line items.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Query Parameters
customerId?string
Filter by customer ID (must belong to your merchant).
Match
^cus_[A-Za-z0-9]{22}$status?string
Filter by invoice status. Draft invoices are editable; issued invoices have numbers assigned.
Value in
"draft" | "issued" | "paid" | "unpaid" | "void" | "uncollectible"limit?integer
Maximum number of invoices to return. Defaults to 20.
Default
20Range
1 <= value <= 200offset?integer
Number of records to skip for pagination.
Default
0Range
0 <= valueResponse Body
application/json
application/json
curl -X GET "https://api.getlumen.dev/v1/invoices"{
"invoices": [
{
"id": "inv_c9MBd7QfJH5s2r4aLvXK",
"customerId": "cus_Lo4xGg1Yk9pB2eWv3sNt",
"status": "issued",
"totalAmountCents": 12900,
"currency": "USD",
"hasPdf": true,
"taxLineItemDescriptions": [
"Tax (8.75%)"
],
"customerInvoiceNumber": "LO4XGG-001",
"createdAt": "2025-02-20T17:00:00.000Z"
}
],
"pagination": {
"total": 37,
"limit": 20,
"offset": 0
}
}{
"error": "Failed to fetch invoices"
}