Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.

Setup

  1. Create a Chargebee account: Sign up at https://www.chargebee.com. A test site (e.g. acme-test.chargebee.com) is created automatically when you sign up - use it for development before switching to your live site.
  2. Create an API key: In the Chargebee app go to Settings → Configure Chargebee → API Keys and Webhooks → API Keys, click Add an API Key, choose Full-Access Key, and copy the generated key.
  3. Set environment variables: Add CHARGEBEE_API_KEY (the key from step 2) and CHARGEBEE_SITE (your site subdomain, e.g. acme-test) to your .env. Leave CHARGEBEE_API_PASSWORD unset or empty - Chargebee uses the API key as the HTTP Basic username with an empty password.
  4. Verify access: Run List Subscriptions with site set to your CHARGEBEE_SITE value. All requests go to https://{site}.chargebee.com/api/v2 over HTTPS.
  • API keys are environment-specific: your test site and live site have separate keys and separate site subdomains.
  • Chargebee filters use bracket operators in query parameter names, e.g. status[is]=active or email[is]=[email protected].
  • List endpoints paginate with an opaque next_offset string - pass it back as the offset parameter to fetch the next page.
Provider API reference: https://apidocs.chargebee.com/docs/api

Tools

Example prompts

  • List my active Chargebee subscriptions and summarize them by plan.
  • Show Chargebee invoices with status payment_due or not_paid and which customers they belong to.
  • Look up a Chargebee customer by email and show their subscriptions and recent invoices.