New in Chargebee: Explore Reveal and understand your payment performance end-to-end.Try Now
Docschargebee docs
HomeBillingPaymentsRevRecGrowthReveal
Support

Product Updates


  • Release Notes

Getting Started


  • Overview
  • Chargebee Billing Data Centers
  • Object Relationship Model
  • Understanding Sites
  • Chargebee Tech Glossary
  • Articles and FAQ

Implementing Chargebee


  • Implementation Guide
  • Go-live Checklist
  • Articles and FAQ

AI in Chargebee


  • Chargebee Copilot
  • Chargebee Model Context Protocol (MCP) Server

Developer Resources


  • Developer Resources Overview
  • Articles and FAQ

Product Catalog


  • Product Catalog Overview
  • Coupons
  • Articles and FAQ

Subscriptions


  • Working with Subscriptions
  • Billing
  • Orders
  • Articles and FAQ

Customers


  • Managing Customers
  • Account Hierarchy
  • Email Notifications
  • Branding
  • Configure Multiple Languages
  • Articles and FAQ

Entitlements


  • Entitlements Overview
  • Features Overview
  • Feature Management
  • Managing Product Entitlements
  • Subscription Entitlements
  • Customer Entitlements
  • Grandfathering Entitlements
  • Articles and FAQ

Usage Based Billing


  • Understanding Usages
  • Setting up Usage Based Billing
  • Usage Alerts
  • Metered Billing
  • Articles and FAQ

Chargebee CPQ


  • Chargebee CPQ
  • Chargebee CPQ for Salesforce
  • Chargebee CPQ for HubSpot

Invoices, Credit Notes, and Quotes


  • Invoices
  • Credit Notes
  • Quotes [Legacy]
  • Transactions
  • Articles and FAQ

Taxes


  • Overview
  • Configuring Taxes
  • Country-specific Taxes
  • Articles and FAQ

Hosted Capabilities


  • Overview
  • Hosted Checkout
  • Hosted Self-Serve Portal
  • Hosted Pages Features
  • Additional Hosted Pages
  • Payment Components
  • Pricing Table
  • Managing Payments with Chargebee.js
  • Mobile-Optimized Hosted Pages
  • Articles and FAQ

Site Configuration


  • Users & Roles
  • Custom Fields & Metadata
  • Approvals
  • Mandatory Fields
  • File Attachments & Comments
  • Advanced Filter Options
  • Multicurrency Pricing
  • Multi-decimal Support
  • Configuring Reason Codes
  • Events and Webhooks
  • API Keys
  • Time Zone
  • Time Machine
  • Transfer Configurations
  • Articles and FAQ

Multi Business Entity


  • Multi Business Entity Overview
  • Customer Transfer Overview
  • Articles and FAQ

Mobile Subscriptions


  • Overview
  • Omnichannel Subscriptions
  • Omnichannel One-Time Orders
  • Mobile Subscriptions (Legacy)

Reports and Analytics


  • RevenueStory
  • Home Dashboard
  • Frequently Asked Questions
  • FAQs for Classic Reports Sunset
  • Articles and FAQ

Integrations


  • Sales
  • Customer Support and Success
  • Finance
  • Tax
  • eInvoicing
  • Marketing
  • Stitch
  • Collaboration
  • Contract Management
  • Ecommerce Management
  • Articles and FAQ

Data Privacy & Security


  • Two Factor Authentication
  • SAML Single Sign-On
  • System for Cross-Domain Identity Management (SCIM)
  • EU-GDPR
  • Consent Management
  • Personal Data Management
  • Compliance Certificates
  • HIPAA Guidelines
  • PCI Recommendations and Integration Types
  • Articles and FAQ

Data Operations


  • Bulk Operations
  • Migration
  • Articles and FAQ
  1. Billing
  2. AI in Chargebee
  3. Chargebee Model Context Protocol (MCP) Server
  1. Billing
  2. AI in Chargebee
  3. Chargebee Model Context Protocol (MCP) Server

Chargebee MCP Servers

Overview

The Chargebee Model Context Protocol (MCP) servers enable you to connect AI clients to Chargebee systems through standardized tools and structured context. Connect AI clients such as Cursor, Claude, ChatGPT, Codex, and other MCP-compatible tools to Chargebee MCP Servers to securely access selected capabilities.

Chargebee provides the following MCP servers:

  • Chargebee Knowledge MCP Server: Lets AI clients answer questions using Chargebee docs and API references.
  • Data Access MCP Server: Lets AI clients retrieve customer, subscription, invoice, transaction, and other billing data from your Chargebee site.
  • Onboarding MCP Server: Lets AI clients assist with product catalog setup and onboarding tasks. This MCP server is available only for test and sandbox sites.

See also

Chargebee Copilot: An AI assistant inside Chargebee products for answering questions and completing tasks using natural language.

Configure MCP servers

