List invoices

GET

/v1/invoices

GET

/v1/invoices

1 import { AfternoonClient } from "afternoon-sdk";
2 
3 async function main() {
4     const client = new AfternoonClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.invoices.list({});
8 }
9 main();

1 {
2   "success": true,
3   "invoices": [
4     {
5       "id": "cm5x9z8nv0000h85r7l9p2k1m",
6       "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
7       "status": "draft",
8       "currency": "usd",
9       "collection_method": "send_invoice",
10       "invoice_number": "INV-0001",
11       "public_invoice_url": "https://pay.afternoon.co/inv/abc123",
12       "subtotal_cents": 0,
13       "discount_cents": 0,
14       "tax_cents": 0,
15       "total_cents": 0,
16       "line_items": [
17         {
18           "id": "cm5x9z8nv0000h85r7l9p2k1m",
19           "description": "API calls — Feb 2024",
20           "quantity": 1,
21           "unit_amount_cents": 5000,
22           "tax_amount_cents": 0,
23           "total_amount_cents": 5000,
24           "created_at": "2024-01-15T10:30:00.000Z",
25           "updated_at": "2024-01-15T10:30:00.000Z"
26         }
27       ],
28       "created_at": "2024-01-15T10:30:00.000Z",
29       "updated_at": "2024-01-15T10:30:00.000Z"
30     }
31   ],
32   "pagination": {
33     "has_more": true,
34     "next_cursor": "cm5x9z8nv0000h85r7l9p2k1m"
35   },
36   "request_id": "req_abc123"
37 }

Returns a paginated list of invoices. Supports optional customer_id, and status filters.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Query parameters

limitstringOptionalDefaults to 50

cursorstringOptional

customer_idstringOptional

statusenumOptional

Filter by invoice status

Allowed values:

Response

Invoices list

successboolean

invoiceslist of objects

paginationobject

request_idstring

Errors

401

Unauthorized Error

500

Internal Server Error