chargebee_list_customers
List Chargebee customers with pagination, include deleted records, and filter by fields such as email, company, or creation date.
Instructions
List customers (companies).
API: GET /customers
Args:
limit: Max results per page (1-100, default 10).
offset: Pagination cursor from a previous response's next_offset.
include_deleted: Include deleted customers in the results.
filters: Optional Chargebee compound filter fields, passed through
as literal query keys, e.g. {"email[is]": "a@b.com",
"company[is]": "Acme", "created_at[after]": "1700000000"}.
Supported fields: id, first_name, last_name, email, company,
phone, auto_collection, taxability, created_at, updated_at,
offline_payment_method, auto_close_invoices, channel,
business_entity_id, relationship. Supported operators vary by
field type: [is], [is_not], [starts_with], [in], [not_in],
[between], [after], [before], [on], [none], [is_present].
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| filters | No | ||
| include_deleted | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |