Chargebee Data Lookup MCP Server

Overview

The Chargebee Data Lookup MCP Server lets AI clients retrieve customer, subscription, invoice, quote, and payment data from your Chargebee site. For an overview of Chargebee MCP servers, see Chargebee MCP Servers.

Configure Data Lookup 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 Chargebee Data Lookup 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/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

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

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.

Toolsets

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

Subscription Lookup

Access subscription data for customer lifecycle operations.

• List Subscription Ramps: Lists all subscription ramps for a subscription, including the ramp name, start date, end date, and status.
• Retrieve Subscription Data by Customer ID: Lists all subscriptions associated with a customer, along with their plan, status, and billing information.
• List Subscriptions: Lists subscriptions that match your criteria for broader plan, status, or billing-cycle searches.
• Retrieve Subscription Ramp Data by Ramp ID: Fetches detailed subscription ramp data, including the ramp name, start date, end date, and status.
• Retrieve Subscription Data by ID: Fetches detailed subscription data, including plan information, billing cycle, status, and addons.
• List Subscription Entitlements: Lists the entitlements a subscription is currently entitled to, including overrides and inherited entitlements.
• Retrieve Subscription with Scheduled Changes: Retrieves a subscription together with any changes scheduled to take effect in the future.
• Retrieve Subscription Scheduled Changes: Retrieves the pending scheduled change on a subscription (the queued future state).
• List Subscription Contract Terms: Lists the contract terms of a subscription, including start and end dates, status, and the term-end action.
• List Subscription Discounts: Lists the discounts applied to a subscription, including type, amount or percentage, and validity.
• Retrieve Advance Invoice Schedule: Retrieves the advance invoice schedule that controls how future invoices are generated in advance for a subscription.

Subscription Address Lookup

Access subscription address data.

• Retrieve a Subscription Address: Retrieves a subscription address using its subscription ID and unique label.

Subscription Ramp Lookup

Access subscription ramp data for scheduled pricing changes.

• List Subscription Ramps: Lists all subscription ramps for a subscription, including the ramp name, start date, end date, and status.
• Retrieve Subscription Ramp Data by Ramp ID: Fetches detailed subscription ramp data, including the ramp name, start date, end date, and status.

Entitlement Lookup

Access entitlements and features.

• List All Entitlements: Lists available entitlements with feature access details and quotas.
• List Entitlement Features: Lists entitlement features defined on the site.
• Retrieve Entitlement Feature: Retrieves a specific entitlement feature's details including its levels and status.
• List Customer Entitlements: Lists the feature entitlements and quotas available to a specific customer.
• List Entitlement Overrides for a Subscription: Lists the subscription-level entitlement overrides that deviate from the item defaults.

Omnichannel Lookup

Access Apple App Store and Google Play Store omnichannel subscriptions and one-time orders.

• List Omnichannel Subscriptions: Lists app store subscriptions.
• Retrieve Omnichannel Subscription: Retrieves a specific app store subscription with its items.
• List Omnichannel Subscription Item Scheduled Changes: Lists pending scheduled changes — such as downgrades or pauses — for an app store subscription item, including when each change takes effect.
• List Omnichannel One-Time Orders: Lists app store one-time orders.
• Retrieve Omnichannel One-Time Order: Retrieves a specific app store one-time order.
• List Omnichannel Transactions: Lists the omnichannel transactions recorded against a specific omnichannel subscription.

Customer Lookup

Access customer data needed for support workflows.

• Search Customers: Searches customers by name, email, company, or customer ID and displays their details instantly.
• Retrieve Customer Data by Email: Fetches customers by email and displays their details instantly.
• List Customers: Lists customer records in bulk and returns the matching accounts with the fields you need.
• Retrieve Customer Data by ID: Fetches complete customer details—contact info, billing address, and account status.
• Get Customer Hierarchy: Retrieves all or part of the account hierarchy for a customer.
• List Customer Hierarchy Details: Lists the account hierarchy nodes for a customer with pagination.
• List Contacts for a Customer: Lists the contacts associated with a specific customer.

Product Lookup

Access product catalog data, including plans, addons, items, pricing details, products, variants, differential prices, coupons, coupon sets, and coupon codes.

Product Catalog v1 (Plans & Addons)

