Chargebee MCP Server
for AI Agents

Create a new customer record in Chargebee with optional contact details (name, email, phone, company), auto-collection preferences, net term days, taxability, VAT number, locale, and metadata. Use this to onboard customers before creating subscriptions, import customers from external systems, or pre-create customer profiles for hosted checkout flows

Retrieve a paginated list of all customers sorted by creation date, with optional filtering by email, first name, last name, company, phone, taxability, and auto-collection status. Returns customer profiles with billing addresses, payment methods, balances, and account hierarchy. Use this to browse, search, or export your Chargebee customer base

Retrieve the full customer object by its unique Chargebee customer ID, including billing address, payment method, contacts, per-currency balances (promotional credits, excess payments, refundable credits, unbilled charges), account hierarchy (parent/child relationships), fraud flag, channel, and metadata. Use this to inspect a single customer's complete profile and billing configuration before creating subscriptions or invoices

Update an existing customer's contact details (first name, last name, email, phone, company), auto-collection setting, net term days, taxability, or metadata by customer ID. Only provided fields are changed; omitted fields remain unchanged. Requires payment terms to be configured at the site level for net_term_days changes

Soft-delete a customer from Chargebee by marking them as deleted (data is retained and retrievable via the list API). Fails with an error if the customer has active subscriptions or pending invoices. Optionally removes the associated payment method. Use this to clean up test data or remove customers created in error

Retrieve a paginated list of all subscriptions with optional filtering by customer ID, plan ID, creation/update timestamps, and deleted status. Returns subscription details including status (future, in_trial, active, non_renewing, paused, cancelled, transferred), billing period, plan/addon/charge items, coupons, discounts, MRR, and contract terms

Retrieve the full subscription object by its unique Chargebee subscription ID, including plan items, addon items, charge items, billing cycle, trial start/end, MRR, contract terms, discounts, coupons, shipping address, billing override, and referral info. Use this to inspect a subscription's complete configuration, current state, and billing schedule

Update an existing subscription's plan item price, quantities, auto-collection, purchase order number, or metadata. Supports immediate changes, end-of-term scheduling via end_of_term flag, proration for mid-cycle adjustments, and immediate invoice generation. Do not send quantity for on_off addon types

Retrieve a paginated list of all invoices with optional filtering by customer ID, subscription ID, recurring flag, date range, paid-at timestamp, updated-at timestamp, dunning status, and channel. Returns invoice details including line items, taxes, payments, credits applied, dunning status, and amounts (sub_total, total, amount_due, amount_paid). Supports ascending or descending sort by date

Retrieve the full invoice object by its unique Chargebee invoice ID, including status (paid, posted, payment_due, not_paid, voided, pending), line items with entity types, taxes, discounts, linked payments with transaction status, applied credits, adjustment credit notes, issued credit notes, dunning attempts, billing/shipping addresses, and e-invoice details. Use this to inspect a specific invoice's complete financial breakdown and payment history

Create a new credit note against a reference invoice for a specified total amount in cents. Supports adjustment type (reduces the amount on an existing invoice in payment_due or not_paid status) and refundable type (allows returning money to the customer via refund or future invoice application). The total must not exceed the invoice's outstanding amount. Supports optional reason codes (e.g., product_unsatisfactory, order_change, waiver), customer-visible notes for the PDF, and internal comments

Retrieve a paginated list of all credit notes (adjustment, refundable, and store credit types) with optional filtering by date and sorting by date in ascending or descending order. Returns credit note details including type, status, reference invoice, amounts (total, allocated, refunded, available), line items, taxes, linked refunds, and invoice allocations. Use this to track refunds, invoice adjustments, and store credits

Retrieve the full credit note object by its unique Chargebee credit note ID, including type (adjustment reduces invoice amount, refundable allows money return, store credit applied to future invoices), status (adjusted, refunded, refund_due, voided), reason code, line items with quantities and tax details, discounts, taxes, linked refunds with transaction status, invoice allocations, and billing/shipping addresses

Create a new item (plan, addon, or charge) in the product catalog with a required ID, name, and type. Requires an item_family_id when Product Families is enabled (most sites). Item type and metered flag are immutable after creation. Plans define the subscription billing period, addons are recurring add-ons, and charges are one-time fees. After creating an item, create item prices to define pricing in specific currencies and billing periods

Retrieve a paginated list of all product catalog items (plans, addons, charges) with optional filtering by name, item ID, item family ID, and channel. Plans are the essential recurring subscription component, addons are optional recurring add-ons sold with a plan, and charges are non-recurring one-time fees. Returns item details including type, status, metered billing settings, checkout/portal enablement, and applicable items

