DOCSEARCHbyAlgolia
Submit Docs

Chargebee Documentation

website·Indexed 43 days ago

https://apidocs.chargebee.com

A subscription billing and revenue management platform. Documentation covers the Chargebee API for managing customers, subscriptions, invoices, and usage events, as well as specialized modules including Chargebee CPQ for quote-to-revenue, RevRec for revenue recognition, Chargebee Retention, and Chargebee Receivables for AR management.

Tokens
881.3K
Snippets
2.4K
Records
5.2K
Agent score
64%

What's inside Chargebee

  1. Overview of Chargebee MCP Servers

    Chargebee Model Context Protocol (MCP) servers allow AI clients (such as Cursor, Claude, ChatGPT, and Codex) to connect to Chargebee systems using standardized tools and structured context. This enables AI agents to securely access Chargebee data, workflows, and product knowledge. Users are responsible for all actions performed by AI clients, including write operations; it is recommended to use only trusted clients and review actions before execution.

  2. Overview of Chargebee Receivables Reports

    Chargebee Receivables provides reports to analyze accounts receivable (AR) data, team performance, and collections. Reports are categorized into three main types:

    • AR Reports: Focus on financial data such as outstanding amounts, aging, and due dates.
    • Collection Activity Reports: Combine financial and CRM data, including promised-to-pay (PTP) amounts and issue amounts.
    • All Configured Reports: Custom reports created by the business based on specific requirements.

  4. Overview of Chargebee interaction methods

    Chargebee provides five primary ways to manage subscription billing and revenue:

    1. Web Interface: A browser-based application for manual configuration, product setup, and team management.
    2. REST API: An HTTP-based interface for programmatic control and application integration.
    3. Webhooks: Real-time event notifications (e.g., subscription activations, renewals, payments) to keep external systems in sync.
    4. Hosted Payment Pages: PCI-compliant, customizable pages for securely collecting customer subscription and payment information without custom development.
    5. Customer Portal: A self-service interface where customers can manage their own subscriptions and billing details to reduce support overhead.

  5. Overview of Chargebee Features API

    The Features API allows you to define the product features offered in your product line and manage the entitlements that items and subscriptions have toward those features. It serves as the source of truth for provisioning systems to determine subscription entitlements.

    Key Constraint: A single site can have a maximum of 400 features.

  6. Overview of Chargebee Offer Events

    Offer events are used to record and track user interactions with personalized offers. By logging specific events—such as when a user views or dismisses an offer—growth and analytics teams can measure offer effectiveness and optimize the offer funnel using real usage data.

  7. Overview of Chargebee Discounts

    A discount represents a deduction from the amounts in an invoice. Unlike coupons, which are typically customer-facing, discounts are applied directly to subscriptions by sales teams during negotiations or upgrades. Every discount in Chargebee is attached to exactly one subscription. Note that the combined total of line-item-level and invoice-level coupons for a subscription cannot exceed 10. Enabling discounts automatically activates the multi-coupons feature.

  8. Overview of Chargebee Billing and Retention integration features

    The native integration between Chargebee Retention and Chargebee Billing allows merchants to reduce voluntary churn through several core features:

    • Enrichment: Map fields from Chargebee subscription records to personalize user experiences and build custom targeting audiences.
    • Manage Offers: Automatically pause, discount, extend, or update a subscription in Chargebee Billing when a customer accepts a retention offer.
    • Manage Cancels: Directly cancel subscriptions in Chargebee Billing upon request, with options to include all active subscriptions on an account, invoice immediately for outstanding charges, or prorate the subscription.
    • Traffic Routing: Route canceling subscribers to Chargebee Retention pages via the Customer Portal, Chargebee Brightback.js, or the Retention API.
    • Save Validation & Attribution: Use Time-Based Attribution to confirm a subscription remains valid after a 'Save' event and calculate retained revenue for dashboards.
    • Retained Revenue Impact: Pull repurchase metrics from Chargebee Billing invoices to quantify the financial impact of retention efforts.

  9. Overview of Chargebee CPQ for Salesforce

    Chargebee CPQ integrates advanced quoting capabilities into Salesforce, allowing sales teams to generate quotes directly within the Salesforce interface. It leverages the Chargebee product catalog and pricing engine to ensure consistency between the quote and the billing system.

  11. Overview of Chargebee Copilot

    Chargebee Copilot is an AI assistant integrated within Chargebee Billing that allows users to answer questions and complete tasks using natural language. It is currently in public beta and available to all users regardless of their billing plan. Copilot's capabilities are determined by the skills enabled for the site and the access level configured for the specific user role. Note that AI-generated responses should be independently verified before taking critical business actions.

  12. Overview of Chargebee Usage Events

    Usage events are used for usage-based billing to track customer consumption and calculate charges. These events are decoupled from the product catalog (plans or addons), allowing independent tracking of feature consumption. Usage data is processed and associated with features, then used alongside entitlements, items, or item prices to generate invoices. Usage events can also be used for feature usage analytics and churn prediction.