You can configure MCP servers as follows:

  1. Log in to Chargebee Billing.
  2. Navigate to Settings > Agentic AI > MCP Servers.
    Agentic AI menu
  3. Select any of the listed MCP servers to open its configuration page.
    MCP servers configuration

Chargebee Knowledge MCP Server

Lets AI clients answer questions using Chargebee docs and API references.

Most useful when you need to:

  • Understand the concepts and features of Chargebee products.
  • Answer how-to questions about Chargebee workflows.
  • Generate code snippets for integrating with Chargebee REST API and Chargebee.js.
Knowledge MCP server configuration

Server URLs

Under the Access & Authentication tab, under MCP Access, you'll find the server URL for this MCP server for your Chargebee site. Depending on your site's data center, you will see a URL in one of the following formats:

US data center

https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.chargebee.com/knowledge_base_agent

EU data center

https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.eu.chargebee.com/knowledge_base_agent

AU data center

https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.au.chargebee.com/knowledge_base_agent

Installation

Under the Access & Authentication tab, under MCP Installation, you'll find specific installation instructions for each AI client.

Examples

Claude Code
claude mcp add --transport http "knowledge_base_agent" "https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.chargebee.com/knowledge_base_agent"
Claude Desktop and Cursor
{
  "mcpServers": {
    "knowledge_base_agent": {
      "url": "https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.chargebee.com/knowledge_base_agent"
    }
  }
}

Note

For supported AI clients, you can use the Add MCP to... button to add the MCP server to your client directly.

Toolsets

Under the Toolsets tab, you'll find the toolset available for the Chargebee Knowledge MCP server. This MCP server provides the Product Knowledge toolset with the following tools:

  • Explain Chargebee Features: Answer questions using Chargebee documentation and API references.
  • Generate Code Samples: Generate code snippets for integrating with Chargebee REST API and Chargebee.js.
Knowledge MCP server toolsets

Data Access MCP Server

Lets AI clients retrieve billing data from your Chargebee site. The following tools are available:

  • Retrieve a specific customer record or a set of records from Chargebee Billing.
  • Retrieve plans or addons by name, items and item prices by ID, or all item prices for an item.
  • Retrieve one or more subscriptions by subscription ID, customer ID, or other filters.
  • Retrieve a payment intent by ID.
  • Retrieve one or more invoices by invoice ID, subscription ID, customer ID, or other filters.
  • Retrieve one or more credit notes by credit note ID, or other filters.
  • Retrieve one or more transactions by transaction ID, invoice ID, customer ID, or other filters.
  • Retrieve one or more events by event ID, event type, or customer ID.
  • Retrieve the set of attributes that define records of a specific type.
  • Retrieve the filter options available for a specific record type.
Data Access MCP server configuration

Server URLs

Under the Access & Authentication tab, under MCP Access, you'll find the server URL for this MCP server for your Chargebee site. Depending on your site's data center, you will see a URL in one of the following formats:

US data center: https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.chargebee.com/data_lookup_agent

EU data center: https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.eu.chargebee.com/data_lookup_agent

AU data center: https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.au.chargebee.com/data_lookup_agent

Authentication

See the Authentication methods section below.

Toolsets

Under the Toolsets tab, you'll find the toolsets available for the Chargebee Data Access MCP server.

The following toolsets are available and can be individually enabled or disabled.

Fields and filters lookup

This toolset consists of the following tools:

  • Fields lookup: Retrieve the set of attributes that define records of a specific type.
  • Filters lookup: Retrieve the filter options available for a specific record type.
Data Access MCP server fields and filters toolset

Customer lookup

This toolset consists of the following tools:

  • Find customer by ID: Retrieve a customer record by its unique ID.
  • Find customers by email: Retrieve customer records by email address.
  • Find customers by company name: Retrieve customer records by company name.
  • List customers: Retrieve a list of customer records matching filter conditions.
Data Access MCP server customer lookup toolset

Product lookup

This toolset consists of the following tools:

  • Find plan by name: Retrieve a plan record by its name.
  • Find addon by name: Retrieve an addon record by its name.
  • Find item by ID: Retrieve an item record by its unique ID.
  • Find item price by ID: Retrieve an item price record by its unique ID.
  • Find item prices by item ID: Retrieve a list of item prices under an item whose ID is provided.
Data Access MCP server product lookup toolset

Subscription lookup

This toolset consists of the following tools:

  • Find subscription by ID: Retrieve a subscription record by its unique ID.
  • Find subscriptions by customer ID: Retrieve subscription records by customer ID.
  • List subscriptions: Retrieve a list of subscription records matching filter conditions.
Data Access MCP server subscription lookup toolset

Payment intent lookup

This tool retrieves a payment intent record by its unique ID.

Data Access MCP server payment intent lookup toolset

Invoice lookup

This toolset consists of the following tools:

  • Find invoice by ID: Retrieve an invoice record by its unique ID.
  • Find invoices by customer ID: Retrieve invoice records by customer ID.
  • Find invoices by subscription ID: Retrieve invoice records by subscription ID.
  • List invoices: Retrieve a list of invoice records matching filter conditions.
  • Get invoice PDF link: Retrieve the hyperlink to the PDF of an invoice.