Retrieve the full item object by its unique Chargebee item ID, including type (plan, addon, charge), status (active, archived, deleted), item family, metered billing settings and usage calculation method, checkout/portal enablement flags, item applicability rules, applicable items, bundle configuration, and metadata. Use this to inspect a catalog item's complete configuration before creating item prices or subscriptions

Update an existing product catalog item's name, description, external name (customer-facing), checkout enablement, portal enablement, or metadata by item ID. Only provided fields are changed; omitted fields remain unchanged. Item type and metered flag cannot be modified after creation. Items from app_store or play_store channels cannot be updated via API

Delete an item from the product catalog by setting its status to deleted. The item must not have any active item prices associated with it. Once deleted, both the ID and name can be reused for a new item. Items from app_store or play_store channels cannot be deleted via API. Deleted items remain retrievable via the list items API

Create a new item price for a catalog item with a required ID, item_id, name, pricing model, and currency code. An item can have only one price per currency and billing period combination. Period and period_unit are mandatory for plan and addon item types but must NOT be sent for charge item types (returns 400 error). Supports trial settings, free quantity for plan per_unit pricing, and external name for customer-facing documents

Retrieve a paginated list of all item prices (price points for catalog items) with optional filtering by item ID, item price name, or item price ID. Each item price defines a currency, pricing model (flat_fee, per_unit, tiered, volume, stairstep), billing period, amount, and trial settings. An item can have only one price per currency and billing period combination. Returns item prices needed for creating subscriptions

Retrieve the full item price object by its unique Chargebee item price ID, including pricing model (flat_fee, per_unit, tiered, volume, stairstep), price in minor currency units, currency code, billing period and unit, trial period and end action, free quantity, tier definitions for tiered/volume/stairstep models, tax detail (tax profile, Avalara/TaxJar codes), accounting detail (SKU, accounting codes for Xero/QuickBooks/NetSuite), and metadata

Update an existing item price's amount (in minor currency units), name, external name, description, trial period settings, or metadata by item price ID. Only provided fields are changed. Pricing model, currency code, period, period unit, and billing cycles cannot be changed once subscriptions, invoices, or differential prices exist for this item price

Delete an item price from the product catalog by setting its status to deleted. The item price must not be associated with any active subscriptions (returns an error otherwise). Once deleted, both the ID and name can be reused for a new item price. Deleted item prices remain retrievable via the list item prices API

Retrieve a paginated list of all coupons with optional filtering by name or coupon ID. Returns discount type (fixed_amount, percentage, offer_quantity), duration type (one_time, forever, limited_period), validity window, current and maximum redemption counts, apply_on setting (invoice_amount or each_specified_item), item constraints, and metadata. Use this to browse available promotions and discount configurations

