| chargebee_list_customersA | 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].
|
| chargebee_create_customerA | Create a customer (company). API: POST /customers
Args:
first_name: Customer's first name.
last_name: Customer's last name.
email: Customer's email address.
company: Company name.
phone: Phone number.
id: Optional custom customer ID (auto-generated if omitted).
auto_collection: "on" or "off" — whether invoices are auto-collected.
taxability: "taxable" or "exempt".
locale: Customer's locale (e.g. "en", "fr-CA").
meta_data: Arbitrary key-value metadata dict.
billing_address: Billing address fields, e.g. {"line1": "...",
"city": "...", "state": "...", "zip": "...", "country": "US"}.
|
| chargebee_retrieve_customerA | Retrieve a customer (company) by ID. API: GET /customers/{customer-id}
Args:
customer_id: The customer's unique ID.
|
| chargebee_update_customerA | Update a customer (company). API: POST /customers/{customer-id}
Args:
customer_id: The customer's unique ID.
first_name: Customer's first name.
last_name: Customer's last name.
email: Customer's email address.
company: Company name.
phone: Phone number.
auto_collection: "on" or "off".
taxability: "taxable" or "exempt".
locale: Customer's locale.
invoice_notes: Default notes shown on the customer's invoices.
meta_data: Arbitrary key-value metadata dict.
|
| chargebee_list_customer_contactsA | List the contacts (personnel) associated with a customer (company). API: GET /customers/{customer-id}/contacts
Args:
customer_id: The customer's unique ID.
limit: Max results per page (1-100, default 10).
offset: Pagination cursor from a previous response's next_offset.
|
| chargebee_list_subscriptionsA | List subscriptions (accounts). API: GET /subscriptions
Args:
limit: Max results per page (1-100, default 10).
offset: Pagination cursor from a previous response's next_offset.
include_deleted: Include deleted subscriptions in the results.
filters: Optional Chargebee compound filter fields, passed through
as literal query keys, e.g. {"customer_id[is]": "cus123",
"status[in]": "[\"active\",\"non_renewing\"]"}. Supported
fields: id, customer_id, item_id, item_price_id, status,
cancel_reason, cancel_reason_code, remaining_billing_cycles,
created_at, activated_at, next_billing_at, cancelled_at,
has_scheduled_changes, updated_at, offline_payment_method,
auto_close_invoices, override_relationship,
business_entity_id, channel, decommissioned. Supported
operators vary by field type: [is], [is_not], [in], [not_in],
[between], [after], [before], [on], [none], [is_present].
|
| chargebee_retrieve_subscriptionA | Retrieve a subscription (account) by ID. API: GET /subscriptions/{subscription-id}
Args:
subscription_id: The subscription's unique ID.
|
| chargebee_cancel_subscriptionA | Cancel a subscription (account). API: POST /subscriptions/{subscription-id}/cancel_for_items
Args:
subscription_id: The subscription's unique ID.
cancel_option: "immediately", "end_of_term", or "specific_date".
end_of_term: Shorthand for cancel_option="end_of_term" (legacy field, kept for compatibility).
cancel_at: Unix timestamp (seconds) — required when cancel_option="specific_date".
cancel_reason_code: A reason code configured in your Chargebee site for this cancellation.
credit_option_for_current_term_charges: "prorate", "full", or "none" —
how to credit unused charges for the current term.
unbilled_charges_option: "invoice", "delete", or "carry_forward" — how
to handle unbilled usage charges.
|
| chargebee_list_invoicesA | List invoices. API: GET /invoices
Args:
limit: Max results per page (1-100, default 10).
offset: Pagination cursor from a previous response's next_offset.
include_deleted: Include deleted invoices in the results.
filters: Optional Chargebee compound filter fields, passed through
as literal query keys, e.g. {"customer_id[is]": "cus123",
"status[in]": "[\"paid\",\"payment_due\"]",
"date[after]": "1700000000"}. Supported fields: id,
subscription_id, customer_id, recurring, status, price_type,
date, paid_at, total, amount_paid, amount_adjusted,
credits_applied, amount_due, dunning_status, payment_owner,
updated_at, channel, voided_at, void_reason_code, exclude,
einvoice. Supported operators vary by field type: [is],
[is_not], [in], [not_in], [between], [after], [before], [on],
[none], [is_present].
|
| chargebee_list_transactionsA | List payment/refund transactions. API: GET /transactions
Args:
limit: Max results per page (1-100, default 10).
offset: Pagination cursor from a previous response's next_offset.
include_deleted: Include deleted transactions in the results.
filters: Optional Chargebee compound filter fields, passed through
as literal query keys, e.g. {"customer_id[is]": "cus123",
"type[is]": "payment", "date[after]": "1700000000"}. Supported
fields: id, customer_id, subscription_id, payment_source_id,
payment_method, gateway, gateway_account_id, id_at_gateway,
reference_number, type, date, amount, amount_capturable,
status, updated_at. Supported operators vary by field type:
[is], [is_not], [in], [not_in], [between], [after], [before],
[on], [none], [is_present].
|
