`chargebee_list_invoices`

Pack: chargebee · Endpoint: https://gateway.pipeworx.io/chargebee/mcp

List 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.

Parameters

Name	Type	Required	Description
`_apiKey`	string	yes	Chargebee API key
`_site`	string	yes	Chargebee site name
`status`	string	no	Filter by invoice status: paid, posted, payment_due, not_paid, voided, pending
`customer_id`	string	no	Filter invoices by customer ID
`limit`	number	no	Number of results to return (default 10, max 100)
`offset`	string	no	Pagination offset from a previous response

Example call

Arguments

{
  "_apiKey": "your-chargebee-api-key",
  "_site": "mycompany",
  "status": "paid",
  "limit": 30
}

curl

curl -X POST https://gateway.pipeworx.io/chargebee/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"chargebee_list_invoices","arguments":{"_apiKey":"your-chargebee-api-key","_site":"mycompany","status":"paid","limit":30}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('chargebee_list_invoices', {
  "_apiKey": "your-chargebee-api-key",
  "_site": "mycompany",
  "status": "paid",
  "limit": 30
});

More examples

{
  "_apiKey": "your-chargebee-api-key",
  "_site": "mycompany",
  "customer_id": "cust_00123456789",
  "status": "payment_due",
  "limit": 20
}

Response shape

Always returns: list

Field	Type	Description
`list`	array	Array of invoice objects
`next_offset`	string	Pagination offset for next page of results

Full JSON Schema

{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "description": "Array of invoice objects",
      "items": {
        "type": "object",
        "properties": {
          "invoice": {
            "type": "object",
            "description": "Invoice details"
          }
        }
      }
    },
    "next_offset": {
      "type": "string",
      "description": "Pagination offset for next page of results"
    }
  },
  "required": [
    "list"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "chargebee": {
      "url": "https://gateway.pipeworx.io/chargebee/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

chargebee_list_invoices