`chargebee_list_subscriptions`

Pack: chargebee · Endpoint: https://gateway.pipeworx.io/chargebee/mcp

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/chargebee_list_subscriptions for the schema, then POST the same URL with its arguments for the data.

List all subscriptions with optional filtering by status (e.g., ‘active’, ‘cancelled’). Returns subscription IDs, plans, amounts, and renewal dates. Paginate with limit and offset.

Parameters

Name	Type	Required	Description
`_apiKey`	string	yes	Chargebee API key
`_site`	string	yes	Chargebee site name (e.g., “mycompany” for mycompany.chargebee.com)
`status`	string	no	Filter by subscription status: active, cancelled, non_renewing, future, in_trial, paused
`limit`	number	no	Number of results to return (default 10, max 100)
`offset`	string	no	Pagination offset from a previous response

Example call

Arguments

{
  "_apiKey": "your-chargebee-api-key",
  "_site": "mycompany",
  "status": "active",
  "limit": 25
}

curl

curl -X POST https://gateway.pipeworx.io/chargebee/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"chargebee_list_subscriptions","arguments":{"_apiKey":"your-chargebee-api-key","_site":"mycompany","status":"active","limit":25}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('chargebee_list_subscriptions', {
  "_apiKey": "your-chargebee-api-key",
  "_site": "mycompany",
  "status": "active",
  "limit": 25
});

More examples

{
  "_apiKey": "your-chargebee-api-key",
  "_site": "mycompany",
  "status": "cancelled",
  "limit": 50,
  "offset": "eyJkaXJlY3Rpb24iOiJuZXh0IiwiY3Vyc29yIjoiMjAyMy0wMS0wMVQwMDowMDowMFoifQ=="
}

Response shape

Always returns: list

Field	Type	Description
`list`	array	Array of subscription objects
`next_offset`	string	Pagination offset for next page of results

Full JSON Schema

{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "description": "Array of subscription objects",
      "items": {
        "type": "object",
        "properties": {
          "subscription": {
            "type": "object",
            "description": "Subscription details"
          }
        }
      }
    },
    "next_offset": {
      "type": "string",
      "description": "Pagination offset for next page of results"
    }
  },
  "required": [
    "list"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "chargebee": {
      "url": "https://gateway.pipeworx.io/chargebee/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

chargebee_list_subscriptions