Zuora Coding Agent Plugin
The Zuora Coding Agent plugin (ZCA) is a bundle of skills and related material for developers building against Zuora. ZCA combines task-specific skills with Zuora reference material so your agentic creations can help complete Zuora implementation work. In this content:
plugin = package of capabilities
skill = task-specific instructions/workflow, often inside a plugin
A plugin can contribute many skills, but a skill is what your AI client or tool will leverage for work. This is a developers tool, to aid development that then undergoes rigourous testing prior to deployment, do not run any of these skills directly against a Zuora Production tenant. How to avoid doing this is detailed below.
What's Included
- Skills: task playbooks for API design, code generation, Workflow design, Order API migration, Invoice Settlement migration, meter design, dynamic pricing setup, CPQ Apex/Quote Studio customization and migration, validation, and review.
- Local Zuora MCP Server: Provides Zuora API and product helpers for API specs, SDK patterns, object queries, reports, workflows, billing documents, and tenant-aware validation.
- Reference material: Zuora-specific migration mappings, workflow patterns, meter operator schemas, Liquid filter reference, and integration best practices.
- Local linter scripts:
scripts/lint-workflow-json.js and scripts/lint-meter-json.js for pre-import structural and semantic validation of generated artifacts.
What You Can Use ZCA For
You can our ZCA for work such as:
- Choosing the right Zuora API for a business requirement.
- Generating SDK or cURL integration code.
- Migrating legacy Subscribe, Amendment, or REST v1 flows to the Orders API.
- Planning or building Invoice Settlement migration artifacts.
- Designing or generating Zuora Workflow JSONs (Workflow uses JSON to export/import Workflows).
- Designing usage-based billing meters.
- Designing or executing Commerce Catalog dynamic pricing setups.
- Designing, generating, or migrating Zuora CPQ legacy Apex/Visualforce customizations to Quote Studio JavaScript hooks and LWC components.
- Validating payloads, reviewing code, or checking Zuora-specific edge cases.
The ZCA is self documenting, you can simply ask your client for more examples or if a particular use case of interest to you would be helped by using ZCA.
Quick Start
If you're already familiar with REST API development with Zuora, Zuora OAuth clients, and plugins, here are the basics. The following sections provide more details on installation and
-
Obtain ZUORA_BASE_URL, ZUORA_CLIENT_ID, and ZUORA_CLIENT_SECRET OAuth credentials if you don't already have suitable ones.
-
Install the plugin in Codex, Cursor, or Claude Code.
-
Configure ZUORA_BASE_URL, ZUORA_CLIENT_ID, and ZUORA_CLIENT_SECRET.
-
Review the Disclaimer
-
Start with design-oriented prompts, such as:
Use Zuora Coding Agent to design an Orders API integration for creating a termed subscription with usage charges.
-
Move to build prompts once the approach is clear.
-
Run validation or review checks before merging or deploying.
Complete Get Started
1. A Supported Coding Environment
The plugin can be used from:
ZCA also requires Node.js >= 18, because the plugin runs zuora-mcp through npx. Installation instructions for each of these clients are below the Disclaimer section.
2. A Zuora OAuth Client
You need standard REST API tenant OAuth credentials from your Zuora tenant:
ZUORA_BASE_URLZUORA_CLIENT_IDZUORA_CLIENT_SECRET
If you don't already suitable credentials how to obtain them is described in this short video, but you need to be your tenant's Zuora Administrator, or you need to ask for their assistence. The same page as the video includes instructions on how to identify the URL for the new credentials. Again, do not specify a production tenant in your ZUORA_BASE_URL. You will need these values for the install.
Security Considerations
Remember that your client id is tied to a tenant login, that, in turn, has various roles and permissions defined. Be sure to use permissions that match your intended work. Read-only permissions are enough for design, query, and review workflows. Additional permissions are needed only when you want the agent to create subscriptions, create or run workflows, export reports, or perform other tenant-changing operations.
3. Access To The Relevant Codebase Or Artifact
For migrations and code generation, ZCA is most useful when it can inspect the existing integration code.
For Workflow or meter generation, supply your business requirements and enough tenant-specific detail to avoid guessing.
4. Sandbox-First, Always