• List Plans: Lists plans with optional name-based search, filters, and field selection.
• List Addons: Lists addons with optional name-based search, filters, and field selection.
• Retrieve Plan Details by ID: Fetches detailed plan information including id, name, price, currency, period, status, and description.
• Retrieve Addon Details by ID: Fetches detailed addon information including id, name, price, currency, period, status, and description.

Product Catalog v2 (Items, Item Prices & Item Families)

• List Items: Lists items (plans, addons, charges) with optional filters and field selection.
• List Item Prices: Lists all pricing options for an item, including different currencies, billing frequencies, and pricing models.
• List Item Families: Lists item families with optional filters and field selection.
• Retrieve Item Details by ID: Fetches detailed item (plan, addon, or charge) information including id, name, type, status, description, and metadata.
• Retrieve Item Price by ID: Fetches detailed pricing information including price, currency, billing period, and trial period.
• Retrieve Item Family Details by ID: Fetches detailed item family information including id, name, description, and status.

Products, Variants & Pricing

• List Products: Lists products in the catalog, including id, name, status, and variant details.
• Retrieve Product by ID: Retrieves a specific product, including id, name, status, and variant details.
• List Product Variants: Lists the variants of a specific product, including SKU, name, and status.
• Retrieve Product Variant by ID: Retrieves a specific product variant, including SKU, name, and status.
• List Price Variants: Lists price variants defined on the site, including name, status, and business entity.
• Retrieve Price Variant by ID: Retrieves a specific price variant, including name, status, and business entity.
• List Differential Prices: Lists differential prices, including the item price, parent item, and price overrides.
• Retrieve Differential Price by ID: Retrieves a specific differential price, including the item price, parent item, and price overrides.
• List Attached Items: Lists the items attached to a specific item (plan), including type and charge behavior.

Coupons

• List Coupons: Lists available coupons created for promotions or offers, including coupons that are active, expired, archived, or deleted.
• Retrieve Coupon Data by ID: Retrieves detailed coupon data, including discount type, duration, status, validity dates, and redemption limits.
• List Coupon Sets: Lists coupon sets so you can review grouped coupon-code batches for a coupon and their usage counts.
• Retrieve Coupon Set Data by ID: Retrieves detailed coupon set data, including the associated coupon, code count, and redemption details.
• List Coupon Codes: Lists coupon codes so you can review them by coupon, coupon set, or redemption status.
• Retrieve Coupon Code Data by Code: Retrieves detailed coupon code data, including the associated coupon, status, redemption details, and expiration information.

Invoice Lookup

Access invoice data and invoice PDF links.

• Retrieve Invoice Data by Customer ID: Fetches all invoices for a specific customer, including amounts, status, and dates.
• Retrieve Invoice Data by Subscription ID: Fetches all invoices for a specific subscription, including amounts, status, and dates.
• List Invoices: Lists invoices that match your filters for broader invoice lookups.
• Get Invoice PDF Link: Generates a link to view or download the invoice as a PDF.
• Retrieve Invoice Data by ID: Fetches detailed invoice data, including amount, status, line items, and payment details.
• List Unbilled Charges: Lists unbilled charges that are not yet invoiced, with amount, subscription, and status details.
• Retrieve Payment Schedules for an Invoice: Retrieves the payment schedule entries (installments) configured for a specific invoice.
• Download Invoice E-Invoice: Retrieves the e-invoice download details for a specific invoice.

Quote Lookup

Access quote data and quote PDF links.

• List Quotes: Lists quotes across your site based on the filters you provide.
• Get Quote PDF Link: Generates a link to view or download the quote as a PDF.
• Retrieve Quote Data by ID: Fetches detailed quote data, including amount, status, line items, and payment details.
• List Quote Entitlements: Lists the entitlements (feature access) granted by a specific quote.
• List Quote Line Groups: Lists the line groups of a specific quote, each grouping a set of quote line items.

Credit Note Lookup

Access credit note data and credit note PDF links.

• List Credit Notes: Lists credit notes across your site based on the filters you provide.
• Get Credit Note PDF Link: Generates a link to view or download the credit note as a PDF.
• Retrieve Credit Note Data by ID: Fetches complete credit note details—amount, status, and line items included.
• Download Credit Note E-Invoice: Retrieves the e-invoice download details for a specific credit note.

Transaction Lookup

Access transaction data for payments and refunds.

