Retrieve an invoice

GET

/v1/invoices/:id

GET

/v1/invoices/:id

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.get("cm5x9z8nv0000h85r7l9p2k1m");
8 }
9 main();

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

Fetches an invoice by its ID, including line items.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Path parameters

idstringRequiredformat: "cuid"

Response

Invoice found

successboolean

invoiceobject

request_idstring

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error