List subscriptions

List subscriptions

Returns the subscriptions that match every filter you pass, such as status, customer or plan price, with plan and billing details.

Note: Pages hold 10 subscriptions 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

Note: {site} is your Chargebee site name, such as acme-test. CHARGEBEE_API_KEY holds the base64 of <api key>:, and test and live sites have different keys.

Before anything else, confirm access with the cheapest read-only call, like a list or a search. Never send or change anything to test access.

Rules

• Ask the user before anything that sends messages, costs money, or changes data, and say how many records it touches. One approval covers a batch the user has seen.
• Never print API keys.