Introducing the Chargebee CLI

Onboarding MCP Server

Overview

The Onboarding MCP Server lets AI clients create product catalogs and generate demo data for your Chargebee site. For an overview of Chargebee MCP Servers, see Chargebee MCP Servers.

The Onboarding MCP Server is available only for test and sandbox sites. It is not available for live sites.

To draft a product catalog in the Chargebee UI from a pricing page, document, or description, use Catalog Setup Assistant.

Configure the Onboarding MCP Server

You can configure MCP servers as follows:

  1. Log in to Chargebee Billing.
  2. Navigate to Settings > Configure Chargebee > Agentic AI > MCP Servers.
  3. Select the Onboarding MCP Server to open its configuration page.

Access and authentication

Under the Access & Authentication tab, turn on the MCP Access toggle to allow external AI clients to access this server via MCP.

Server URLs

Under MCP Server URL, 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

Choose how external AI clients authenticate with this MCP server. The tools available may vary depending on the selected authentication method.

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 access to all enabled tools in this server and is best suited for:

  • Server-to-server integrations
  • Internal automations
  • Trusted development environments

You can create up to 5 API keys for this server.

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.

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 Chargebee 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

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

Use the same OAuth client ID for users of the same MCP client. For example, if you have 100 Claude Code users, you can generate one OAuth client ID and share it with all 100 users. Claude Code (or any other MCP client) will then direct them to the Chargebee Billing login page. Once signed in, they will be redirected back to the MCP client, and their MCP access will be limited by their Chargebee user access level.

OAuth authentication is not supported on sites with Multi-Business Entity enabled. Use API Key authentication instead.

Toolsets

Under the Toolsets tab, you'll find the toolsets available for the Onboarding MCP Server. The following toolsets are available and can be individually turned on or turned off.

Customer Operations

Create, update, delete, and manage customer accounts and billing details.

  • Create a customer: Creates a customer, optionally with a payment source.

Item Family Operations

Create, update, and delete item families in your product catalog.

  • Create a product family: Creates a product family for your product catalog.

Item Operations

Create, update, and delete items in your product catalog.

  • Create a plan, addon, or charge item: Creates a new plan, addon, or charge.

Item Price Operations

Create, update, and delete item prices in your product catalog.

  • Create a plan, addon, or charge item price: Creates a price point for a plan, addon, or charge.

Feature Operations

Create, update, activate, archive, and manage product features.

  • Create a feature: Creates a new feature.

Entitlement Operations

Upsert and remove feature entitlements for customers and subscriptions.

  • Manage entitlements for a feature: Creates, updates, or removes entitlements for a feature.

Quote Operations

Create, edit, convert, extend, and manage quotes.

  • Create a quote for subscription creation: Creates a quote for a new subscription.

Branding Setup

Set up branding for your site, including logo, colors, and fonts.

  • Customize Branding: Customizes company branding data in Chargebee from a given website.

Import Operations

Import subscriptions, invoices, credit notes, and unbilled charges into Chargebee.

  • Import credit note: Imports a credit note.
  • Import invoice: Imports a current-term or historical invoice.
  • Import subscription: Imports a subscription for an existing customer.
  • Import unbilled charges: Imports one or more unbilled charges into an existing subscription.

Product Knowledge

Answer product questions, guide how-to tasks, and generate code samples using Chargebee docs and API references.

  • Explain Chargebee Docs: Provides clear explanations of features, configurations, and best practices, helping to troubleshoot common issues and understand Chargebee's functionalities in-depth.

See also