• List Transactions by Customer ID: Lists all payment and refund transactions for a given customer ID, including amount, status, and payment method details.
• List Transactions by Invoice ID: Lists all payment and refund transactions for a given invoice ID, including amount, status, and payment method details.
• List Transactions: Lists payment and refund transactions in bulk for matching invoice or customer activity.
• Retrieve Transaction Data by ID: Retrieves detailed payment and refund transaction data, such as amount, status, and payment method details.

Event Lookup

Access event data by event type or customer.

• Retrieve Events by Customer ID: Lists all events associated with a specific customer. Returns the event type, source, and created at timestamp.
• List Events by Event Type: Lists all events of a particular type. Returns the event type, source, and created at timestamp.
• Retrieve Event by Id: Retrieves detailed information for a single specific Chargebee event using its unique ID. Returns the event type, occurred_at timestamp, and full event content.

Payment Intent Lookup

Access payment intent details for payment tracking.

• Retrieve Payment Intent by ID: Fetches detailed information about a specific payment intent, including the amount, its current status, and gateway-specific details.

Export Data

Create export jobs, retrieve download details for ZIP files, and analyze large datasets including customers, subscriptions, invoices, credit notes, transactions, items, item prices, item families, attached items, differential prices, price variants, coupons, orders, and subscription ramps.

• Export Credit Notes: Creates an export job for credit note data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Customers: Creates an export job for customer data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Invoices: Creates an export job for invoice data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Subscriptions: Creates an export job for subscription data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Transactions: Creates an export job for transaction data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Get Export Filter Conditions Metadata: Lists the supported filter structure for a selected resource before starting a filtered export.
• Retrieve Export Job Details: Retrieves the current status of an export job and returns zip download details when the export is ready for follow-up analysis.
• Retrieve Full Export Status: Retrieves the status of the site's full data export.
• Export Items: Creates an export job for item data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Item Prices: Creates an export job for item price data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Item Families: Creates an export job for item family data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Attached Items: Creates an export job for attached item data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Differential Prices: Creates an export job for differential price data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Price Variants: Creates an export job for price variant data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Coupons: Creates an export job for coupon data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Orders: Creates an export job for order data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.
• Export Subscription Ramps: Creates an export job for subscription ramp data. Returns job details used for tracking the progress, downloading the resulting file, and performing analysis.

Revenue Lookup

Access historical subscription MRR data and exchange rates.

• Fetch Subscription MRR History by subscription ID: Fetches the MRR (Monthly Recurring Revenue) history records for a given subscription id.
• Fetch Historical Exchange Rates: Fetches currency exchange rates for the currencies configured in the site for the given date.

Hosted Pages Lookup

Access hosted pages data.

• List hosted pages: Lists hosted page resources that match your filters, including their type, state, and URL.
• Retrieve a hosted page: Fetches a specific hosted page by ID, including its type, state, URL, and the content captured once the checkout completes.

Payment Source Lookup

Access stored payment instruments: payment sources, cards, virtual bank accounts, vaulted payment methods, and tokens.

• List Payment Sources: Lists stored payment sources with type, gateway, and status details.
• Retrieve Payment Source by ID: Retrieves detailed payment source information, including type, gateway details, and status.
• List Gateway Payment Method Tokens for a Payment Source: Lists the gateway-side payment method tokens linked to a specific payment source.

Order Lookup

List orders and retrieve detailed order information.

• List Orders: Lists orders with optional filters and response-field selection.
• Retrieve Order by ID: Retrieves detailed information for a specific order.

Comments Lookup

Access comments across your site or retrieve a specific Chargebee comment.

• List Comments: Lists comments across the site or for a specific Chargebee entity.
• Retrieve a Comment: Retrieves a comment by its unique Chargebee comment ID.

Promotional Credit Lookup

Access promotional credit data for customer accounts.

• List Promotional Credits: Lists promotional credit (account credit) records with type, amount, and description.
• Retrieve Promotional Credit by ID: Retrieves detailed promotional credit (account credit) information, including type, amount, and description.

Site Settings Lookup

Access site configuration data.

• Retrieve Currency by ID: Retrieves a specific currency configured on the site, including the currency code and settings.

Chargebee Data Lookup

Retrieve customer, subscription, invoice, and payment data.

• Get Filter Conditions Metadata: Lists the supported filter structure for a selected resource before running a filtered list lookup.
• Get Response Field Metadata: Lists the available response fields for a selected resource before choosing fields in a list lookup.

Common

General-purpose tools available on this server.

• Submit Chargebee MCP Feedback: Submits feedback about your Chargebee MCP experience.