Cby Chargebee
List subscriptions
Returns the subscriptions that match every filter you pass, such as status, customer or plan price, with plan and billing details.
Description
Filter with `status[is]` (`future`, `in_trial`, `active`, `non_renewing`, `paused` or `cancelled`), `customer_id[is]` or `item_price_id[is]`. Pages hold 10 by default and up to 100 with `limit`; pass `next_offset` back as `offset` for the next page.
list-subscriptions.md
List subscriptions
Returns the subscriptions that match every filter you pass, such as status, customer or plan price, with plan and billing details.
Filter with status[is] (future, in_trial, active, non_renewing,
paused or cancelled), customer_id[is] or item_price_id[is]. Pages hold
10 by default and up to 100 with limit; pass next_offset back as offset
for the next page.
Set up
Use the first option your agent supports.
API (official)
- Base URL: https://{site}.chargebee.com/api/v2
- Endpoint:
GET /subscriptions - 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 /subscriptions | API key in $CHARGEBEE_API_KEY | Docs |