Get invoice
One invoice with line items, payments and credits applied.
GET https://cotlet.dev/api/v1/chargebee/invoices/{invoice_id}
read
Returns the invoice status, the line items, the amount paid, the credits and adjustments applied and the amount still due, all in the smallest currency unit. Read it before creating a credit note: the status decides which credit note type Chargebee allows.
Parameters
| Name | Type | Description |
|---|---|---|
| invoice_id string required | string | Invoice ID from list_invoices, for example INV-1042. |
Request
curl https://cotlet.dev/api/v1/chargebee/invoices/invoice_8c41d2 \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("chargebee", "get_invoice", {"invoice_id":"invoice_8c41d2"})const result = await cotlet.call('chargebee', 'get_invoice', {"invoice_id":"invoice_8c41d2"});cotlet call chargebee get_invoice --data '{"invoice_id":"invoice_8c41d2"}'Example response
{
"invoice_id": "INV-1042",
"customer_id": "cus_9s2kQw",
"status": "paid",
"line_items": [
{
"description": "Growth plan, monthly",
"amount": 29900
}
],
"total": 29900,
"amount_paid": 29900,
"credits_applied": 0,
"amount_adjusted": 0,
"amount_due": 0,
"currency_code": "USD"
}