`chargebee_list_customers`

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

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/chargebee_list_customers for the schema, then POST the same URL with its arguments for the data.

List all customers with pagination. Returns customer IDs, names, emails, billing addresses, and creation dates.

Parameters

Name	Type	Required	Description
`_apiKey`	string	yes	Chargebee API key
`_site`	string	yes	Chargebee site name
`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",
  "limit": 50
}

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_customers","arguments":{"_apiKey":"your-chargebee-api-key","_site":"mycompany","limit":50}}}'

TypeScript (@pipeworx/sdk)

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

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

Response shape

Always returns: list

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

Full JSON Schema

{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "description": "Array of customer objects",
      "items": {
        "type": "object",
        "properties": {
          "customer": {
            "type": "object",
            "description": "Customer 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_customers