Get Detailed Invoices

GET

https://app.unleash-instance.example.com/api/admin/invoices/list

GET

/api/admin/invoices/list

1 curl https://app.unleash-instance.example.com/api/admin/invoices/list \
2      -H "Authorization: <apiKey>"

Try it

200Retrieved

1 {
2   "invoices": [
3     {
4       "invoiceDate": "2025-11-01T00:00:00.000Z",
5       "status": "upcoming",
6       "totalAmount": 80,
7       "subtotal": 70,
8       "currency": "usd",
9       "taxAmount": 10,
10       "taxPercentage": 10,
11       "monthText": "November 2025",
12       "mainLines": [
13         {
14           "description": "1 x Unleash PAYG Seat (at $75.00 / month)",
15           "quantity": 1,
16           "currency": "usd",
17           "lookupKey": "auth_app_payg_seat",
18           "totalAmount": 7500,
19           "startDate": "2025-11-01T00:00:00.000Z",
20           "endDate": "2025-11-30T23:59:59.999Z",
21           "limit": 5,
22           "consumption": 0,
23           "unitPrice": 0.05
24         }
25       ],
26       "usageLines": [
27         {
28           "description": "1 x Unleash PAYG Seat (at $75.00 / month)",
29           "quantity": 1,
30           "currency": "usd",
31           "lookupKey": "auth_app_payg_seat",
32           "totalAmount": 7500,
33           "startDate": "2025-11-01T00:00:00.000Z",
34           "endDate": "2025-11-30T23:59:59.999Z",
35           "limit": 5,
36           "consumption": 0,
37           "unitPrice": 0.05
38         }
39       ],
40       "dueDate": "2025-11-13T00:00:00.000Z",
41       "invoiceURL": "https://invoice.stripe.com/i/acct_.../test_...?",
42       "invoicePDF": "https://pay.stripe.com/invoice/acct_.../test_.../pdf?s=ap"
43     }
44   ],
45   "planPrice": 50,
46   "planCurrency": "usd"
47 }

Enterprise feature

undefined

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Response

#/components/schemas/detailedInvoicesSchema

invoiceslist of objects

List of invoices with their line items

planPricedouble or null

The plan price

planCurrencystring or null

The currency code for the plan price