API Explorer
The API Explorer is an interactive tool for testing Chargebee APIs. It has three components:
- AI Chat: Describe what you want to build and get recommended API endpoints with code examples.
- API Playground: Test API requests against your test site and generate code samples in multiple languages.
- Event Explorer: Browse and inspect webhook events in real time.
Note
The API Explorer connects only to your test site. Use a test environment when you experiment to avoid affecting production data.
Get started
- Go to api-explorer.chargebee.com.
- Select Login and sign in with your Chargebee Billing credentials.
- If you have multiple Billing sites, select the site you want to work with from the menu.
You can now use AI Chat, API Playground, and Event Explorer with the data from your selected site.
AI Chat
Use the Endpoint Explorer tab to ask questions in natural language and get API implementation recommendations. AI Chat recommends endpoints, explains implementation steps, and provides code examples.
Example queries
- "How do I create a subscription with a trial period?"
- "Show me how to retrieve unpaid invoices for a customer."
- "What's the best way to handle subscription upgrades?"
API Playground
Use the API Playground tab to test API requests against your Chargebee site and generate code samples in multiple languages.
- Browse API endpoints and their parameters.
- Browse pre-built examples for common API operations.
- Enter API request arguments in a form with real-time validation.
- Run API requests and view formatted responses.
- Generate API request code in multiple languages.
- Export API requests as Postman collections.
- Generate shareable links to collaborate on API requests.
Supported languages
The API Playground generates request samples in the following languages.
| Language | SDK Versions |
|---|---|
| cURL | - |
| Node.js | v2, v3 |
| Python | v2, v3 |
| PHP | v3, v4 |
| Ruby | - |
| Java | v3, v4 |
| .NET | - |
| Go | v3, v4 |
Event Explorer
Use the Events tab to browse real-time webhook events from your Chargebee site, understand payload structures, and debug integrations.
Was this article helpful?