code_generation_agent
ChatGPTProvides comprehensive API documentation, reference information, and code implementation guidance across multiple programming languages. Use for: API field/parameter questions ('What is exempt_reason field?'), endpoint documentation ('Show me subscription API'), code implementation ('How do I create a subscription?'), SDK integration ('Node.js payment code'), technical tutorials ('Build billing portal'), webhook details, and development guidance. Output: API documentation, field descriptions, code snippets, or complete tutorials as needed. Focus: Technical implementation and API reference information.
docs_explanation_agent
ChatGPTProvides detailed Chargebee concept explanations, troubleshooting guidance, and configuration help. Use for: understanding how features work ('How does billing work?'), feature explanations ('What is metered billing?'), troubleshooting ('Why aren't invoices generating?'), configuration guidance ('How to set up payment retries'), and best practices. Avoid for: API implementation code or technical integration steps. Output: Comprehensive explanations with step-by-step guidance, best practices, and troubleshooting solutions.
download_credit_note_einvoice
ChatGPTRetrieves the e-invoice download details for a specific credit note.
download_invoice_einvoice
ChatGPTRetrieves the e-invoice download details for a specific invoice.
export_attached_items
ChatGPTStarts a Chargebee attached items export job for complete or large datasets. Use list_attached_items_tool for small previews. For filtering, first call get_export_filter_conditions_metadata_tool with resource=attached_items. After starting the job, poll retrieve_export_tool for download details.
export_coupons
ChatGPTStarts a Chargebee coupons export job for complete or large coupon datasets. Use list_coupons_tool for small previews. For filtering, first call get_export_filter_conditions_metadata_tool with resource=coupons. After starting the job, poll retrieve_export_tool for download details.
export_credit_notes
ChatGPTStarts a Chargebee credit_notes export job. Prefer this over list_credit_notes_tool whenever the user asks for the full credit_notes dataset, all credit_notes, a complete list, or results likely to span multiple pages. Also prefer it for large result sets, full-dataset analysis, aggregations, or follow-up code that inspects the exported file after the job completes. After starting the job, call retrieve_export_tool until it returns the download details, then use shell/code to download the file, unzip or unpack it if needed, inspect its contents, and compute summaries or aggregates from the exported data. Prefer the list tool only for quick previews, small filtered lookups, or a single page of results shown directly in the current context. For advanced filtering, first call get_export_filter_conditions_metadata_tool with resource=credit_notes, then pass filters_json as a JSON string matching the returned filters_json_schema.
export_customers
ChatGPTStarts a Chargebee customers export job. Prefer this over list_customers_tool whenever the user asks for the full customers dataset, all customers, a complete list, or results likely to span multiple pages. Also prefer it for large result sets, full-dataset analysis, aggregations, or follow-up code that inspects the exported file after the job completes. After starting the job, call retrieve_export_tool until it returns the download details, then use shell/code to download the file, unzip or unpack it if needed, inspect its contents, and compute summaries or aggregates from the exported data. Prefer the list tool only for quick previews, small filtered lookups, or a single page of results shown directly in the current context. For advanced filtering, first call get_export_filter_conditions_metadata_tool with resource=customers, then pass filters_json as a JSON string matching the returned filters_json_schema.
export_differential_price
ChatGPTStarts a Chargebee differential prices export job for complete or large datasets. Use list_differential_prices_tool for small previews. For filtering, first call get_export_filter_conditions_metadata_tool with resource=differential_prices. After starting the job, poll retrieve_export_tool for download details.
export_invoices
ChatGPTStarts a Chargebee invoices export job. Prefer this over list_invoices_tool whenever the user asks for the full invoices dataset, all invoices, a complete list, or results likely to span multiple pages. Also prefer it for large result sets, full-dataset analysis, aggregations, or follow-up code that inspects the exported file after the job completes. After starting the job, call retrieve_export_tool until it returns the download details, then use shell/code to download the file, unzip or unpack it if needed, inspect its contents, and compute summaries or aggregates from the exported data. Prefer the list tool only for quick previews, small filtered lookups, or a single page of results shown directly in the current context. For advanced filtering, first call get_export_filter_conditions_metadata_tool with resource=invoices, then pass filters_json as a JSON string matching the returned filters_json_schema.
export_item_families
ChatGPTStarts a Chargebee item families export job. Item families group related items (products), typically into a product line. Use list_item_families_tool for small previews. For filtering, first call get_export_filter_conditions_metadata_tool with resource=item_families. After starting the job, poll retrieve_export_tool for download details.
export_item_prices
ChatGPTStarts a Chargebee item prices export job for complete or large pricing datasets. Item prices are priced versions of plans, addons, or charges, including currency, billing frequency, pricing model, and amount. Use list_item_prices_tool for small previews. For filtering, first call get_export_filter_conditions_metadata_tool with resource=item_prices. After starting the job, poll retrieve_export_tool for download details.
export_items
ChatGPTStarts a Chargebee items export job for complete or large item datasets. Items are the products sold as plans, addons, or charges. Use list_items_tool for small previews. For filtering, first call get_export_filter_conditions_metadata_tool with resource=items. After starting the job, poll retrieve_export_tool for download details.
export_orders
ChatGPTStarts a Chargebee orders export job for complete or large order datasets. For filtering, first call get_export_filter_conditions_metadata_tool with resource=orders. After starting the job, poll retrieve_export_tool for download details.
export_price_variants
ChatGPTStarts a Chargebee price variants export job for complete or large datasets. Use list_price_variants_tool for small previews. For filtering, first call get_export_filter_conditions_metadata_tool with resource=price_variants. After starting the job, poll retrieve_export_tool for download details.
export_subscription_ramps
ChatGPTStarts a Chargebee subscription ramps export job for complete or large ramp datasets. Use list_ramps_tool for small previews. For filtering, first call get_export_filter_conditions_metadata_tool with resource=subscription_ramps. After starting the job, poll retrieve_export_tool for download details.
export_subscriptions
ChatGPTStarts a Chargebee subscriptions export job. Prefer this over list_subscriptions_tool whenever the user asks for the full subscriptions dataset, all subscriptions, a complete list, or results likely to span multiple pages. Also prefer it for large result sets, full-dataset analysis, aggregations, or follow-up code that inspects the exported file after the job completes. After starting the job, call retrieve_export_tool until it returns the download details, then use shell/code to download the file, unzip or unpack it if needed, inspect its contents, and compute summaries or aggregates from the exported data. Prefer the list tool only for quick previews, small filtered lookups, or a single page of results shown directly in the current context. For advanced filtering, first call get_export_filter_conditions_metadata_tool with resource=subscriptions, then pass filters_json as a JSON string matching the returned filters_json_schema.
export_transactions
ChatGPTStarts a Chargebee transactions export job. Prefer this over list_transactions_tool whenever the user asks for the full transactions dataset, all transactions, a complete list, or results likely to span multiple pages. Also prefer it for large result sets, full-dataset analysis, aggregations, or follow-up code that inspects the exported file after the job completes. After starting the job, call retrieve_export_tool until it returns the download details, then use shell/code to download the file, unzip or unpack it if needed, inspect its contents, and compute summaries or aggregates from the exported data. Prefer the list tool only for quick previews, small filtered lookups, or a single page of results shown directly in the current context. For advanced filtering, first call get_export_filter_conditions_metadata_tool with resource=transactions, then pass filters_json as a JSON string matching the returned filters_json_schema.
fetch_customers_via_company
ChatGPTUse this tool to quickly search for customers using any identifying information, such as customer name (first + last), email address, company name, company email domain (e.g. 'acme.com'), or customer ID. Performs partial (fuzzy) matching across all of these fields. Returns the top 10 most recent matching customers (not guaranteed exhaustive). Do NOT use this for retrieving a specific customer by an exact, known customer ID; use the retrieve-customer-by-ID tool for that, since exact ID retrieval through this search is slow. Only when the user needs the full/paginated list of customers or advanced structured field filtering, use the customer listing/filtering tool.
fetch_customers_via_email
ChatGPTQuick customer lookup by exact email address. Returns up to 10 best-matching results — not guaranteed to be exhaustive. If the user needs more results, use a broader customer listing/filtering tool to view all records.
fetch_events_by_customer_id
ChatGPTLists all events associated with a customer, including type, source and created at timestamp.
fetch_historical_exchange_rates
ChatGPTFetches currency exchange rates for the currencies configured in the site for the given date, provided as an ISO 8601 datetime. Exchange rates are available only till the previous day.
get_export_filter_conditions_metadata
ChatGPTCall this FIRST before passing filters_json to export_customers, export_subscriptions, export_invoices, export_credit_notes, export_transactions, export_coupons, export_subscription_ramps, export_orders, export_items, export_item_families, export_item_prices, export_price_variants, export_attached_items, or export_differential_price. It returns the exact filters_json_schema for the selected export resource so the next export-tool call can serialize a valid JSON string matching that schema.
get_filter_conditions_metadata
ChatGPTCall this FIRST before passing filters_json to list_customers, list_subscriptions, list_invoices, list_credit_notes, list_transactions, list_quotes, list_subscription_ramps, list_hosted_pages, list_item_families, list_items, list_item_prices, list_coupons, list_coupon_sets, or list_coupon_codes. It returns the exact filters_json_schema for the selected resource so the next list-tool call can serialize a valid JSON string matching that schema.
get_hierarchy
ChatGPTRetrieves all or part of the account hierarchy for a customer.
get_response_field_metadata
ChatGPTCall this FIRST before passing include_fields_json to list_customers, list_subscriptions, list_invoices, list_credit_notes, list_transactions, list_quotes, list_subscription_ramps, list_hosted_pages, list_item_families, list_items, list_item_prices, list_coupons, list_coupon_sets, or list_coupon_codes. It returns the exact list response item schema so the next list-tool call can choose the required top-level and nested fields.
list_all_entitlements
ChatGPTLists available entitlements with feature access details and quotas.
list_attached_items
ChatGPTLists the items attached to a specific item (plan), including type and charge behavior.
list_coupon_codes
ChatGPTLists available coupon codes so you can review codes by coupon, coupon set, or redemption status.
list_coupon_sets
ChatGPTLists all coupon sets so you can review grouped coupon-code batches for a coupon and their usage counts.
list_coupons
ChatGPTLists available coupons created for promotions or offers, including coupons that are active, expired, archived, or deleted.
list_credit_notes
ChatGPTLists credit notes across your site based on the filters you provide.
list_customer_entitlements
ChatGPTLists the feature entitlements and quotas available to a specific customer.
list_customers
ChatGPTLists customer records in bulk and returns the matching accounts with the fields you need.
list_differential_prices
ChatGPTLists differential prices, including the item price, parent item, and price overrides.
list_events
ChatGPTLists all events by event type, including type, source and created at timestamp
list_features
ChatGPTLists entitlement features defined on the site.
list_gateway_payment_method_tokens
ChatGPTLists the gateway-side payment method tokens linked to a specific payment source.
list_hierarchy_details
ChatGPTLists the account hierarchy nodes for a customer with pagination.
list_hosted_pages
ChatGPTLists hosted page resources.
list_invoices
ChatGPTLists invoices that match your filters for broader invoice lookups.
list_invoices_by_customer
ChatGPTFetches all invoices for a specific customer, including amounts, status, and dates.
list_invoices_by_subscription
ChatGPTFetches all invoices for a specific subscription, including amounts, status, and dates.
list_item_families
ChatGPTLists item families - groupings of related items (products), typically a product line. Each item belongs to a family via item_family_id. Supports pagination via limit/offset. Before using filters_json, call get_filter_conditions_metadata for resource=item_families. Before using include_fields_json, call get_response_field_metadata for resource=item_families. Use retrieve_item_family for full details of a specific family by ID.
list_item_prices
ChatGPTLists item prices - the priced versions of an item (plan, addon, or charge). A single item can have many item prices differing by currency, billing frequency, pricing model, and amount. This is where actual prices for a product item live (an item itself has no price). Supports pagination via limit/offset. Before using filters_json, call get_filter_conditions_metadata for resource=item_prices - to list prices for a specific item, filter by item_id (e.g. item_id[starts_with]='premium'); to list prices for a specific item type (plan, addon, or charge), filter by item_type (e.g. item_type[is]=plan). Before using include_fields_json, call get_response_field_metadata for resource=item_prices. Use retrieve_item_price to get full details of a specific item price by ID.
list_items
ChatGPTLists catalog items - the products you sell. Every item has a type of plan (recurring core of a subscription), addon (recurring component added to a plan), or charge (one-time fee), and belongs to an item family. To list only one item type, filter by type (e.g. type[is]=plan). Item describes the product; their currencies and amounts live in item prices. Supports pagination via limit/offset. Before using filters_json, call get_filter_conditions_metadata for resource=items. Before using include_fields_json, call get_response_field_metadata for resource=items. Use retrieve_item to get full details of a specific item by ID.
list_of_contacts_for_a_customer
ChatGPTLists the contacts associated with a specific customer.
list_orders
ChatGPTLists orders with optional filters and response-field selection.
list_payment_sources
ChatGPTLists stored payment sources with type, gateway, and status details.
list_price_variants
ChatGPTLists price variants defined on the site, including name, status, and business entity.
list_product_variants
ChatGPTLists the variants of a specific product, including SKU, name, and status.
list_products
ChatGPTLists products in the catalog, including id, name, status, and variant details.
list_promotional_credits
ChatGPTLists promotional credit (account credit) records with type, amount, and description.
list_quote_entitlements
ChatGPTLists the entitlements (feature access) granted by a specific quote.
list_quote_line_groups
ChatGPTLists the line groups of a specific quote, each grouping a set of quote line items.
list_quotes
ChatGPTLists quotes across your site based on the filters you provide.
list_ramps
ChatGPTLists all subscription ramps for a subscription, including the ramp name, start date, end date, and status.
list_subscription_contract_terms
ChatGPTLists the contract terms of a subscription, including start/end dates, status, and term-end action.
list_subscription_discounts
ChatGPTLists the discounts applied to a subscription, including type, amount/percentage, and validity.
list_subscription_entitlement_overrides
ChatGPTLists the subscription-level entitlement overrides that deviate from the item defaults.
list_subscription_entitlements
ChatGPTLists the entitlements a subscription is currently entitled to, including overrides and inherited entitlements.
list_subscriptions
ChatGPTLists subscriptions that match your criteria for broader plan, status, or billing-cycle searches.
list_subscriptions_for_customer
ChatGPTLists all subscriptions associated with a customer, along with their plan, status, and billing information.
list_transactions
ChatGPTLists payment and refund transactions in bulk for matching invoice or customer activity.
list_transactions_by_customer
ChatGPTLists all payment and refund transactions for a given customer ID, including amount, status, and payment method details.
list_transactions_by_invoices
ChatGPTLists all payment and refund transactions for a given invoice ID, including amount, status, and payment method details.
list_unbilled_charges
ChatGPTLists unbilled charges (not yet invoiced) with amount, subscription, and status details.
retrieve_a_hosted_page
ChatGPTRetrieves a hosted page and its content.
retrieve_a_ramp
ChatGPTFetches detailed subscription ramp data, including the ramp name, start date, end date, and status.
retrieve_advance_invoice_schedule
ChatGPTFetches the advance invoice schedule that controls how future invoices are generated in advance for a subscription.
retrieve_an_address
ChatGPTRetrieves a subscription address using its subscription ID and unique label.
retrieve_an_order
ChatGPTRetrieves detailed information for a specific order.
retrieve_coupon
ChatGPTFetches detailed coupon data, including discount type, duration, status, validity dates, and redemption limits.
retrieve_coupon_code
ChatGPTFetches detailed coupon code data, including the associated coupon, status, redemption details, and expiration information.
retrieve_coupon_set
ChatGPTFetches detailed coupon set data, including the associated coupon, code count, and redemption details.
retrieve_credit_note
ChatGPTFetches complete credit note details — amount, status, and line items included.
retrieve_credit_note_pdf
ChatGPTGenerates a link to view or download the credit note as a PDF.
retrieve_currency
ChatGPTRetrieves a specific currency configured on the site, including currency code and settings.
retrieve_customer
ChatGPTFetches complete customer details — contact info, billing address, and account status.
retrieve_differential_price
ChatGPTRetrieves a specific differential price, including item price, parent item, and price overrides.
retrieve_event
ChatGPTAccepts a Chargebee event ID and retrieves the full event payload, which provides detailed information about entities involved in the event such as customer, subscription, invoice, etc.
retrieve_export
ChatGPTRetrieves the current status of a Chargebee export job and, when ready, the download details returned by Chargebee. When the export is ready, use the returned download URL or file details with shell/code to download the export, unzip or unpack it if needed, inspect the contents, and compute aggregates or other full-dataset results from the file.
retrieve_feature
ChatGPTRetrieves a specific entitlement feature's details including its levels and status.
retrieve_full_export_status
ChatGPTRetrieves the status of the site's full data export.
retrieve_invoice
ChatGPTFetches detailed invoice, including amount, status, line items, and payment details.
retrieve_invoice_payment_schedules
ChatGPTRetrieves the payment schedule entries (installments) configured for a specific invoice.
retrieve_invoice_pdf
ChatGPTGenerates a link to view or download the Invoice as a PDF.
retrieve_item
ChatGPTGet detailed item information including id, name, type (plan/addon/charge), status, description, and metadata. Does not include pricing - use list_item_prices for pricing information. IMPORTANT: Subscriptions and invoices typically link to item_price_id, NOT item_id. If the user asks for plan/addon/item details and it's unclear whether the ID is an item_id or item_price_id, try retrieve_item_price_tool first. If both item and item_price are possible, call both tools - only return 404 if both fail.
retrieve_item_family
ChatGPTGet detailed item family information including id, name, description, and status. Item families group related plans, addons, and charges into a product line. Use list_item_families to discover families when the ID is unknown.
retrieve_item_price
ChatGPTGet detailed pricing information for a specific item price ID including price, currency, billing period, trial period, and associated item. PREFERRED for subscription/invoice details: Subscriptions and invoices link to item_price_id, so use this tool when fetching plan/addon/item details from those resources. If the user asks for plan/addon/item details and it's unclear whether the ID is an item_id or item_price_id, try this tool first. If both item and item_price are possible, call both tools - only return 404 if both fail.
retrieve_payment_intent
ChatGPTRetrieves detailed payment intent information including amount, status, and gateway details.
retrieve_payment_source
ChatGPTRetrieves detailed payment source information including type, gateway details, and status.
retrieve_price_variant
ChatGPTRetrieves a specific price variant, including name, status, and business entity.
retrieve_product
ChatGPTRetrieves a specific product, including id, name, status, and variant details.
retrieve_product_variant
ChatGPTRetrieves a specific product variant, including SKU, name, and status.
retrieve_promotional_credit
ChatGPTRetrieves detailed promotional credit (account credit) information including type, amount, and description.
retrieve_quote
ChatGPTFetches detailed quote data, including amount, status, line items, and payment details.
retrieve_quote_pdf
ChatGPTGenerates a link to view or download the Quote as a PDF.
retrieve_subscription
ChatGPTFetches detailed subscription data, including plan information, billing cycle, status, and add-ons.
retrieve_subscription_scheduled_changes
ChatGPTFetches the pending scheduled change on a subscription (the queued future state).
retrieve_subscription_with_scheduled_changes
ChatGPTFetches a subscription together with any changes scheduled to take effect in the future.
retrieve_transaction
ChatGPTRetrieves detailed payment and refund transaction data, such as amount, status, and payment method details.
