Cby 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.
Description
Filter with `email[is]`, `first_name[is]`, `last_name[is]` or `company[is]`. Pass the returned customer `id` as `customer_id[is]` when listing subscriptions or invoices to see what they pay.
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.
Filter with email[is], first_name[is], last_name[is] or company[is].
Pass the returned customer id as customer_id[is] when listing
subscriptions or invoices to see what they pay.
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
Before doing anything else, make one read-only call to confirm access.
Rules
- Ask the user before anything that sends messages, costs money, or changes data.
- Never print API keys.
Built from these files in the repository
The layout and the rules come from lib/catalog/render-markdown.ts, the set-up wording from lib/catalog/render-access.ts.
Ways in
| Route | Source | Call | Required | Docs |
|---|---|---|---|---|
| Official | GET /customers | API key in $CHARGEBEE_API_KEY | Docs |