Chargebee Connection
The Chargebee connection integrates your Chargebee account with OpsTower, giving agents the ability to query subscriptions with MRR calculations, analyze invoices, search customers, review payment transactions, and inspect your pricing catalog. All operations are read-only.
Prerequisites
Section titled “Prerequisites”You need a Chargebee account with API access. Both live and test sites are supported. Chargebee uses site-specific subdomains — your live site is mycompany.chargebee.com and test site is typically mycompany-test.chargebee.com.
Credentials Required
Section titled “Credentials Required”To set up a Chargebee connection, you need:
- Site Subdomain — your Chargebee site name (e.g.,
mycompany, not the full URL) - API Key — a Chargebee read-only API key
How to Create a Chargebee API Key
Section titled “How to Create a Chargebee API Key”- In your Chargebee Dashboard, go to Settings > API Keys & Webhooks > API Keys.
- Click Generate Key.
- Set Type to Read-Only: Restricted.
- Check both Transactional Data and Product Catalog sub-scopes.
- Name it something like “OpsTower Read Only”.
- Copy the key and paste it into OpsTower.
For test mode, use your test site subdomain (typically mycompany-test).
Setup in OpsTower
Section titled “Setup in OpsTower”- Go to Connections > Payments > Add Connection.
- Select Chargebee.
- Enter your Site Subdomain and API Key.
- Click Test Connection to verify the credentials.
- Click Save.
What Agents Can Do
Section titled “What Agents Can Do”Once connected, agents have access to five tools:
- Query Subscriptions — list subscriptions by status (active, cancelled, in_trial, non_renewing, paused, future) with MRR calculation using Chargebee’s native MRR field
- Query Invoices — search invoices by status (paid, posted, payment_due, not_paid, voided, pending) and date range
- Query Customers — search customers by email or company name with balance information
- Query Transactions — search payment transactions and refunds with payment method and gateway details
- Query Item Prices — browse the pricing catalog (plans, addons, charges) with billing cycles and pricing models. Automatically falls back to the legacy Plan model for older Chargebee sites.
Use Cases
Section titled “Use Cases”- “What’s our current MRR from active Chargebee subscriptions?”
- “Show me all failed transactions this week”
- “How many customers are currently in trial?”
- “What invoices are overdue right now?”
- “List our pricing plans and their billing cycles”
Troubleshooting
Section titled “Troubleshooting”- 401 Unauthorized — verify your API key is correct and has not been revoked
- 404 on item prices — your site may use the legacy Plan model; the tool automatically falls back to the
/plansendpoint - Rate limiting — Chargebee allows 150-750 requests per minute depending on your plan; each tool call uses a single request