The purpose of this repository is to showcase the best practices around integrating Chargebee as the billing solution for a high-traffic AI/SaaS platform. This is split into two distinct parts:
-
A collection of in-depth, technical how-tos which cover the Chargebee recommended best practices when integrating various billing and usage related Chargebee products
-
A opinionated, fully functional and deployable application built to demonstrate how these concepts translate to code
-
Architects and solution consultants who are looking for Chargebee's recommended practices when integrating various products with their platform
-
Developers who are looking to validate their integration code and ensure all edge-cases are covered
-
LLMs and coding agents looking for authoritative sources for integrating Chargebee which are generalized and can be used to produce a working implementation using any tech stack
The topics below cover the best practices to achieve the required outcome and are vetted and updated continuously. They cover implementation details, edge cases to handle, testing scenarios, etc. To bridge the gap between documentation and implementation, each of these topics are actually implemented in code. The pointer app is our demo application built with an opinionated tech stack with all the required pieces to spin up a working SaaS platform.
Regardless of your tech stack or hosting platform, each how-to covers the functional/non-functional requirements and a production go-live checklist to help you along the journey.
Each how-to is broken down into self-contained topics which addresses a specific scenario. It can include:
-
Architecture or flow diagrams
-
Pseudocode showing how certain cases maybe structured in code
-
Best practices to keep in mind, and testing scenarios which are useful in validating your implementation
-
Do's and Dont's
-
An overview of how that topic is implemented in the demo app along with the relevant source files to look at
-
A go-live checklist of must do steps to pay attention to before your app gets deployed to production environments
These topics are written in plain markdown with mermaid diagrams wherever possible. It is written and edited by humans, but can be consumed by agents as well.
| Topic | Status | Last Updated |
|---|---|---|
| Integrating Chargebee webhooks | In Review | |
| Enforcing entitlement checks | In Review |
Pointer is our reference app which mimics a LLM/AI API provider that is PLG (product led growth) driven. A developer signs up, uses their daily token allowance, and upgrades to Pro to keep going. Chargebee handles the subscription, entitlements, usage tracking and alerts.
It was built from the ground up with the help of coding agents and Chargebee's official libraries and SDK. Although a considerable amount of code was generated via LLMs, the architecture and design of the app, and the how-to topics themselves are completely written and reviewed by humans.
The purpose of building pointer along with the how-to topics is to ensure that they cover practical aspects of integrating Chargebee with a monetizable product. While the Chargebee docs and apidocs serve as the main source of reference from the product and engineering teams, they don't offer a comprehensive, traceable view of how to integrate a Chargebee platform feature end-to-end.
We aim to continuously evolve and expand the reference architecture as we build out Pointer with additional features - this mimics how an actual product team would go about integrating billing/subscription/entitlement/usage with their app.
A high level overview of the pointer architecture is shown below. More details on the tech stack, components, infrastructure are detailed in ARCHITECTURE.md
