All tools
C
by Chargebee
List customers
Returns customers on your Chargebee site, filtered by email, name or company, to find the billing record for a person or account.
Updated Sep 27, 2026
list-customers.md
List customers
Returns customers on your Chargebee site, filtered by email, name or company, to find the billing record for a person or account.
Set up
Use the first option your agent supports.
API (official)
- Base URL: https://{site}.chargebee.com/api/v2
- Endpoint:
GET /customers - Auth: send the header
Authorization: Basic $CHARGEBEE_API_KEY - Docs: https://apidocs.chargebee.com/docs/api
Note: {site} is your Chargebee site name, such as acme-test. CHARGEBEE_API_KEY holds the base64 of <api key>:, and test and live sites have different keys.
Before anything else, confirm access with the cheapest read-only call, like a list or a search. Never send or change anything to test access.
Rules
- Ask the user before anything that sends messages, costs money, or changes data, and say how many records it touches. One approval covers a batch the user has seen.
- Never print API keys.
Ways in
| Route | Source | Call | Required | Docs |
|---|---|---|---|---|
| Official | GET /customers | API key in $CHARGEBEE_API_KEY | Docs |
Workflows using List customers
No workflows yet
No published workflow uses List customers yet.