Chargebee List Invoices
chargebee_list_invoicesList invoices filtered by status (e.g., 'paid', 'pending') and/or customer ID. Returns invoice numbers, amounts, dates, and payment status. Paginate with limit and offset.
Example tool call
This call uses example arguments supplied in the tool’s input schema.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"_site": "mycompany",
"limit": 30,
"status": "paid",
"_apiKey": "your-chargebee-api-key"
},
"name": "chargebee_list_invoices"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _site | Yes | Chargebee site name | |
| limit | No | Number of results to return (default 10, max 100) | |
| offset | No | Pagination offset from a previous response | |
| status | No | Filter by invoice status: paid, posted, payment_due, not_paid, voided, pending | |
| _apiKey | Yes | Chargebee API key | |
| customer_id | No | Filter invoices by customer ID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| list | Yes | Array of invoice objects | |
| next_offset | No | Pagination offset for next page of results |