> This page is for Docs. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://zuora.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server. # Tools reference for Zuora MCP > Comprehensive reference for all Zuora AI tools, their permissions, and supported operations across Zuora APIs. Comprehensive reference for all Zuora AI tools, their permissions, and supported operations across Zuora APIs. This section provides a detailed reference of all available tools and operations for documentation team reference. It may be published separately or summarized for end users. Zuora AI provides 91 tools covering 330+ operations across Zuora's APIs. Each tool has a permission classification: * READ: Only reads data; available in tenants on any mode (Read-Only, Read-Only (opted into Supervised mode), Supervised, or Autonomous). * WRITE: Modifies data; requires the tenant to be in Supervised or Autonomous mode. * MIXED: Contains both read and write operations. Read operations are available in any mode; write operations require Supervised or Autonomous mode. > **Note** > > Use the built-in AI capabilities to explore the server's available features and tools. For example, ask "What can I do with the `manage_workflow` tool?" You can also request guidance on using a specific tool or Zuora feature, such as "Give me five useful prompts for working with invoices." ## Knowledge and Guidance
Tool AI Permission Description
`ask_zuora` Read Expert assistant on Zuora's product suite.
`sdk_upgrade` Read SDK version information, changelogs, and upgrade guidance.
`zuora_codegen` Read Code generation guidance with API discovery.
`ping` Read Checks whether the Zuora MCP server is available and responding.
## Query and Data | Tool | Permission | Description | | ---------------------- | ---------- | ---------------------------------------------------------------------------------------- | | `get_account_summary` | Read | Account details with financial summary. | | `query_objects` | Read | Query Zuora object types with filtering and sorting. | | `manage_data_queries` | Read | Submit and manage Data Query jobs. | | `manage_reports` | Mixed | Search, list, export, and manage reports. | | `manage_system_health` | Read | Retrieve API volume, failures, and summaries. | | `run_reports` | Write | Runs a report. | | submit_mcp_feedback | Read | Submits confirmed MCP feedback for the Zuora MCP server. | | `zuora_graphql` | Read | Explores GraphQL types, filters, inputs, and query structures, and runs GraphQL queries. | ## Billing and Subscriptions | Tool | Permission | Description | | ---------------------------------- | ---------- | ----------------------------------------------------------------- | | `create_products` | Write | Create products in the product catalog. | | `create_product_rate_plans` | Write | Create rate plans under products. | | `create_product_rate_plan_charges` | Write | Create charges. | | `create_subscriptions` | Write | Create subscriptions through the Orders API. | | `manage_subscriptions` | Mixed | Suspend, resume, renew, cancel, and preview subscriptions. | | `manage_subscription_amendments` | Write | Add, update, and remove products. | | `manage_orders` | Mixed | Preview, create, update, and cancel orders. | | `manage_billing_previews` | Mixed | Generate and retrieve billing previews. | | `manage_bill_runs` | Mixed | Create, post, cancel, and delete bill runs. | | `manage_invoice_schedules` | Mixed | Create and manage invoice schedules. | | `manage_fulfillments` | Write | Creates, updates, and deletes fulfillments and fulfillment items. | ## Invoicing and Accounts Receivable | Tool | Permission | Description | | ----------------------------- | ---------- | ----------------------------------------------------- | | `manage_invoices` | Mixed | Create, post, reverse, write off, and email invoices. | | `manage_credit_memos` | Mixed | Create, post, apply, and reverse credit memos. | | `manage_debit_memos` | Mixed | Create, post, and write off debit memos. | | `manage_billing_documents` | Mixed | Generate billing documents and manage PDFs. | | `manage_taxation_items` | Write | Create, update, and delete taxation items. | | `manage_summary_statements` | Write | Create summary statement runs. | | `manage_delivery_adjustments` | Mixed | Preview, create, and cancel adjustments. | ## Payments | Tool | Permission | Description | | ------------------------------- | ---------- | ---------------------------------------------------------------------------------------------- | | `manage_payments` | Write | Create, apply, unapply, cancel, refund, and transfer payments. | | `manage_refunds` | Write | Delete, update, and cancel refunds. | | `manage_payment_runs` | Write | Create, update, and delete payment runs. | | `manage_payment_schedule_items` | Write | Retry, cancel, and skip payment schedule items. | | `manage_payment_schedules` | Write | Creates, updates, deletes, and cancels payment schedules, and adds items to payment schedules. | ## Accounts and Contacts | Tool | Permission | Description | | -------------------------- | ---------- | ---------------------------------------------------------------------------------------- | | `manage_customer_accounts` | Mixed | Retrieves customer account settings and creates, updates, and deletes customer accounts. | | `manage_contacts` | Write | Create, update, delete, and transfer contacts. | ## Revenue | Tool | Permission | Description | | ---------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------- | | `manage_accounting_codes` | Mixed | List, create, activate, and deactivate accounting codes. | | `manage_accounting_periods` | Mixed | List, create, close, and reopen accounting periods. | | `manage_journal_runs` | Mixed | Create, cancel, and delete journal runs. | | `manage_summary_journal_entries` | Mixed | Create, update, and cancel summary journal entries. | | `manage_revenue_reports` | Read | List, run, and download revenue reports. | | `summarize_revenue_report` | Read | Summarizes revenue report output. | | `manage_o2r_data_backfill` | Mixed | Manage O2R data backfill jobs. | | `manage_o2r_regenerate` | Write | Regenerate transactions and revenue recognition events. | | `manage_revenue_switch_allocation` | Read | Retrieves revenue switch allocation information. | | `manage_contract_modification` | Read | Retrieves contract modification details and analyzes TCV changes, pricing by line, and carve impacts. | | `manage_revenue_job_summary` | Read | Collects revenue job metrics and lists failed revenue job runs. | | `simulate_revenue_impact` | Read | Simulates revenue impact, including TCV, revenue by quarter, and remaining performance obligations. | | `manage_stage_validation` | Mixed | Lists, searches, and retrieves field information and validation rules, and saves stage validation rules. | | `get_rule_set` | Read | Retrieves rule set information. | | manage_vc | Mixed | Retrieves VC types and applies VC actions. | | manage_defer_and_release | Write | Defers revenue for revenue contracts and releases revenue for revenue contracts. | | manage_apply_hold | Write | Applies holds at the contract, line, and POB levels. | | manage_release_hold | Write | Releases holds at the contract, line, and POB levels. | | manage_allocate_action | Write | Runs allocation actions. | | manage_open_close_rc | Write | Opens and closes revenue contracts. | | manage_edit_line | Write | Edits revenue contract lines. | | manage_switch_allocation | Write | Switches revenue allocation. | | manage_apply_impairment | Write | Applies impairment actions. | | manage_edit_pob_attributes | Write | Edits POB attributes at the revenue contract and POB levels. | | manage_switch_lead_line | Write | Switches the lead line. | | manage_un_freeze_rc | Write | Unfreezes revenue contracts. | | manage_link_delink | Write | Links and delinks revenue contracts, POBs, and lines. | | manage_generate_forecast | Write | Generates revenue forecasts. | ## Administration and Analytics | Tool | Permission | Description | | ------------------------ | ---------- | ------------------------------------------------------------------------------------------------------ | | `manage_settings` | Mixed | Retrieve and update tenant settings. | | manage_analytics | Read | Validates analytics access, lists datasets, retrieves dataset schemas, and executes analytics queries. | | manage_decision_tree | Write | Creates and updates decision trees. | | manage_custom_function | Write | Creates and updates custom functions for workflows. | | `manage_workflows` | Mixed | List, export, import, and update workflows. | | `manage_workflow_tasks` | Mixed | List, get, update, and rerun workflow tasks. | | `run_workflows` | Mixed | Run workflows and check run status. | | `manage_attachments` | Mixed | Get, list, create, and update attachments. | | `manage_sequence_sets` | Mixed | List, create, and update sequence sets. | | `manage_bulk_actions` | Mixed | Bulk create, update, and delete objects. | | `manage_custom_fields` | Mixed | Lists custom field namespaces, types, and fields, and creates or updates custom fields. | | `manage_decision_table` | Write | Creates and updates decision tables. | | `manage_custom_policies` | Write | Creates custom policy drafts for features and entitlements. | ## Custom Objects, Usage, and E-Invoicing | Tool | Permission | Description | | ------------------------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `manage_custom_object_definitions` | Mixed | Define and manage schemas. | | `manage_custom_object_records` | Mixed | Create, read, update, and delete custom object records. | | `manage_usage` | Mixed | Upload, create, update, and query usage records. | | `manage_mediation_meters` | Mixed | Retrieves and validates meters, lists related connections, event stores, and schemas, and creates meters for usage metering. | | `manage_e_invoicing_config` | Write | Manage service providers, regions, and templates. | | `manage_e_invoicing_documents` | Write | Generate and sync e-invoices. | | `manage_commerce_products` | Write | Create, update, and delete commerce products. | | `manage_commerce_context_attributes` | Mixed | Lists context attributes and creates or updates attribute values for Dynamic Pricing. | | `manage_commerce_plans` | Write | Creates, updates, and deletes commerce plans for Dynamic Pricing. | | `manage_commerce_charges` | Mixed | Queries, creates, updates, and deletes commerce charges, and updates tier prices for Dynamic Pricing. | | `manage_omnichannel_subscriptions` | Mixed | Manage omnichannel subscriptions. | | manage_meters_run | Mixed | Provides run guidance, executes meter runs, tracks run status and history, queries event stores, retrieves run summaries and records, manages prefetch operations, and ingests usage events. | | manage_meters_audit | Mixed | Provides audit guidance, retrieves audit trail entries and audit export information, and creates audit exports. |