New in Chargebee: Explore Reveal and understand your payment performance end-to-end.
chargebee docs

Chargebee CLI

The Chargebee CLI helps you build integrations and automate billing workflows from your terminal. Query and export billing data, test webhooks locally, and generate SDK code samples. Use the same commands in scripts and with your AI coding agent.

Install the Chargebee CLI

Use PowerShell on Windows. npm requires Node.js 22.12.0 or later.

curl -fsSL https://raw.githubusercontent.com/chargebee/cli/main/install.sh | bash

See Installation details for setup verification, upgrades, and uninstalling.

Connect the CLI to a Chargebee site

Get an API key for a test site from the Chargebee dashboard: Settings > Configure Chargebee > API Keys. Then run:

chargebee auth add

The CLI prompts for connection details, verifies your credentials, and saves an active profile.

To work with multiple sites or supply credentials in scripts, see Configuration.

Run your first CLI commands

List customers on your connected site:

chargebee customer list

See Commands for request parameters, filters, and output options.

Send feedback about the CLI

Send a bug report or a suggestion from the terminal:

chargebee feedback "list filters are hard to find"
chargebee feedback "list filters are hard to find" --email you@example.com

Add --email for a reply.

Along with your message, the CLI sends its version and, when available, the site name from environment-variable credentials or the active profile. It never sends your API key.

CLI resources