payments
Chargebee CLI for CI
Use the Chargebee CLI for CI with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 7 read 0 write Bearer token auth
Chargebee CLI for CI
Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status.
Use this shape when a pipeline needs to read or update an external service. The Chargebee CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Chargebee CLI for CI
kosmokrator integrations:configure chargebee --set access_token="$CHARGEBEE_ACCESS_TOKEN" --set site_name="$CHARGEBEE_SITE_NAME" --enable --read allow --write ask --json
kosmo integrations:call chargebee.chargebee_list_subscriptions '{"limit":1,"page":"example_page","state":"example_state"}' --json Discovery Before Execution
Agents and scripts can inspect Chargebee docs and schemas before choosing a function.
kosmo integrations:docs chargebee --json
kosmo integrations:docs chargebee.chargebee_list_subscriptions --json
kosmo integrations:schema chargebee.chargebee_list_subscriptions --json
kosmo integrations:search "Chargebee" --json
kosmo integrations:list --json Useful Chargebee CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
chargebee.chargebee_list_subscriptions | Read | limit, page, state | 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. |
chargebee.chargebee_get_subscription | Read | id | Retrieve detailed information about a specific Chargebee subscription by its ID, including plan details, billing period, status, and associated customer. |
chargebee.chargebee_list_customers | Read | limit, page | List customers from Chargebee with pagination. Returns customer details including email, name, company, and billing address. |
chargebee.chargebee_get_customer | Read | id | Retrieve detailed information about a specific Chargebee customer by their ID, including contact details, billing address, and payment method. |
chargebee.chargebee_list_invoices | Read | limit, page, status | List invoices from Chargebee. Supports filtering by status (paid, posted, payment_due, not_paid, voided, pending) and pagination. |
chargebee.chargebee_get_invoice | Read | id | Retrieve detailed information about a specific Chargebee invoice by its ID, including line items, totals, tax, and payment status. |
chargebee.chargebee_get_current_user | Read | none | Retrieve the current authenticated user information from Chargebee. Use this to verify credentials are working and check user details. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.