Data Access MCP server invoice lookup toolset

Credit note lookup

This toolset consists of the following tools:

  • Find credit note by ID: Retrieve a credit note record by its unique ID.
  • List credit notes: Retrieve a list of credit notes records matching filter conditions.
  • Get credit note PDF link: Retrieve the hyperlink to the PDF of a credit note.
Data Access MCP server credit note lookup toolset

Transaction lookup

This toolset consists of the following tools:

  • Find transaction by ID: Retrieve a transaction record by its unique ID.
  • Find transactions by invoice ID: Retrieve transaction records by invoice ID.
  • Find transactions by customer ID: Retrieve transaction records by customer ID.
  • List transactions: Retrieve a list of transactions records matching filter conditions.
Data Access MCP server transaction lookup toolset

Event lookup

This toolset consists of the following tools:

  • Find event by ID: Retrieve an event record by its unique ID.
  • List events by customer ID: Retrieve a list of event records by customer ID.
  • List events by event type: Retrieve a list of event records by event type.
Data Access MCP server event lookup toolset

Onboarding MCP Server

Lets AI clients set up data for test or sandbox sites in Chargebee Billing.

Onboarding MCP server configuration

Note

The Onboarding MCP server is not available for live sites.

Server URLs

Under the Access & Authentication tab, under MCP Access, you'll find the server URL for this MCP server for your Chargebee site. Depending on your site's data center, you will see a URL in one of the following formats:

US data center

https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.chargebee.com/onboarding_agent

EU data center

https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.eu.chargebee.com/onboarding_agent

AU data center

https://YOUR-CHARGEBEE-SUBDOMAIN.mcp.au.chargebee.com/onboarding_agent

Authentication

See the Authentication methods section below.

Toolsets

Under the Toolsets tab, you'll find the toolsets available for the Chargebee Onboarding MCP server. The following toolsets are available and can be individually enabled or disabled.

Generate pricing summary

This tool generates a pricing summary, including plans, addons, charges, their price points, features, and entitlements, given the URL to your product pricing page.

Onboarding MCP server generate pricing summary toolset

Product catalog setup

This toolset consists of the following tools:

  • Generate product catalog data: Sets up items of type plan, addon, and charge, and their price points from a pricing summary provided by you.
  • Import product catalog data: Imports the plans, addons, charges, and their price points from detailed pricing information provided by you.
Onboarding MCP server product catalog setup toolset

Feature and entitlement setup

This toolset consists of the following tools:

  • Generate features from pricing summary: Given a summary of product pricing information, this tool generates feature objects in Chargebee.
  • Generate entitlements: This tool generates entitlement objects in Chargebee using both the summary of product pricing information and the existing feature and product catalog data in Chargebee.
  • Import features and entitlements: This tool imports feature and entitlement objects in Chargebee using the information provided by you, and the existing product catalog data in Chargebee.
Onboarding MCP server feature and entitlement setup toolset

Sample customer data setup

This toolset consists of the following tools:

  • Generate sample customer data: This tool generates sample customer, subscription, and quotes objects in Chargebee using the product pricing summary and existing product catalog data in Chargebee.
  • Import customer data: This tool imports customer objects in Chargebee using the customer information provided by you.
  • Import quote data: This tool imports quote objects in Chargebee using the information provided by you.
  • Import subscription data: This tool imports subscription objects in Chargebee using the information provided by you.
Onboarding MCP server sample customer data setup toolset

Set up branding

Given a link to your product website, this tool sets up the branding in Chargebee Billing for your invoices, customer email notifications, Checkout, and Self-serve Portal.

Onboarding MCP server set up branding toolset

Authentication methods

Depending on the server, Chargebee supports the API key and OAuth authentication methods. MCP servers such as the Chargebee Knowledge Base MCP Server do not require authentication because their tools access publicly available information only.

Best practices

  • Enable only the servers and toolsets your organization needs
  • Rotate keys and OAuth credentials periodically
  • Ensure that systems accessing the MCP servers have appropriate customer data protection measures in place

API Key

The API Key method grants full access to all enabled tools in the server and is best suited for:

  • Server-to-server integrations
  • Internal automations
  • Trusted development environments
Authentication API key

Clients authenticate by sending the API key in request headers:

Authorization: Bearer YOUR-API-KEY

Configuration code snippets for API key are available for some of the commonly used AI clients.

Authentication example

OAuth

The OAuth method provides user-based access. Among the enabled toolsets for the MCP server, the tool access is further limited by the signed-in user's access level in Chargebee. OAuth is best suited for:

  • User-facing AI clients
  • Shared developer tools
  • Integrations where access should reflect your user's access level in Chargebee
Authentication OAuth

Configuration code snippets for OAuth are available for some of the commonly used AI clients.

Authentication OAuth code snippet

Was this article helpful?