chargebee_list_subscriptions
Retrieve subscriptions from Chargebee with optional filters, pagination, and inclusion of deleted records. Use to fetch matching subscription data via the Chargebee REST API.
Instructions
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].
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 |