Retrieve the full coupon object by its unique Chargebee coupon ID, including discount type (fixed_amount, percentage, offer_quantity) and value, duration type and period, apply_on setting, validity window (valid_from/valid_till), current and maximum redemption counts, item constraints defining which plans/addons/charges the coupon applies to, coupon constraints for redemption rules, invoice notes, and metadata. Coupon IDs containing special characters (e.g.,

Update an existing coupon's display name, invoice name, discount amount (for fixed_amount type, in cents), discount percentage (for percentage type, 0.01-100), validity end date (valid_till Unix timestamp), maximum redemptions limit, and metadata by coupon ID. Only provided fields are changed; omitted fields remain unchanged. Coupon IDs containing special characters must be URL-encoded

Delete a coupon so it can no longer be applied to new subscriptions. The coupon status changes to deleted. Existing coupon applications on active subscriptions are not affected and continue to apply their discounts until they naturally expire or are explicitly removed. Coupon IDs containing special characters must be URL-encoded

Create a new order linked to an existing invoice by invoice_id, representing a fulfillment record for physical products. Supports optional initial status, reference_id for mapping to external shipping or order management systems, tracking information (tracking_id, tracking_url, shipment_carrier), and date fields (shipping_date, order_date as Unix timestamps). The order inherits line items and customer details from the linked invoice

Retrieve a paginated list of all orders (fulfillment records for physical products, auto-generated when invoices are paid) with optional filtering by subscription ID, customer ID, and order status. Supports ascending or descending sort. Returns order details including fulfillment status (new, processing, shipped, delivered, cancelled, returned), shipping/billing addresses, tracking info, line items with per-item fulfillment, payment status, and linked credit notes

Retrieve the full order object by its unique Chargebee order ID, including fulfillment status (new, processing, complete, cancelled, queued, awaiting_shipment, on_hold, shipped, delivered, partially_delivered, returned), shipping/billing addresses, tracking info (tracking_id, tracking_url, shipment_carrier), order line items with per-item fulfillment quantities and amounts, payment status (paid or not_paid), cancellation reason, linked credit notes, resent orders, and all timestamps

Update an existing order's status, reference_id for external system mapping, tracking details (tracking_id, tracking_url, shipment_carrier), and fulfilment timestamps (shipping_date, order_date, shipped_at, delivered_at, cancelled_at as Unix timestamps) by order ID. Supports providing a cancellation_reason when updating the status to cancelled. Only provided fields are changed

Retrieve a paginated list of all saved payment sources (cards, direct debits, PayPal, Apple Pay, Google Pay, bank transfers, UPI, Venmo, Klarna, and more) with optional filtering by customer ID and status (valid, expiring, expired, invalid, pending_verification). Returns payment source details including type, gateway, reference_id, and type-specific nested objects (card brand/last4/expiry, bank account mandate, PayPal agreement). Supports ascending or descending sort

Retrieve the full payment source object by its unique Chargebee payment source ID, including type (card, direct_debit, paypal, amazon_payments, apple_pay, google_pay, upi, venmo, klarna, and more), status (valid, expiring, expired, invalid, pending_verification), gateway and gateway_account_id, reference_id (gateway-specific identifier), and type-specific nested details (card brand/IIN/last4/expiry/funding_type, bank account mandate/scheme, PayPal email/agreement_id, UPI VPA, Venmo username) plus billing address

Retrieve a paginated list of all payment transactions (authorizations, payments, refunds, payment reversals) with optional filtering by customer ID, subscription ID, payment source ID, payment method type, gateway, and transaction type. Supports sorting by date in ascending or descending order. Returns transaction details including amounts, status, fraud flags, linked invoices/credit notes, and gateway error information. Use this to audit payment activity, track payment lifecycle, and reconcile financial records

Retrieve the full transaction object by its unique Chargebee transaction ID, including type (authorization, payment, refund, payment_reversal), gateway and payment method details, status (in_progress, success, voided, failure, timeout, needs_attention, late_failure), amounts (total, unused, capturable), fraud flag and reason, 3D Secure info, linked invoices with applied amounts, linked credit notes for refunds, linked payments for authorizations, and comprehensive gateway error details (error category, decline codes, processor codes, recommendation)

Retrieve a paginated list of all events (change log entries for subscriptions, invoices, payments, customers, credit notes, items, orders, and more) with optional filtering by occurred_at timestamp range. Each event contains the affected resource data in its content field. Use this for audit trails, webhook replay, polling for updates since a specific timestamp, and building event-driven integrations

Retrieve the full event object by its unique Chargebee event ID, including event_type, source (admin_console, api, scheduled_job, hosted_page, portal, system, etc.), the full affected resource data in the content field (subscription, invoice, customer, etc.), API version (v1 or v2), triggering user, and webhook delivery status for each configured endpoint (not_configured, scheduled, succeeded, failed, etc.). Use this for debugging webhook delivery, auditing changes, and re-fetching event data to confirm webhook payloads

Record a usage entry for a metered subscription item with a required item_price_id, quantity (as string), and usage_date (Unix timestamp). Billed postpaid at the end of each billing cycle. Only one usage record is allowed per subscription_id + item_price_id + usage_date combination (to correct an error, delete and recreate). Max 5000 usages per subscription lifetime. Only applicable when Automated Metered Billing is enabled

Retrieve a list of usage records for a specific metered subscription item. Requires both subscription_id and item_price_id as mandatory query parameters. Only applicable when Automated Metered Billing is enabled in Chargebee. Returns usage records with quantity, usage_date, invoice linkage, source, and notes. Use this to audit usage data before invoicing or verify billed quantities

Delete a specific usage record for a metered subscription item by providing subscription_id as a path parameter and item_price_id plus usage_id as body parameters. Use this to correct erroneous usage entries before they are invoiced. After deletion, a new usage record can be created for the same date. Only applicable when Automated Metered Billing is enabled

Retrieve a paginated list of all hosted pages (Chargebee-managed secure checkout, payment update, and subscription management pages). Returns hosted page type (checkout_new, checkout_existing, update_payment_method, collect_now, etc.), URL, state (created, requested, succeeded, cancelled, acknowledged), expiration time, and pass-through content. Use this to track hosted page sessions, monitor checkout completion rates, and identify abandoned carts

Retrieve the full hosted page object by its unique Chargebee hosted page ID, including type, URL, state (created, requested, succeeded, cancelled, acknowledged), expiration time, pass-through content, checkout_info for abandoned cart tracking, and the content field (only populated when state is succeeded, containing the created subscription, customer, card, and invoice resources). Call this after a customer completes checkout to retrieve the full result data