Chargebee
Read and manage Chargebee subscriptions, customers, invoices and plans.
Connect it with: API key. Chargebee's own documentation: https://apidocs.chargebee.com/docs/api/auth.
What agents can do
Connect Chargebee so the agents working your tasks can reach it. With it connected, they can:
- Look up a customer's subscription, plan, status and next billing date when a support task names them.
- List invoices, credit notes and unpaid balances to answer a billing question or build a revenue report.
- Pause, cancel or change a subscription's plan when a task asks for it (needs a Full-Access key).
- Check that a plan, add-on or coupon exists with the right price before a release that relies on it.
Before you start
- A Chargebee site, test or live, and a user who can open Settings > Configure Chargebee > API Keys and Events (an Admin or Owner role).
- Decide whether agents only read (Read-Only key) or also change billing (Full-Access key): the key's type is the limit, Jaah adds none.
- A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.
Connect with Chargebee
Jaah connects to Chargebee with an API key, not with a sign-in button.
Connect with an API key
Find each value first:
- Site name: The first part of your Chargebee address: for https://acme-test.chargebee.com it is acme-test. A test site and a live site are separate sites with separate keys.
- API key: In Chargebee, open Settings > Configure Chargebee > API Keys and Events > API Keys and select + Add API Key. Choose Read-Only Key > All for agents that only report, or Full-Access Key when they must change subscriptions, name it Jaah and select Create Key.
Then add it to Jaah:
- In Jaah, open Secrets, select New, and pick the Chargebee card.
- Name the secret and choose who can use it.
- Fill in Site name, API key.
- Select Save. Jaah tests the secret straight away (see Test the connection).
Jaah encrypts what you type and never shows it again — not to you, and not to an admin.
Use your own OAuth app
Not used: Jaah connects to Chargebee with an API key, not through an OAuth app.
Test the connection
Select Test on the secret. Jaah calls Chargebee's API once (GET https://<Site name>.chargebee.com/api/v2/subscriptions?limit=1) with the stored values, and shows whether Chargebee accepted it, or which value Chargebee refused and the status it answered. Jaah also tests automatically when you save or reconnect.
The last result and its time stay on the secret's page, so you can see whether it still works without testing again.
Who can use it
Every secret has an owner, and the owner decides who can use it:
- Personal — only your own tasks can use it. This is the default.
- Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
- Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.
More on owners and access: How secrets work.
Use it in an agent session
An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:
org/<name>for an organization secret,projects/<project>/<name>for one attached to a project,me/<name>for your personal one.
A key connection hands the agent its fields: site, api_key.
Tell the agent in your task description which secret to use, for example “use the Chargebee secret org/chargebee”.
Manage, rotate or disconnect
Everything is on the secret's page under Secrets:
- Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at Chargebee once the test passes. Steps: Replace or delete a secret.
- Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Chargebee's side too, revoke or delete the key at Chargebee.
Limitations
- One secret reaches one Chargebee site. A test site and a live site need one secret each.
- Chargebee limits API calls per site per minute (lower on test sites); an agent that loops over thousands of records is slowed down, not refused for good.
- A Restricted Read-Only key can read only the data groups ticked when it was created, so some reads fail with 401 even though Test passes.
- Agents can do only what the connected Chargebee account allows.
Troubleshooting
Test says Chargebee rejected the API key (401)
The key belongs to another site (often the test key used on the live site, or the reverse), was deleted, or was mistyped. Check Site name matches the key's site, create a new key in Settings > Configure Chargebee > API Keys and Events and select Replace.
Test says Chargebee cannot be reached at that address
Site name must be only the first part of the address, such as acme-test, with no https:// and no .chargebee.com.
Test passes but an agent's change is refused with 401
The key is Read-Only. Create a Full-Access key and replace the stored one.
Still stuck? Select Test and read the result: it names the value Chargebee refused and the status it answered.
FAQ
Which key type should I create?
Read-Only > All when agents only report on billing; Full-Access only when tasks must change subscriptions or customers. You can replace the key later without changing anything else.
Does Test change anything in Chargebee?
No. It reads one page of at most one subscription and discards it.
Can Jaah or an admin see the key or token?
No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.
Can I connect more than one Chargebee account?
Yes. Add one secret per account, each with its own name, and tell the agent which one to use.