Use the Chargebee CLI from KosmoKrator to call Chargebee tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.
Chargebee can be configured headlessly with `kosmokrator integrations:configure chargebee`.
# Install KosmoKrator first if it is not available on PATH.curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash# Configure and verify this integration.kosmokrator integrations:configure chargebee --set access_token="$CHARGEBEE_ACCESS_TOKEN" --set site_name="$CHARGEBEE_SITE_NAME" --enable --read allow --write ask --jsonkosmokrator integrations:doctor chargebee --jsonkosmokrator integrations:status --json
Credentials
Authentication type: Bearer tokenbearer_token. Configure credentials once, then use the same stored profile from
scripts, coding CLIs, Lua code mode, and the MCP gateway.
Key
Env var
Type
Required
Label
access_token
CHARGEBEE_ACCESS_TOKEN
Secret secret
yes
Access Token
site_name
CHARGEBEE_SITE_NAME
Text string
yes
Site Name
Call Chargebee Headlessly
Use the generic call form when another coding CLI or script needs a stable universal interface.
Every function below can be called headlessly. The generic form is stable across all integrations;
the provider shortcut is shorter but specific to Chargebee.
chargebee.chargebee_list_subscriptions
Read read
List subscriptions from Chargebee. Supports filtering by state (active, cancelled, non_renewing, paused, in_trial, future) and pagination. Returns subscription details including plan, status, and billing period.
Retrieve detailed information about a specific Chargebee subscription by its ID, including plan details, billing period, status, and associated customer.
Use these parameter tables when building CLI payloads without calling integrations:schema first.
chargebee.chargebee_list_subscriptions
List subscriptions from Chargebee. Supports filtering by state (active, cancelled, non_renewing, paused, in_trial, future) and pagination. Returns subscription details including plan, status, and billing period.
Number of subscriptions to return per page (max 100, default 10).
page
string
no
Pagination cursor — pass the value from a previous response to get the next page.
state
string
no
Filter by subscription state: active, cancelled, non_renewing, paused, in_trial, future.
chargebee.chargebee_get_subscription
Retrieve detailed information about a specific Chargebee subscription by its ID, including plan details, billing period, status, and associated customer.
Headless calls still follow the integration read/write permission policy. Configure read/write defaults
with integrations:configure. Add --force only for trusted automation that should bypass that policy.