For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Download API spec

Billing Payments Platform CPQ Zephr Revenue Accounts Receivable AI Releases Basics Entitlements Support & Policies

Skip to navigation

Template library

||View as Markdown|

This page is for Docs.

Learn about how to create and configure cards in Analytics.

Learn about how to create and configure cards in Analytics.

Here are some interesting things about…

Was this page helpful?

Zuora Analytics troubleshooting guide

Churned subscriber trend

Billing Payments Platform CPQ Zephr Revenue Accounts Receivable AI Releases Basics Entitlements Support & Policies

- Zuora Platform overview
System management
Data management
Security and identity
User management
Extensibility
Integration
Data
Zuora AI
Attachments
- Attachments

Zuora Platform overview
Command Center overview
Command Center process flow
Monitor system integration health
Threshold of health status
Contractual Consumption Metrics
Monitor and track admin actions and resources
Tenant Management
Status values for connection
Trust Status
Product Entitlements
View active usage and entitlement details
Entitlement dashboard
Manage Technical Support Dashboard
Explore Additional Features for Platform Utilization
Zuora Trust Status in Command Center
View detailed reports for historic incidents
Configure Notifications
Access Zuora Trust details within the Command Center
Access Trust updates with OneID
Access Trust updates without OneID
Overview of Settings API
Settings API field name and UI text comparison table
Subscription settings
Billing rules
Payment rules
Accounting rules
Settings API tutorials
Get Age Buckets
Update Age Buckets
Avalara Tax Engine settings
Get a specific setting - Billing Rules
Update a specific setting - Billing Rules
Get Accounting Rules - Billing Rules
Get Chart of Accounts
Add a new Chart of Account
Create a new Communication Profile
Get a Communication Profile
Get all Communication Profiles
Modify a Communication Profile
Connect Tax Engines settings
Global Hub Tax Engine settings
Get a specific Invoice Template
Get all Invoice Templates
Create a new Invoice Template
Update a specific Invoice Template
Delete a specific Invoice Templates
Create an invoice group
Retrieve all invoice groups
Get a specific invoice group
Update an invoice group
Delete an invoice group
Get all Notifications under a particular Communication Profile
Create a notification definition under a particular Communication Profile
Get a notification definition
Update a notification definition
Delete a notification definition
Get all Quote Templates
Get a specific Quote Template
Create a new Quote Template
Create or update reusable blocks
Get all reusable blocks
Get a reusable block
Update a reusable block
Delete a reusable block
Summary Statement Settings
Create a Unit of Measure
Get a Unit of Measure
Get all Units of Measure
Update a Unit of Measure
Delete a Unit of Measure
Zuora Tax Code API settings
Zuora Tax Engine settings
Zuora Tax Rate Period settings
Zuora Tax Rates API settings
Zuora System Health
Billing
Bill Run dashboard
Bill Run metrics
View data in the Bill Run dashboard
E-Invoice dashboard
E-Invoice metrics
View data in the E-Invoice dashboard
Presentment dashboard
Presentment metrics
Tax Integration dashboard
Tax Integration metrics
Usage File Import dashboard
Usage File Import metrics
Payment
Configurable Payment Retry dashboard
Configurable Payment Retry tabs
Quick Stat Card metrics
Trend Chart metrics
Electronic Payments dashboard
Electronic payment metrics
Gateway Reconciliation dashboard
Gateway Reconciliation metrics
HPM Threat Detection dashboard
View data in the HPM Threat Detection dashboard
HPM Threat Detection metrics
Journal Run dashboard
Journal Run metrics
Trial Balance Run dashboard
Trial Balance Run metrics
Platform
Aggregate Query API (AQuA) dashboard
AQuA metrics
APIs dashboard
API metrics
Data Query dashboard
Data Query metrics
Data Source Export dashboard
Data Source Export metrics
Notifications dashboard
Notification metrics
Workflow dashboard
Workflow metrics
Zuora Connector for Salesforce CRM dashboard
Zuora Connector for Salesforce CRM metrics
System Health FAQs
Configurable Payment Retry dashboard FAQs
Personal Settings
Edit your user profile
Language
View login history
Change your password
Dates in Zuora
Locale date formats
Date and dateTime formats
Customer account dates: Bill cycle day
Date related fields in SOAP
Data Loader overview
Workflow process of Data Loader
Create a job in Data Loader
Create an AI-assisted Data Loader job
Cancel transactions using Data Loader
Create orders with advanced multi-action template
Import CSV files with delimiters using Data Loader
Data Loader templates for advanced multi-action orders
Nulling field values with in Data Loader
Nested object handling in Data Loader
CSV sample templates for Data Loader
Process bulk job with JSON-lines in Data Loader
Ingest data using bulk jobs API
Data Loader job status and result details
Data Loader summary and icons on list view
Access Data Loader export templates
Accounting code import fields
Accounting period import fields
Accounts and contacts import fields
Amendment import fields
Bill run with batches import fields
Bill run with filters import fields
Contacts import fields
Credit memo from charge import fields
Credit memo from invoice import fields
Debit memo from charge import fields
Debit memo from invoice import fields
Journal run import fields
Journal entry import fields
Omni-channel subscription import fields
Advance multi-action template import fields
Single action - create order line item import fields
Single action - create subscription existing account import fields
Single action - create subscription existing account with volume charge import fields
Single action - create subscription with new account import fields
Single action - remove product import fields
Single action - update subscription add product import fields
Single action - update subscription price quantity change import fields
single action - update subscription change plan import fields
Payments import fields
Payment profile import fields
Payment schedule import fields
Attribute import fields
Bundle plans import fields
Bundle products import fields
Context import fields
Feature import fields
Product aggregate import fields
Product import fields
Product rate plan charge import fields
Product rate plan charge tier import fields
Product rate plan charge with dynamic pricing import fields
Product rate plan import fields
Single action-create order with commitments import fields
Standalone invoice import fields
Subscription import fields
Taxation item import fields
Unit of measure import fields
Usage import fields
Accounting code update fields
Advanced accounts and contact update fields
Legacy accounts update fields
Contact update fields
Apply Credit Memo update fields
Post Credit Memo update fields
Unapply Credit Memo update fields
Unpost credit and debit Memo update fields
Update Credit Memo update fields
Custom fields on subscription version update fields
Post debit memo update fields
Update debit memo update fields
Post invoice update fields
Standalone invoice update fields
Unpost Invoice update fields
Write off invoice update fields
Journal entry update fields
Journal run update fields
Order action update fields
Advanced refunds update fields
Legacy Refunds update fields
Apply payment update fields
Unapply payment update fields
Payment update fields
Payment schedule update fields
Payment schedule item update fields
Attribute update fields
Bundle plans update fields
Bundle products update fields
Feature update fields
Product charge definition update fields
Product rate plan charge update fields
Product rate plan charge tier update fields
Product rate plan charge with dynamic pricing update fields
Product rate plan update fields
Product update fields
Revenue accounting code update fields
Taxation item update fields
Usage update fields
Best practices for import jobs in Data Loader
Best practices for update jobs in Data Loader
Best practices for delete jobs in Data Loader
Best practices for accurate field mapping
Data Loader jobs supported for cancellation
Known behavior of Data Loader
Data Loader error code reference
Data Loader FAQs
Deployment Manager overview
Create a source tenant for deployment
Run a deployment process
Revert a deployment
Deployment icons and their status
Configure email notification recipients list
Context, attributes, and dynamic pricing deployment considerations Deployment considerations for Context, Attributes, and Dynamic Pricing
Export results to CSV in Deployment Manager
Configuration templates in Deployment Manager
Create and download source template
Create a deployment using configuration template
Filters in Deployment Manager
Configure and apply filters in Deployment Manager
Create and save a quick filter
View deployment task details, history, and status
Product catalog deployment guide
Product catalog terminologies and facts
Pre-validation for product catalog deployments
Product catalog deployment using configuration templates
Feature support in Deployment Manager
Product catalog deployment best practices
Product catalog deployment reference facts
Comparison and deployment scenarios
Product catalog deployment FAQs
Revenue configurations with Deployment Manager
Deploy Revenue configuration for an OTR customer
Deploy Revenue configuration for a Revenue-only customer
Revenue configuration deployment scope and limitations
Best practices for Revenue configuration deployment
Source code integration with Deployment Manager
Deployment Manager configuration template workflow
User access control for GitHub integration
Set up GitHub account and add collaborators
Configure token settings in GitHub
Create access token from a user profile
GitHub repository permissions
Add a source code repository to Zuora tenant
Deploy metadata from GitHub repository
Deploy configurations to the target tenant with GitHub actions
Upload and sync configuration template to repository
Compare configuration templates in GitHub
Deployment scope and behavior
Workflow behavior
Custom object and custom logic behavior
Hosted payment pages behavior
Accounting period deployment behavior
Taxation component behavior
Custom fields behavior
Notifications behavior
Custom event and scheduled event deployment rules
User role and data query behavior
Reporting behavior
Platforms behavior
Experience builder behavior
Use Deployment Manager
Zuora DevOps overview
Why do companies need DevOps?
Managing Zuora environments
Automated collaboration and version control
Monitoring and observability
Application Lifecycle Management
Zuora ALM tools
Stages in application development
Data migration in Zuora Billing
OneID overview
Key Attributes for Onboarding with Zuora OneID
OneID process overview
Activate OneID for your organization
My Apps page in Zuora OneID
Access Zuora tenants through the OneID portal
Admin console overview
Central sandbox and Developer sandbox refresh
View Zuora tenants in OneID
Configure single sign-on for OneID
Configure IdPs for SSO SAML with OneID
Configure OneID for SSO SAML
Setup SSO with Google using SAML in OneID
Create custom SAML app in Google SSO
Configure Google SSO metadata in Zuora OneID
Turn On Zuora OneID SAML app for the users
Check the SSO compatibility of your custom app
Setup SSO with JumpCloud using SAML in OneID
Add Zuora OneID app to JumpCloud
Obtain JumpCloud SAML metadata URL
Assign Zuora OneID app to JumpCloud users
Assign Zuora OneID app to JumpCloud user with existing access to application
Setup SSO with Microsoft Entra ID using SAML in OneID
Add Zuora OneID application to Microsoft Entra ID
Obtain Microsoft Entra ID IDP metadata URL
Assign the Zuora OneID application to Microsoft Entra ID users
Enable provisioning using SCIM API for Microsoft Entra ID
Assign users and groups for Integrating Microsoft Entra ID with Zuora
Push a user or group manually
Setup SSO with Okta using SAML in OneID
Add Zuora OneID application to Okta
Obtain Okta SAML metadata URL for OneID integration
Assign the Zuora OneID application to Okta users
Enable provisioning using SCIM API
Setup SSO with Ping Identity using SAML in OneID
Create a Zuora OneID application in Ping Identity
Configure Ping Identity metadata in Zuora OneID
Enable SSO for users in Zuora OneID
Test the SSO configuration
View your user profile
Edit your user profile in OneID
Reset your OneID password
Users in OneID
Add a user
Activate users with activation emails
View users in OneID
Edit Users in OneID
Deactivate or reactivate users
Distinguish OneID users from tenant users
API user account management in Zuora
Create API User Roles in OneID
API User Account Types in Zuora Billing
Billing role management
Add user roles in OneID for Billing Tenants
Import user roles in OneID for Billing Tenants
Add user roles in OneID for Revenue Tenants
Export user roles report
Edit user roles in OneID
Delete user roles in OneID
Migrate to advanced roles and permission management
Billing roles and permission mangement
Add user roles for Billing tenants in OneID
Add user roles for Zephr tenants in OneID
Update user role permissions in OneID
Tenant type and modular categories
Clone user roles and permissions in OneID
User groups in OneID
Users and user group provisioning in OneID
Switch from Direct Tenant Access to Group Provisioning in OneID
Add user groups in OneID
View user groups
Edit user groups in OneID
User and user group relationships
User provisioning via direct tenant assignment
Assign tenants from the Users page
View tenant details and roles
Migrating existing user accounts from individual tenants to OneID
Migrate user accounts
FAQs on self service migration of local user accounts to OneID
User reports in OneID
Create a global user report in OneID
Create a tenant-level report in OneID
Manage reports in OneID
Global user report
Tenant-level user report
Manage OAuth 2.0 clients
Create OAuth tokens for calling Revenue APIs
Create OAuth tokens for user management APIs in One ID
Create OAuth tokens for automated user management in Okta
Create OAuth 2.0 credentials for remote MCP client
Redirect URIs by MCP client
Delete an OAuth 2.0 client in OneID
OneID settings
Manage single sign-on configurations
Submit your IdP’s SSO SAML metadata URL to OneID
Remove the SSO SAML metadata URL in OneID
Configure security policy settings for your organization
Security policy field configuration
Two-Factor Authentication for Zuora OneID
Supported authentication applications
Set Up Two-Factor Authentication as a OneID administrator
Set Up Two-Factor Authentication as a User
Set up SMS authentication in OneID
Authentication application setup
Multi-Org Support in OneID
Assign Organizational Unit access to a user in OneID
Audit Trail overview
Audit logs using OneID
Enable the new Audit log UI experience
Event Type Details and Field Definitions
View audit log reports
View login events
View settings event
Add filters to audit logs using OneID
Audit Trail for Zuora Billing, Payments, Finance, and Platform
Scope of Audit Trail for Zuora Billing, Payments, Finance, and Platform
Audit Trail for Zuora Revenue
View Audit trail report for Zuora Revenue
Scope of Audit Trail for Zuora Revenue
Data Model of Audit Trail
Table auditloginevent
Table auditsettingchangeevent
Table auditobjectchangeevent
Sample Queries of Audit Trail
Retrieve the login history
Retrieve the setting changes
Retrieve the user management setting changes
Retrieve Account changes
Retrieve Product Catalog changes
Retrieve Chase Orbital Payment Gateway changes
Retrieve Notification Definition changes
Retrieve Workflow changes
Retrieve Custom Logic changes
Retrieve custom field definition changes
Retrieve custom object changes
Retrieve Order Action Changes
Retrieve Order changes
Retrieve Subscription Changes
Overview of Zuora Observability Connector
Configure event streaming and monitoring in OneID
Configure Splunk integration from Integration Hub
Configure Sumo Logic integration for Observability connector
Configure Datadog integration for Observability Connector
Export Audit Logs to Splunk in OneID
Create a streaming schedule
General Data Protection Regulation
Configure PII anonymization
Zuora Protect Overview
Zuora Platform Encryption Concepts
Enable Zuora Protect platform encryption for your organization
Zuora Key Management System
Create a new Zuora Managed Key
Bring your own keys
Import encryption keys
Assign keys to your Zuora tenants
Support Fields for BYOK Encryption
Zuora Protect FAQ
Zuora Platform Encryption Glossary
Enhanced Audit Trail for Zuora Protect
View Enhanced Audit Trail logs
Apply filters to Enhanced Audit Trail logs
Administrator settings
Add an OAuth 2.0 provider
Retrieve the ID of an OAuth 2.0 provider
API Versioning
Security Policies
User roles
Billing roles
Payments roles
Platform roles
Finance roles
Commerce roles
Reporting roles
Create a custom user role
Manage API users
Create an API user process flow
Create an API user role
Assign the API user role to a user
Create an OAuth client for a user
Data Access Control
Implement Data Access Control process overview
Create a tag hierarchy
Step 2: Apply tags to objects
Step 3: Apply tags to users
Manage your tenant profile
Configure CSV injection protection for attachments
Default behavior for CSV injection protection
Behavior when a risky file is uploaded
Update tenant settings
Actions before changing time zone
Process existing usage charges
What happens after changing time zone
DateTime field behavior after changing your time zone
SOAP API
Data Source Exports
Export ZOQL
Enable platform features by yourself
AQuA Stateful Time Offset
Overview of Multi-entity
Introduction to entity and entity hierarchy
Management of entity and entity hierarchy
Add an entity to an entity hierarchy
Provision an entity in a entity hierarchy
Edit the global entity information from Zuora UI
Edit the unprovisioned sub-entity information from Zuora UI
Edit the provisioned sub-entity information from Zuora UI
Remove an entity from the entity hierarchy
View entity hierarchy in Multi-entity
Managing status of entities
Business objects sharing across entities
Accounting periods sharing across entities
Products sharing across entities
Share a product with a target entity
Setup an entity connections for object sharing
Target entity configuration for product sharing
Configure product attribute control setting
Configure shared object settings in a target entity
Export an object sharing exception report
User management in Multi-entity environments
User deactivation in Multi-entity environments
Deactivate a user who owns entity connections
User access within Multi-entity hierarchy
Grant user access to other entities
Send a user access request
Accept the user access request
Deny user accesses
Single sign-on for Zuora within Multi-entity
Overview of Multi-Org
Multi-Org activation and setup
Basic concepts and terms of Multi-Org
Multi-Org and invoice settlement harmonization
API enhancements for Multi-Org
Multi-Org best practices and key considerations
Multi-Org upgrade models
Upgrade single tenant to Zuora Multi-Org
DAC to Multi-Org migration
Upgrade a DAC tenant to Multi-Org through APIs
Multi-entity to Multi-Org migration
Upgrade a Multi-entity sub-entity to Multi-Org
Create an org hierarchy
Add a root org unit
Edit a root org unit
Add a child org unit
Edit a child org unit
Assign users to one or more Org units
Change the default Org unit for the user
Org label modifications in Multi-Org
Configure accounting codes, accounting and GL segmentation rules
Configure currency conversion settings
Best practices for currency conversion settings
Create an accounting period and run trial balances
Create a bill run
Create a scheduled bill run as a batch
Create a customer account and add subscriptions
Assign an organization to an account
Create a journal run
Create a new product in the product catalog
Update an existing product in the product catalog
Create a payment and status check
Create a subscription through an order
Run a roll-up report
Multi-Org in Zuora Revenue
Multi-Org - Billing and Revenue mapping for Order to Revenue
Setup Multi-Org for billing and revenue integration
Configure multiple organizations in Quote Studio
Custom field overview
Custom fields and legacy custom fields
Identify legacy custom fields on a standard object
Custom field types
Custom field settings
Custom field management with the Object Manager
View custom fields
Create custom fields
Modify custom fields
Delete custom fields
Monitor custom field jobs
Legacy custom field management
View legacy custom fields
Create legacy custom fields
Modify legacy custom fields
Delete legacy custom fields
Share custom fields with sub-entities
Objects that support custom fields in Zuora
Custom Logic overview
Decision table overview
Create a decision table
Decision tree overview
Create a decision tree
Function overview
Function format
Format of validation functions
Format of formula functions
Create a function from scratch
Create a function from templates
Update a function
Activate a function
Delete a function
Test a function
Validation function use cases
Formula function use cases
Objects and fields supported by Custom Logic
Account fields supported by Custom Logic
Contact fields supported by Custom Logic
Credit Memo fields supported by Custom Logic
Debit Memo fields supported by Custom Logic
Invoice fields supported by Custom Logic
Order Line Item fields supported by Custom Logic
Payment fields supported by Custom Logic
Rate Plan Charge fields supported by Custom Logic
Rate Plan fields supported by Custom Logic
Refund fields supported by Custom Logic
Subscription fields supported by Custom Logic
Custom Objects overview
View custom object definitions
Create a new custom object definition
Delete a custom object definition
Add custom fields to custom object definitions
Edit custom fields in custom object definitions
Delete a custom field from a custom object definition
Import custom object definitions
Export custom object definitions
JSON example for import
Use case of display name in custom objects
Custom object record management
View custom object records
Create a new custom object record
Edit a custom object record
Delete a custom object record
Delete all custom object records of a custom object
Create custom object records in bulk
Update custom object records in bulk
View custom object bulk jobs
Management of related custom object records on standard object detail pages
View related custom object records
Create a related custom object record
Edit a related custom object record
Query syntax of custom object records
Simple query
Complex query using boolean operators
Custom Objects API
Custom Objects API error code
Events and Notifications overview
Standard event overview
Standard events for Zuora Billing
Standard events for Zuora Payments
Standard events for Zuora Finance
Standard events for Zuora Platform
Configure email notifications for Upcoming Renewal standard event
Configure notifications for the API Performance event
Mute notifications for System Health dashboard events
Parent and event category code for Events and Notifications
Custom event overview
Create a custom event
View custom events and custom scheduled events
Edit a custom event or a custom scheduled event
Activate or inactivate a custom event or a custom scheduled event
Clone a custom event or a custom scheduled event
Delete a custom event or a custom scheduled event
Supported base object for custom events
Sample code for custom events
Zuora custom event overview
Zuora custom events for Orders
Zuora custom events for other features
View Zuora custom events
Custom scheduled event overview
Create a custom scheduled event
Supported base object and field for custom scheduled events
Walkthrough for creating a custom scheduled event and notification
Condition builder overview
Add conditions and groups
Available comparison operators
Examples of conditions for common use cases
Email template overview
Create an email template
Specify basic template information
Specify email subject and body
View email templates
Preview an email template
Add custom email headers
Clone an email template
Insert multimedia components into email templates
Reusable block configuration in email templates
Create reusable blocks
Embed reusable blocks into email templates
Edit reusable blocks
Callout template overview
Create a callout template
Insert merge fields into callout templates
Insert merge fields into the request body of callout templates
Preview the callout request of a callout template
View callout templates
Merge field syntax
Data source merge fields
System merge fields
Examples of using merge fields
Create a notification
Define trigger
Select a related event
Set system and custom filters
Set delivery options
Define target accounts
Finalize notification details
Review notification
View notifications
Edit a notification
Edit notifications in bulk
Assign communication profiles for a notification
Callout notification overview
Report on notification histories
View notification histories
Resend a notification history
Sample queries for querying notification histories through Data Query
Communication profile overview
Configure communication profiles
Create a communication profile
Link a communication profile to a customer account
View communication profiles
Edit a communication profile
Activate or deactivate all communication profiles
Flexible communication profile
SMTP server for email notifications
Enable Zuora default email server
Configure external SMTP server
Common error messages and actions for external SMTP server
Configure external SMTP servers for Microsoft 365 using OAuth
Create an OAuth 2.0 Provider using the Authentication Code grant type
Configure the external SMTP server settings for Microsoft 365
Configure advanced SMTP server
Verify a domain identity
Verify an email identity
Email deliverability configuration for email notifications and Workflow
Configure callout settings
Mediation overview
Meters overview
Streaming and batch meters
Meter statuses
Create a meter based on a meter type
Create a custom meter
Audit Trail for meter runs
Audit Trail for meter errors
Export error records
Download Center
Stop a meter
Prefetch in Mediation
Check and refresh prefetch data
View prefetch history
Metering APIs
Retrieve summary data API
Retrieve audit trail entries API
Create audit trail export job API
Retrieve audit trail export jobs API
Retrieve presigned download URL API
Example workflow
Runtime configuration for meter runs
Events overview
Create an event definition
Events Dashboard
Ingestion source analysis
Event Store
Configure an Event Store as a source
Configure an Event Store as a target
Re-run a meter with an Event Store source
Configure a meter with Event Store backfill
Event store data APIs
Meter Audit counts and Event Store counts
Event Store timezone impact
Notifications in Mediation
Meter Session Status Change
Meter Session Periodic Status Update
Event Store Query Status Changed
Configure Mediation Notifications
Meter components overview
Streaming API as a source
Configure a Streaming API as a source
Configure Amazon S3 as a source
Snowflake as a source
Design queries for Snowflake source runs
Schedule and run Snowflake source meters
Configure Snowflake as a source
Snowflake configuration parameters
Kafka as a source
Configure Kafka as a source
Configure Upload File as a source
Configure Amazon S3 as a target
Configure Snowflake as a target
Kafka as a target
Configure Kafka as a target
Configure Usage Records as a target
Empty Sink
Configure Empty Sink as a target
Enrichment processor
Configure an Enrichment processor (Product or Account data)
Configure an Enrichment processor (Standard Identifiers)
Filter processor
Filter processor operators
Configure Filter as a processor
Deduplicator processor
Deduplicator behavior in batch and streaming meters
Deduplicator examples
Configure Deduplicator as a processor
Aggregator processor
Aggregator operators
Configure an Aggregator as a processor
Accumulator processor
Accumulator processor - field reference
Configure an Accumulator as a processor
Advanced Transformer
Advanced Transformer metadata
Advanced Transformer use cases
Configure Advanced Transformer as a processor
Currency Lookup processor
Currency Lookup processor - field and error reference
Configure Currency Lookup as a processor
Configure Map as a processor
Map processor examples
Rating processor
Configure a Rating processor
Attribute-Based Pricing in the Rating processor
HTTP processor
Configure a HTTP processor
Connection configuration references
Connection configuration examples
Troubleshooting HTTP processor configurations
Python support in advanced processors
Delta operator behavior in Mediation
Mediation code editors
Advanced Transformer code editor
Advanced Accumulator code editor
Advanced Aggregator code editor
Mediation code editor guide
Manage connections in meters
Create HTTP connections in meters
Create AWS S3 connections in meters
Create a Zuora-managed S3 connection
Create an external AWS S3 connection
Create Snowflake connections in meters
Prepare a Snowflake user and role for Mediation
Define the Snowflake connection
Configure Snowflake authentication
Configure Zuora-managed S3 for Snowflake (Credentials)
Configure Zuora-managed S3 for Snowflake (Storage Integration, Inline)
Configure Zuora-managed S3 for Snowflake (Storage Integration, Stage)
Validate and activate the Snowflake connection
Create Kafka connections in meters
Define the Kafka connection
Security options for Kafka connections
Configure Kafka authentication
Validate and activate the Kafka connection
Data refresh from Production to Central Sandbox (CSBX) for Mediation
System errors
Data & Operator errors
External Service errors
Dashboard Summary errors
Authentication & Authorization errors
Meter Lifecycle errors
Event Definition errors
Meter Import & Configuration errors
Script errors
Event Store errors
File, ZDP & Prefetch errors
Source & Target Validation errors
Pipeline Validation errors
Package Management errors
Replay and Reprocess errors
Scheduler & Prefetch errors
SQL & Miscellaneous errors
Zuora Mediation Model Context Protocol
Mediation MCP scope
Mediation MCP prerequisites
Connect to the Zuora remote MCP
Create OAuth 2.0 credentials
Configure the redirect URI
Select the MCP server endpoint
Configure the MCP client
Permissions and safe operation
Manage meters with Mediation MCP
Run and monitor meters with Mediation MCP
Investigate and export audit data
Common Mediation MCP workflows
Install the Mediation MCP skill in Cursor
Object Manager overview
Schema Visualizer overview
View the schema of your data model
View the relationships between a specific object and other objects
Search for indexed fields
Open the custom field list page
Create a custom field
Update a custom field
Delete a custom field
Experience Builder overview
Key capabilities of Experience Builder
How Experience Builder helps
AI agent capabilities
AI Agent usage
Create pages and components using AI Agent
Connect and test Agent-generated navigation using AI Agent
Retrieve and verify tenant data using AI Agent
Correct data not displayed using AI Agent
Review and clean up Agent-generated queries
Test Agent-generated interactions
Recover from a recent Agent change
Restore a known-good version
Start a new Agent chat
Troubleshooting the Agent
Visual page building
Reusable components
Design system support
Responsive design support
Localization and experimentation
Data and integration capabilities
Content and personalization
Developer extensibility
Deployment and publishing
Common use cases for Experience Builder
Experience Builder technical overview
User Account Management
Manage Account Linking
Create a user account using Account Sync
Send Activation email to users
Configure Login Page URLs
Configure login redirection in User Accounts Settings
Create Custom Role for Experience Builder
Manage User Accounts
Configure custom fields for user account creation
Manage Authentication
Configure External JWT
View Audit Trail
Zuora Experiences Canvas component package installation in Salesforce
Install the Zuora Experiences Canvas component package
Create the External Client App in Salesforce
Register the Salesforce org in Zuora Domain Manager
Configure access policy for the External Client App
Restrict access to selected users
Add the Zuora Experience component to a Lightning page
Troubleshooting common setup issues with Salesforce
Experience Builder projects
Experience Builder project contents
Set up an external API integration
Zuora domains and hosting
Host a project in a React application
Host a project in an HTML JavaScript application
Host a project with Zuora using domains and hosting
Publish the project to the hosted domain
Experience Builder project publishing
Create a new project
Create a new page
Zuora Workflows with Experience Builder
Trigger Zuora workflows from Experience Builder: Process flow
Experience Builder pages
Pages and components
Page properties
Linking
Special page types
Page layout component in Experience Builder
Page layout customization and replacement
Style tokens in Experience Builder
Style token organization and semantic tokens
Create a style token from the Design panel
Create a style token from the Style Tokens panel
Apply a style token
Share tokens across projects
Control element visibility
Configure element visibility
Create a dynamic visibility condition
Common use cases
Visibility versus conditional rendering
Best practices
Style presets
Create a style preset from the Style Presets area
Create a style preset while editing a document
Extract existing styles into a style preset
Responsive design
Screen artboards, breakpoints and variants
Define breakpoints
External authentication with a custom login system
Choose an external login setup
Configure external login settings
Set the external login cookie
Create signing keys and publish JWKS
Use an existing identity provider
Validate external login
External login tenant settings
External login cookie attributes
External login JWT claims
External login responsibilities
External login validation checklist
Use case example
Integration responsibilities
Quick checklist to go live
Common errors
Workflow overview
Basic concepts of Workflow
limits
Workflow user interface
Integrate Workflow with Configurable Payment Retry
Make API Calls to Salesforce from Workflow
Workflow APIs
API endpoints and modes for triggering a workflow
Manage access permissions for Workflow
Assign users Workflow access process flow
Create a custom platform role for Workflow
Assign a platform role to a Workflow user
Enable alert notifications for workflow failures
Enable email notifications for a specific workflow
Enable email notifications for all workflow instances in the tenant
Configure OAuth login for Workflow
Configure global constants of Workflow
Workflow maintenance settings
Authentication providers for Workflow
Add an authentication provider for Workflow
Use authentication providers in Workflow tasks
Use an authentication provider for external SMTP
Create and run a workflow
View your workflow access permissions
Edit a workflow
Allowed actions on a workflow
Configure the settings of a workflow definition
Workflow-specific settings
Approve or reject approval tasks in Workflow
Approve or reject approval tasks from Zuora inbox
Export and import a workflow
Manage workflow versions
Workflow versioning overview
Create a workflow version
Edit a workflow version
Set a workflow version as the active version
Configure settings of a workflow version
Delete workflow versions
Export a specific version of a workflow definition
Upload a CSV file in a workflow
Uploaded file processing
Apply late fees to accounts with overdue invoices process flow
Create a rate plan for late fees
Configure task parameters of the workflow
Configure the workflow to run on a schedule
Chargebacks: Write off invoices and cancel subscriptions
Customize invoice templates using HTML
Notify accounts about overdue invoices
Perform payment gateway reconciliations with Workflow
Process a large number of refunds
Suspend subscriptions and send notifications
Resume subscriptions and send notifications
Retrieve and format tax data for bulk upload
Liquid expressions in Workflow
Filters for date and time
Filters for array manipulation
String utilities
Filters for Zuora utilities
Encoding
Encryption in Liquid expressions
Other filters
Example: Use cases for tags
Use the strict variables option to verify Liquid expression
Workflow helper objects for retrieving data
WorkflowInstance
WorkflowSetup
TaskInstance
Credentials.zuora
Workflow task overview
Retrieve: Query
Retrieve: Query - Task settings
Retrieve: AQuA Query
Retrieve: AQUA Query - Task settings
Retrieve: Billing Preview Run
Retrieve: Data Query
Retrieve: Export
Retrieve: Export - Task settings
Retrieve: Object Query
Retrieve: Object Query - Task settings
Logic: If
Logic: Case
Logic: Iterate
Logic: Liquid
Logic: Lambda
Guidelines about using Lambda tasks in Workflow
Upload a Lambda function to Workflow
Logic: CSV Translator
Logic: XML Transform
Logic: JSON Transform
Logic: Response Formatter
Example: Configure responsive UI actions in Workflow
Logic: Merge
Use the Merge task in Workflow
Example: Use the merge task in a workflow
Script: JavaScript
CRUD: Create
CRUD: Update
CRUD: Delete
Custom Object: Create Record
Custom Object: Update Record
Custom Object: Delete Record
Custom Object: Query Record
File: Attachment
File: Custom Document
File: Bulk Data Loader
File: Bulk Data Loader - Task settings
File: Download File
File: File Operations
File: File Operations - Task settings
File: Zuora Import
Reporting: Run Report
Configure the Run Report task
Amendments: New Product
Amendments: Remove Product
Amendments: Suspend
Amendments: Suspend - Task settings
Amendments: Resume
Amendments: Cancel
Amendments: Cancel - Task settings
Billing: Bill Run
Billing: Bill Run - Task settings
Billing: Invoice Generate
Billing: Invoice Generate - Task settings
Billing: WriteOff
Billing: Reverse Invoice
Billing: Currency Conversion
Billing: Currency Conversion - Task settings
Billing: Custom Billing Document
Billing: Custom Billing Document - Task settings
Data manipulation in HTML templates
View the output
Download: Amazon S3
Download: Amazon S3 - Task Settings
Download: SFTP
Download: SFTP - Task Settings
Algorithms and other available options
Payment: Payment Run
Payment: Payment Run - Task settings
Payment: Gateway Reconciliation
Usage: Import Usage
Notifications: Email
Use an external SMTP server
Notifications: Callout
Example: Use HMAC authentication in a callout task
Notification: SMS
Execute: Workflow
Manual: Approval
Manual: Approval - Task settings
Time: Delay
Mediation: Send Events
Upload: Amazon S3
Upload: Amazon S3 - Task settings
Upload: FTP
Upload: FTP - Task settings
Upload: SFTP
Upload: SFTP - Task settings
Multi-entity in Workflow
Specify the entity for a task
Task types that support the Entity selector
Entity selection for Callout tasks
Monitor workflows
Troubleshoot workflow tasks
Use Data Query to report on Workflow
Examples: SQL queries
Workflow and task metrics
Revenue tasks in Workflow
Use revenue tasks in Workflow
Configure a Revenue task
Register a Workflow as a Revenue background job
Supported operation families
Use link and delink Revenue tasks in Workflow
Workflow role access privileges in Revenue
Example Workflow patterns for Revenue operations
REST API
Resource codes for Billing and Payments REST API
SOAP API overview
Zuora SOAP API version history
Zuora WSDL
WSDL data types
Check WSDL versions
Zuora WSDL download URLs
Date field changes in the WSDL
Custom fields in SOAP objects
Use custom fields with the SOAP API
Considerations when editing custom fields
SOAP API object relationships
Working with SOAP
Implementation Considerations
Sessions
SOAP API standards
SOAP API sample source code
Sample SOAP: Capture SOAP/XML
Error handling in SOAP API
Errors
Faults
SOAP API calls overview
amend()
Request: AmendRequest
AmendOptions for amend()
Additional field details
PreviewOptions
ExternalPaymentOptions
Response: AmendResult
Example: amend() call
BillingPreview()
create()
delete()
execute()
generate()
update()
query()
Query usage on an account
Query processed usage
queryMore()
subscribe()
Invoke the subscribe() call
Preview an invoice using subscribe()
Sample code for the subscribe call
Sample code for previewing a subscription
login()
Sample code for login() call
Sample code for Multi-entity
Field types
Objects and their supported calls
Create, query, update, delete
Subscribe, generate, amend
Account
Account object limits
Field descriptions of Account
Additional field details of Account
Example: Create a customer account
AccountingCode
Field descriptions of AccountingCode
Amendment
Field descriptions of Amendment
Additional field details of Amendment
Remove a Product (Amendment)
Remove a Product from a Subscription (API versions 24.0 and earlier)
AccountingPeriod
Field descriptions of AccountingPeriod
Additional field details of AccountingPeriod
BillingPreviewRun
Field descriptions of BillingPreviewRun
Field descriptions of the CSV output file
Additional field details of BillingPreviewRun
BillRun
Field descriptions of BillRun
Communication Profile
Field descriptions of CommunicationProfile
Contact
Field descriptions of Contact
ContactSnapshot
Field descriptions of ContactSnapshot
CreditBalanceAdjustment
Field descriptions of CreditBalanceAdjustment
DiscountApplyDetail
Field descriptions of DiscountApplyDetail
Export
Usage
Field descriptions of Export
Additional field details of Export
Example: Create an export
Feature
Field descriptions of Feature
Import
Field descriptions of Import
Invoice
Field descriptions of Invoice
Additional field details of Invoice
Example: Generate an invoice
InvoiceAdjustment
Field descriptions of InvoiceAdjustment
Additional field details of InvoiceAdjustment
InvoiceFile
Field descriptions of InvoiceFile
InvoiceItem
Field descriptions of InvoiceItem
Additional field details of InvoiceItem
InvoiceItemAdjustment
Field descriptions of InvoiceItemAdjustment
Examples
InvoicePayment
Field descriptions of InvoicePayment
Additional field details of InvoicePayment
InvoiceSplit
Field descriptions of InvoiceSplit
InvoiceSplitItem
Field Descriptions of InvoiceSplitItem
Additional field details of InvoiceSplitItem
Payment
Field descriptions of Payment
Additional field details of Payment
Pass gateway parameters
Apply payments to an invoice
Apply payments to an invoice: streamlined method
Apply payments to an invoice: original method
Handle overpayments
Handle overpayment of an invoice
Handle payments not applied to any invoices (payment for future charges)
PaymentMethod
Field descriptions of PaymentMethod
Additional field details of PaymentMethod
PaymentMethodSnapshot
Product
Field descriptions of Product
ProductDiscountApplyDetail
Field descriptions of ProductDiscountApplyDetail
ProductFeature
Field descriptions of ProductFeature
ProductRatePlan
Field descriptions of ProductRatePlan
Additional field details of ProductRatePlan
ProductRatePlanCharge
Fields related to Prepaid with Drawdown
Field descriptions of ProductRatePlanCharge
Additional field details of ProductRatePlanCharge
Example: Use ProductRatePlanCharge
ProductRatePlanChargeTier
Field descriptions of ProductRatePlanChargeTier
Additional field details of ProductRatePlanChargeTier
RatePlan
Field descriptions of RatePlan
Additional field details of RatePlan
RatePlanCharge
Field descriptions of RatePlanCharge
RatePlanChargeTier
Field descriptions of RatePlanChargeTier
Additional field details of RatePlanChargeTier
Refund
Field descriptions of Refund
Refund all or part of a customer's credit balance
RefundInvoicePayment
Field descriptions of RefundInvoicePayment
Additional field details of RefundInvoicePayment
Subscription
Field descriptions of Subscription
Additional field details of Subscription
SubscriptionProductFeature
Field descriptions of SubscriptionProductFeature
TaxationItem
Field descriptions of TaxationItem
TaxableItemSnapshot
Field descriptions of TaxableItemSnapshot
UnitOfMeasure
Field descriptions of UnitOfMeasure
Usage
Field descriptions of Usage
Additional field detail of Usage
zObject
Field descriptions of zObject
SOAP API complex types
AmendOptions
AmendRequest
AmendResult
BillingPreviewRequest
BillingPreviewResult
CallOptions
ChargeMetricsData
DeleteResult
InvoiceData
InvoiceProcessingOptions
LoginResult
PreviewOptions
QueryOptions
QueryResult
RatePlanChargeData
RatePlanData
SaveResult
SessionHeader
SubscribeOptions
SubscribeRequest
SubscribeResult
SubscriptionData
SubscriptionProductFeatureList
Integration Hub overview
Finding your next connector
Pre-Built Connectors
CRM / Commerce Connectors
CPQ Connectors
ERP Connectors (with Zuora Billing)
ERP Connectors (with Zuora Revenue)
Data Warehouse Connectors (BYOW)
Overview of Connector Listing Concepts
Field mapping tools overview
Functionality-specific default mappings
Use Functionality-Specific Default Mappings
Field Mapping Page Layout
Available fields in Field Mapping
Field mapping actions
Field mapping transformations
Filters in Integration Hub mapping
Monitoring and error handling
Configure a scheduled synchronization job
Get started with Core Applications on Zuora Connect
Create an OAuth tenant login in Zuora Connect
Create basic authentication login in Zuora Connect
Install an app you purchased in Zuora
Link your Connect account to your Zuora account
Purchase an app from the Integration Hub
Share an app instance
FAQ for sharing app instances
Monitor Integration Hub connector jobs in System Health
Understand the Integration Hub job list
Notifications for Integration Hub Connector Jobs
Locate the Integration Hub Job event
Create an Email Notification for Completed jobs
Configure Callout Notifications for External Systems
Configurable Summary Level GL Interface
Install the GL Interface
Configure the GL Interface
GL Interface troubleshooting guide
Using the GL Interface
Create a schedule for summary runs
Perform an ad-hoc summary run
Download the file exported from a summary run
Enhanced Invoice Numbering
Configure Enhanced Invoice Numbering
Disable automatic posting of Bill Runs in Zuora
Add custom fields for the App in Zuora
Configure notifications for the App in Zuora
Configure Settings in the App
Using Enhanced Invoice Numbering
Create a new entity
Functionality Specific Default Mappings
Using Functionality Specific Default Mappings
Prepaid Drawdown
Set Up Prepaid Drawdown
Add new extension
Configure custom fields
Add reason code
Using Prepaid Drawdown
Configure prepayment charge within product rate plan
Configure drawdown charge within product rate plan
Use Prepaid Drawdown App
Examples of Prepaid and Drawdown Configuration
Promo Codes
Configure campaigns
Configure a campaign
About Intelli codes
Work with Intelli codes
Create Intelli promotion
Add rules to Intelli promotion
Examples of campaign configuration
Assign single-use codes
Configure custom fields
Manage promotion codes
Create a promo code
Import promotion codes
Export multi-use codes
Export single-use codes
Copy or move child campaigns
Update child campaign configuration
Archive child campaigns
Delete child campaigns
Set up callouts
Subscriber Portal
Subscriber portal overview
Getting Started with Subscriber Portal
Custom endpoints
Use custom endpoints
Configure custom endpoints
Configure portal features
Settings for different providers
Configure user interface
Example of configuring bootstrap columns
Example of configuring custom panels
Example of configuring email templates
Work with Subscriber Portal
Invite users to portal
Invite Multiples Users
Additional User Actions
Activate User From Portal
View activation activities
Zuora 360 release notes
Zuora 360 overview
Zuora 360 Sync types
Zuora 360 Sync Types for Billing Accounts and Related Objects
Zuora 360 Sync Technologies and Sync Modes
Add the on-demand button to account layout
Add the on-demand button to billing account layout
Migrate settings for Zuora 360
Migration Keys and Zuora 360 versions
Synchronize data from Zuora to Salesforce through Zuora 360
Manual sync
Scheduled sync
Real-Time sync
Advanced sync settings
Account audit, sync notification, and sync retry in Zuora 360 for Salesforce
View sync history
Monitor sync and cleanup jobs in Salesforce
Delete the sync history records
Real-Time sync for Zuora 360
About turbo sync
Performance benchmarks for turbo sync
On-Demand sync
Migrate data for on-demand sync
Trigger On-Demand sync from Zuora Billing
About 360 sync cleanup
Perform sync cleanup in Zuora UI
Zuora 360 objects mapping
Sync field mapping of product catalog related objects for Zuora 360
Sync field mapping of subscription and related objects for 360
Sync field mappings of account and related objects
Upgrade Zuora 360
Assign page layouts to user profiles
Update the invoice page layout
Grant access to new apex classes
Review date and time fields
User profile permissions for objects and fields
Grant permissions for new custom fields
Grant Permissions on new custom objects
Migration keys for migration field sets
Migrate new fields via migration custom settings
Zuora 360 syncs and Salesforce limits
Installation
Install Zuora 360 package
Deploy Zuora 360 package manually
Set up Sync Credentials to Connect to Salesforce
Sync User Requirements
Set up the connection to Salesforce using Salesforce credentials
Set up the connection to Salesforce using OAuth credentials
Configure Account Layout in Salesforce
Configure Billing account layout
Configure Subscription account layout
Configure Subscription Product Charges account layout
Configure Invoice account layout
Set Permissions for Zuora 360 package
Set Permissions for Zuora 360 Custom Objects
Disable Chatter Feed for Subscription
Map Salesforce Accounts to Zuora Accounts
Configure Connection Settings
CRM Account ID
Change One CRM Account ID
Change CRM IDs for Multiple Accounts Using the Zuora API
Grant a profile access to the Apex classes
Enable History Tracking for the Account Field
Generate a security token
Import the WSDL into Zuora 360
Set up a schema
Assign and Configure Page Layouts for Payment and Invoice
Assign Payment Page Layout
Assign the Billing Account page layout to user profiles
Customize an existing Billing Account page layout to add the Invoice Payments related list
Assign the Account page layout to user profiles
Customize an existing Account page layout to add the Payments related list
Assign the ZInvoice page layout to user profiles
Customize an existing ZInvoice page layout to add the Invoice Payments related list
Assign the Invoice Payment Page Layout for user profiles
Customize an existing Invoice Payment page layout to add the Payments related list
Assign the Refund page layout to user profiles
Customize an existing Refund page layout to add the Payments related list
Merge Accounts
Work with Zuora 360
Create automated reports in Salesforce using Zuora 360
Real-time sync for Zuora 360
Synchronize multiple currencies
Synchronize Self-Service Orders
Synchronize Zuora custom fields
View invoice PDF
New object types supported only when Zuora 360+ enabled
Invoice Item: Zuora__InvoiceItem__c
Deprecated fields
Taxation Item: Zuora__TaxationItem__c
Credit Memo: Zuora__CreditMemo__c
Credit Memo Item : Zuora__CreditMemoItem__c
Credit Memo Part: Zuora__CreditMemoPart__c
Debit Memo: Zuora__DebitMemo__c
Debit Memo Item : Zuora__DebitMemoItem__c
Payment Part : Zuora__PaymentPart__c
Refund Part: Zuora__RefundPart__c
Subscription : Zuora__SubscriptionHistory__c
Zuora Subscription Fields Synced in Zuora 360+
Zuora Subscription fields synced in Zuora 360 but not in Zuora 360+
Zuora Subscription fields synced with different values in Zuora 360 and in Zuora 360+
Rate Plan : Zuora__SubscriptionRatePlan__c
Zuora SubscriptionRatePlan Fields Synced in Zuora 360+
Zuora SubscriptionRatePlan fields synced in Zuora 360 but not in Zuora 360+
Rate Plan Charge : Zuora__SubscriptionProductChargeHistory__c
Zuora RatePlanCharge Fields Synced in Zuora 360+
Zuora RatePlanCharge fields synced in Zuora 360 but not in Zuora 360+
Rate Plan Charge Tier : Zuora__SubscriptionChargeTierHistory__c
Zuora RatePlanChargeTier Fields Synced in Zuora 360+
Zuora Rate Plan Charge Tier fields synced in Zuora 360 but not in Zuora 360+
Object types upgraded by Zuora 360+
Invoice object synchronization
Invoice payment object synchronization
Zuora Invoice Payment Fields Synced in Zuora 360+
Zuora Invoice Payment fields synced in Zuora 360 but not in Zuora 360+
Payment object synchronization
Zuora Payment fields synced in Zuora 360+
Zuora Payment fields synced in Zuora 360 but not in Zuora 360+
Payment method object synchronization
Zuora Payment Method fields synced in Zuora 360+
Zuora Payment Method fields synced in Zuora 360 but not in Zuora 360+
Product object synchronization
Zuora Product Fields synced in Zuora 360+
Zuora Product Fields Synced in Zuora 360 but Not in Zuora 360+
Refund object synchronization
Zuora Refund fields synced in Zuora 360+
Zuora Refund fields Synced in Zuora 360 but not in Zuora 360+
Refund invoice payment object synchronization
Zuora Refund Invoice Payment fields synced in Zuora 360+
Zuora Refund Invoice Payment fields synced in Zuora 360 but not in Zuora 360+
Sync Field Mapping of Account and Related Objects for Zuora 360
Account: Zuora__PaymentTerm__c
Account: Zuora__CustomerAccount__c
Payment Method: Zuora__CustomerAccount__c
Contact: Zuora__CustomerAccount__c
Account: Zuora__Subscription__c
Account: Zuora__SubscriptionProductCharge__c
Account: Zuora__SubscriptionProductFeature__c
Invoice :Zuora__ZInvoice__c(Account)
Invoice Item : Zuora__InvoiceItem__c(Account)
Taxation Item : Zuora__TaxationItem__c(Account)
Credit Memo: Zuora__CreditMemo__c (Account)
Credit Memo Item: Zuora__CreditMemoItem__c (Account)
Credit Memo Part: Zuora__CreditMemoPart__c (Account)
Debit Memo: Zuora__DebitMemo__c (Account)
Debit Memo Item: Zuora__DebitMemoItem__c (Account)
Payment Part : Zuora__PaymentPart__c(Account)
Refund Part : Zuora__RefundPart__c(Account)
Payment : Zuora__Payment__c(Account)
Invoice Payment : Zuora__PaymentInvoice__c(Account)
Refund : Zuora__Refund__c(Account)
Payment Method : Zuora__PaymentMethod__c(Account)
Sync Field Mapping of Product Catalog and Related Objects for Zuora 360+
Product : Zuora__Product__c(Product catalog)
ProductRatePlan : zqu__ProductRatePlan__c(Product Catalog)
ProductRatePlanCharge : zqu__ProductRatePlanCharge__c
Feature : zqu__ZFeature__c
ProductFeature : zqu__ZProductFeature__c
Sync Field Mapping of Subscription and Related Objects for Zuora 360+
Subscription : Zuora__Subscription__c
Account : Zuora__Subscription__c (Subscription)
Rate Plan : Zuora__SubscriptionRatePlanHistory__c
Rate Plan Charge : Zuora__UnitOfMeasure__c
Rate Plan Charge:Zuora__SubscriptionProductCharge__c
Product : Zuora__SubscriptionProductCharge__c
Zuora connector for Salesforce CRM
Getting started with Zuora connector for Salesforce CRM
Install Zuora 360 package for Salesforce
Deploy Zuora 360 package manually
Set up sync credentials to connect to Salesforce
Set up Salesforce connection using credentials
Use and manage OAuth credentials
Key information after upgrading from Zuora 360
Salesforce refresh best practices: ensuring seamless data transition
Zuora Salesforce CRM sync cleanup for full synchronization
Configuration of Salesforce user credentials
Update customer account CRM org Id
Update Zuora Quotes and Zuora Salesforce CRM sync connection settings
Sync product catalog from Zuora tenant
Refresh Zuora sandbox with Salesforce sandbox
Configure and assign page layouts
Assign payment page layout
Configure and assign the Billing Account page layout
Configure and assign the ZInvoice page layout
Configure and assign the Account page layout
Configure and assign the invoice payment page layout
Configure and assign the refund page layout
Configure account layout in Salesforce
Configure billing accounts layout
Configure subscriptions layout
Configure invoices layout
Configure connection settings for Salesforce CRM
Deprecated: Use single subscription and amendments
Migrate subscription and charge numbers
Troubleshooting single subscription
Disable chatter feed for subscription
Edit a CRM account ID
Change one CRM account ID
Change CRM IDs for multiple accounts using the Zuora API
Grant custom object permissions to a profile
Grant a profile access to the Apex classes
Grant a profile access to the Visualforce pages
Enable history tracking for the account field
Generate a security token
Import the WSDL
Set up a schema
Map Salesforce accounts to Zuora accounts
Retrieve Salesforce account IDs
Associate the Salesforce account ID with Zuora account ID
Merge Salesforce account with Zuora
Set permissions for Zuora Salesforce connector package
Set permissions for custom objects
Zuora Connector for Salesforce CRM authentication migration
Migrate from Zuora 360 to Zuora Connector for Salesforce CRM
Configure OAuth client credentials authentication
Objects and field mapping
Field mapping of account and related objects
Account: Zuora__PaymentTerm__c
Account: Zuora__CustomerAccount__c
Payment Method: Zuora__CustomerAccount__c
Contact: Zuora__CustomerAccount__c
Account: Zuora__Subscription__c
Account: Zuora__SubscriptionProductCharge__c
Account: Zuora__SubscriptionProductFeature__c
Invoice: Zuora__ZInvoice__c
Invoice Item: Zuora__InvoiceItem__c
Taxation Item: Zuora__TaxationItem__c
Credit Memo: Zuora__CreditMemo__c
Credit Memo Item: Zuora__CreditMemoItem__c
Debit Memo: Zuora__DebitMemo__c
Debit Memo Item: Zuora__DebitMemoItem__c
Payment Part: Zuora__PaymentPart__c
Refund Part: Zuora and Salesforce fields
Payment: Zuora__Payment__c
Invoice Payment: Zuora__PaymentInvoice__c
Refund Invoice Payment: Zuora__RefundInvoicePayment__c
Payment Method: Zuora__PaymentMethod__c
Field mapping of product catalog and related objects
Sync date fields
Field mapping of subscription and related objects
Subscription: Zuora__Subscription__c
NextChargeDate
Rate Plan: Zuora__SubscriptionRatePlan__c
RatePlan: Zuora__SubscriptionRatePlanHistory__c
Rate Plan Charge: Zuora__SubscriptionProductChargeHistory__c
ProductFeature: zqu__ZProductFeature__c
Rate Plan Charge: Zuora__UnitOfMeasure__c
Rate Plan Charge: Zuora__SubscriptionProductCharge__c
Rate Plan Charge Tier: Zuora__SubscriptionChargeTierHistory__c
Rate Plan Charge Tier: Zuora__SubscriptionRatePlanChargeTier__c
Product: Zuora__SubscriptionProductCharge__c
Product Rate Plan: Zuora__SubscriptionProductCharge__c
Subscription: Zuora subscription history
Zuora subscription fields synced with different values in Zuora connector
Order line items object model
Sync failures and retries
Zuora connector error code reference
View sync results via system health dashboard
View sync results via commerce admin
Retry sync failures manually via sync failure list page
Retry sync failures manually via system health dashboard
Setup threshold notifications
Delete sync failures from failure list
Customize columns on retry page
Sync retry rules
Work with Zuora connector for Salesforce CRM
Create automated reports
Multiple currencies synchronization
Synchronize self-service orders with Salesforce CRM
Synchronize a custom field
Custom fields not appearing in Salesforce after sync
View invoice PDFs
Configure the invoice page layout
Zuora data sync objects mapping
Zuora data syncs and Salesforce limits
Zuora connector for Salesforce CRM sync methods
Manual sync Zuora and Salesforce data
Near real-time sync Zuora and Salesforce data
On-Demand sync Zuora and Salesforce data
Configure account and billing account layouts for on-demand sync
Migrate to on-demand sync
Configure scheduled-sync between Zuora and Salesforce
Developer Tools
Install Developer Tools
Configure Developer Tools Tasks
Manage Developer Tools Tasks
Transitioning from Developer Tools to Data Loader
Comparison of Developer Tools and Data Loader
Templates
Data Loader - Developer Tools Matrix
Data Loader and Generic API Loader Matrix
Generic API Utility and Data Loader
Configure API Loader for Specific Zuora Objects
Create an API Loader Task
Export Object Information
Import CSV Files
Available Templates
Template Fields
Migrate Tenant Information
Configure Billing Preview
Create a Billing Preview Task
Configure Generic API Loader
Create a Generic API Loader Task
Generic API Loader Templates
Configure Generic API Utility
Create SOAP Requests
View SOAP API request and response
Configure Invoice API Generator
Create an Invoice API Generator
Invoice API Generator Template Fields
Developer Tools FAQs
Manage Tasks
Manage User Permissions
Minimum Commitment
Installing Minimum Commitment
Minimum Commitment configuration
Configure notifications
Configure custom fields
Using Minimum Commitment
Identify product to use the Minimum Commitment app
Configure the Minimum Commitment Charge(s) within the Product Rate Plan
Configure the Minimum Commitment True Up Charge
Minimum Commitment App Logic
Verify Minimum Commitment true-up processing
Minimum Commitment - Notes and Limitations
Troubleshoot Minimum Commitment Invoice Regeneration Issues
Billing Connector for Netsuite GL
About NetSuite Connector
Integration between Zuora and NetSuite
NetSuite Connector sync sequence
NetSuite Connector sync concepts
Integration status and error recovery
Updating the Integration Status field
NetSuite classifications
Invoice transaction sync
Invoice transaction sync rules
Project-based revenue
Invoice transaction sync delayed revenue recognition logic
Invoice transaction sync taxes
Payment transaction sync
Payment transaction sync rules: Zuora to NetSuite
Payment transaction sync rules: NetSuite to Zuora
Credit Memo transaction sync (Invoice Settlement enabled)
Customer account transaction sync
Customer account sync: Zuora to NetSuite
Customer account sync: NetSuite to Zuora
Refund transaction sync
Refund transaction sync rules: Zuora to NetSuite
Refund transaction sync rules: NetSuite to Zuora
Debit Memo transaction sync (Invoice Settlement enabled)
Debit Memo transaction sync rules
Project-based revenue
Delayed revenue recognition logic for Debit Memo sync (Invoice Settlement)
Debit Memo transaction sync (Invoice Settlement enabled) taxes
Credit Memo transaction sync (NetSuite to Zuora)
Credit Memo transaction sync rules: Standard
Credit Memo transaction sync rules: Negative balance
Invoice item adjustment transaction sync
Payment transaction sync (Invoice Settlement enabled)
Payment transaction sync rules: Zuora to NetSuite
Payment transaction sync rules: NetSuite to Zuora
Performance metrics for NetSuite connector
Product and product rate plan transaction sync
Product transaction sync rules
Product rate plan transaction sync rules
Product rate plan charge transaction sync
Product rate plan charge transaction sync rules
Sales Order transaction sync
Use a Sales Order to create a new subscription
Sales Order transaction sync rules
Zuora NetSuite custom field sync
Troubleshooting NetSuite integration
Zuora NetSuite Custom Field sync limitations
Install NetSuite Connector
Pre-installation tasks
Install the NetSuite Connector bundle
Configure NetSuite for NetSuite Connector
Enable revenue recognition and disable consolidated payments
Enable SuiteCloud: SuiteTalk (Web Services) and SuiteScript
Configure default accounting preferences
Configure auto-generated numbers
Configure multiple currencies
Create a NetSuite Connector user
Creating a Web Services User
Configure NetSuite forms
Inventory and non-inventory part record type
Customer record type
Invoice record type
Credit Memo record type
Customer payment record type
Sales Order record type
Customer refund record type
Reconcile data between Zuora and NetSuite
Reconciling payment term values
Reconciling payment method values
Creating NetSuite items for Zuora tax codes
Configuring Zuora accounting codes
Create a new login for NetSuite
Create a new instance of Zuora Connector for NetSuite
Configure sync preferences
Viewing multiple currencies settings in NetSuite
Sync billing documents in multiple currencies to NetSuite
Enable multi-currency support
Viewing advanced pricing settings in NetSuite
Viewing tax settings in NetSuite
NetSuite classification details
Viewing company settings in NetSuite
Customer account sync
Configure advanced settings
Configure scheduler
Migrate data from NetSuite to Zuora
Migrating existing customers
Migrating existing items
Using NetSuite Connector
Disabling sync processes
Disable a sync process
Edit the configuration settings
Run an integration sync
View sync activity
NetSuite Connector troubleshooting
Error messages: Part 1
Error messages: Part 2
Error messages: Part 3
NetSuite Connector custom fields
NetSuite custom fields
Zuora custom fields
Field Mappings
Account Field Mappings: Zuora to NetSuite Sync
Credit Memo Field Mappings: NetSuite to Zuora Sync
Credit Memo Field Mappings: Zuora to NetSuite Sync (Invoice Settlement Enabled)
Credit Memo Field Mappings
Credit Memo Item Field Mappings
Credit Memo Taxation Item Field Mappings
Customer Field Mappings: NetSuite to Zuora Sync
Debit Memo Field Mappings: Zuora to NetSuite Sync (Invoice Settlement Enabled)
Debit Memo Field Mappings
Debit Memo Item Field Mappings
Zuora Debit Memo Taxation Item Field Mappings
Invoice Item Adjustment Field Mappings: Zuora to NetSuite Sync
Invoice Item Adjustment
Invoice Item Adjustment Details
Invoice (Negative) Field Mappings: Zuora to NetSuite Sync
Zuora Invoice Header (Negative)
Zuora Invoice Items
Zuora Invoice Taxation Items
Invoice Payment Field Mappings: Zuora to NetSuite Sync
Invoice (Positive) Field Mappings: Zuora to NetSuite Sync
Zuora Invoice Header (Positive)
Zuora Invoice Items
Zuora Invoice Taxation Items
Payment Field Mappings: NetSuite to Zuora Sync
Payment Field Mappings: NetSuite to Zuora Sync (Invoice Settlement Enabled)
Payment Field Mappings: Zuora to NetSuite Sync (Invoice Settlement Enabled)
Product Field Mappings: Zuora to NetSuite Sync
ProductRatePlan Field Mappings: Zuora to NetSuite Sync
ProductRatePlanCharge Field Mappings: Zuora to NetSuite Sync
Refund Field Mappings: NetSuite to Zuora Sync
Refund Field Mappings: Zuora to NetSuite Sync
Sales Order Field Mappings: NetSuite to Zuora Sync
Inline taxation for invoices and credit memos
Set up region-secifix tax code for Zuora tax engine
Billing connector for HubSpot
Set up HubSpot connector
Field mappings for HubSpot synchronization with Zuora
HubSpot company synchronization with Zuora accounts
Synchronize Bill To and Sold To on accounts with HubSpot connector
HubSpot product synchronization with Zuora Product Catalog
HubSpot deal synchronization with Zuora subscriptions via orders
Synchronize Bill To and Sold To on subscriptions with HubSpot connector
Synchronize the subscription owner and invoice owner with HubSpot connector
Synchronize service activation and customer acceptance dates with HubSpot connector
Synchronize billing trigger condition with HubSpot connector
HubSpot synchronization with custom fields
Synchronize custom fields with HubSpot connector
Access error logs to troubleshoot HubSpot connector
Billing connector for HubSpot FAQ
Billing connector for Salesforce CPQ
Salesforce CPQ connector configuration guide
Set up in Zuora
Set up in Salesforce
Phase 1 - Configure a Salesforce External Client App
Phase 2: Configure Salesforce authentication
Create External Credential
Create Named Credential for Zuora Endpoint
Assign User Access
Phase 3: Create the Apex Controller and Visualforce Page
Phase 4: Update Send to Zuora buttons
Configure the Salesforce CPQ connector
Salesforce CPQ connector sync
Accounts sync between Salesforce CPQ and Zuora
Sync Salesforce CPQ account
Orders sync between Salesforce CPQ and Zuora
Sync orders from Salesforce CPQ
Products sync between Salesforce CPQ and Zuora
Custom field sync and mapping
Advanced configuration and data management
Orders sync from Salesforce CPQ: common use cases
Handling differences between Zuora and Salesforce CPQ
Salesforce CPQ field mappings guide
Error logging and troubleshooting SFDC CPQ connector
Guidelines for data migration
Salesforce CPQ connector FAQs
Revenue connector for Netsuite ERP
Create user for NetSuite integration with Zuora Revenue
Create an integration in NetSuite
Copy NetSuite SuiteTalk API services URL
Set up transactional datasets for Revenue connector for NetSuite
Sample dataset for Revenue Connector for NetSuite
Set up API user in Revenue
Enable connector profile for NetSuite
Set up transaction upload file template
Launch NetSuite ERP connector
Authentication credentials for NetSuite and Zuora Revenue
Configure email notifications in Revenue connector for NetSuite
Create a solution instance for Revenue connector for NetSuite
Map fields for Revenue connector for NetSuite
Run Revenue connector for NetSuite ERP
Validate transactions in Zuora Revenue after connector run
Connector ingestion scope
Zuora Connector for Workday Accounting Center
Prerequisites for integrating Zuora with Workday
Assign domain security policy permissions
Activate Workday security policy changes
Configure authentication for the Workday Accounting Center connector
Configure connector field mappings
Run the Workday Accounting Center connector
Validate synchronized data in Workday
Mapping Zuora data to Workday Prism
Error handling and replay behavior
Zuora Connector for Workday Financials
Workday for Billing - Zuora
Configure Zuora Billing
Create a Zuora User Role
Create a Zuora user
Create a Zuora Client
Configure Custom fields
Configure Segments
Configure general ledger segmentation rules
Workday Financials - Zuora Configuration
Retrieve the Workday URL containing your host and tenant names
Create a journal source for Zuora
Create Workday ISUs for Zuora
Create a Workday security group and assigning your ISUs
Assign domain security policy permissions
Assign business process security policy permissions
Activate your security policy changes
Security permissions for Accounting journal features
Configure Workday Financials GL (Billing) - Zuora
Authenticate your Zuora and Workday environment
Establish the connector field mapping
Billing custom attributes and FX segment field mappings
Configure Billing custom attributes and FX segment fields
Specify constants to configure workday financials
Create value mappings to configure workday financials
Configuring default values
Specify custom target fields
Initiating a dry run
Execute Workday Financials GL (Billing)
Schedule connector execution
Validating journals in Workday
Workday Financials GL(Revenue) - Zuora
Configure Zuora Revenue and Workday Financials
Configurations in Zuora Revenue
Configuring GL Interface in Zuora Revenue
Run Transfer Accounting in Zuora Revenue
Configuring WorkDay Financials
Retrieving your Workday Financials credentials
Assigning domain security policy permissions for Revenue
Configuring Workday Financials GL (Revenue)
Authenticating your Zuora Revenue and Workday Environments
Configure Email Notifications
Connector Field Mapping
Executing the Workday Financial GL (Revenue)
Run GL Connector from Transfer Accounting UI
Validate Journals in Workday
Overview of Zuora connector for Salesforce CPQ
Configure Zuora connector for Salesforce CPQ
Add required custom fields in Zuora
Configure additional custom fields to be synchronized
Add custom accounting codes
Configure Salesforce CPQ for connector
Update product page layout assignment
Update contract page layout assignment
Update Salesforce CPQ quote page layout assignment
Add users to permission sets
Use Zuora for Salesforce CPQ connector with orders
SubmitContractOrder plugin setup
Zuora connector settings
Configure Zuora connector settings
Product catalog integration in Zuora connector Salesforce CPQ
Set up Salesforce CPQ product catalog for Zuora
Manage custom fields on price book entry
Field mappings in product integration
Contract integration in Zuora connector for Salesforce CPQ
Integrate new subscription quote
Integrate amendment quote
Integrate renewal Quote
Integrate cancelation
Troubleshoot integration processes
Validate subscription
Field mappings in contract integration
Price Calculation in Zuora Connector for Salesforce CPQ
Zuora reference implementation of SubmitContractOrder plugin
Configure SubmitContractOrder plugin
Register ZuoraSubmitContractOrderPlugin
Enable custom field sync
Required Zuora custom fields
Optional Zuora custom fields
Set optional custom field mappings
SubmitContractOrder class
SubmitContractOrder plugin
SubmitContractOrder.PluginWithBackfillHandler Interface
SubscriptionValidator class
ZSBConnectorUtils class
Zuora connector for SAP
About SAP connector for Billing, Payments, and Revenue
Deploy the Zuora edge component
Configure endpoints for SAP-FI capabilities
Configure endpoints for the SAP connector
Configure endpoints for the SD capability
Configure the communication system and user
Create a communication arrangement in S/4HANA Cloud Public Edition
Access Zuora SAP-BTP agent
Configure a SAP S/4HANA Cloud Public Edition destination
Configure SAP S/4HANA Cloud Private Edition
Configure SAP S/4HANA On-Premise
Configure SAP ECC
Test SAP-BTP agent connectivity
Create a Zuora user role
Create a Zuora user
Creating a Zuora client
Configure custom fields for SAP Integration
Configure segments, segmentation rules, and journal run
Configure profiles in Zuora revenue
Configure GL interface in Zuora revenue
Run transfer accounting process in Zuora revenue
Configure the SAP connector
Authenticate and test your Zuora credentials
Configure destinations
Create field mappings
Create conditional field mappings
Configure constants using the expression wizard
Create value mappings
Configure default values
Use string to date expressions
Use negate decimal expressions
Configure additional settings
Initiate a dry run
Execute the SAP Connector
Configure the SAP S/4 HANA system for billing set-up
Deploy the Zuora edge component
Configure destinations for SAP ECC
About SAP Connector (Revenue)
Configure a Communication System and Communication User in SAP S/4HANA Cloud Public Edition
Create a communication arrangement (Revenue)
Access the Zuora SAP-BTP agent (Revenue)
Configure a SAP destination for SAP-BTP agent (Revenue)
Test SAP-BTP connectivity (Revenue)
Authenticate your Zuora and connector environments (Revenue)
Configure a SAP destination for GL connector (Revenue)
Configure email notifications for GL connector (Revenue)
Establish field mappings for GL connector (Revenue)
Execute the SAP GL connector (Revenue)
Run GL connector from transfer accounting UI (Revenue)
Zuora Connectors for Data Warehouses
Overview - Zuora Connectors for Data Warehouses
Working with Zuora Connectors for Data Warehouses
Available connectors
Get started with Zuora Connectors for Data Warehouse
Choose the right data warehousing connector for your use case
Billing objects supported for Zuora Connectors for Data Warehouses
Data Warehouse Connectors Object Schema Definition
Limitations of Zuora Connectors for Data Warehouses
Schema evolution in Zuora Data Warehousing Connectors
Overview of Zuora Connector for Aurora MySQL
Get started with Zuora connector for Aurora MySQL
Set up Zuora Connector for Aurora MySQL
Configure the security group for Aurora MySQL
Configure network ACLs (access control list)
Create writer user Aurora MySQL
Add destination for Aurora MySQL
Post-onboarding flow for Aurora MySql
Verification and data transfer Aurora MySQL
Overview of Zuora Connector for AWS Athena
Get started with Zuora Connector for AWS Athena
Set up Zuora Connector for AWS Athena
Create a destination bucket
Create service policy and role
Alternative authentication method for AWS Athena
Add destination for AWS Athena
Post-onboarding flow for AWS Athena
Verification and data transfer for AWS Athena
Overview of Zuora Connector for AWS Aurora Postgres
Get started with Zuora Connector for AWS Aurora Postgres
Set up Zuora Connector for AWS Aurora Postgres
Allow access for AWS Arora Postgres
Configure the security group AWS Aurora Postgres
Configure network ACLs
Create writer user AWS Aurora Postgres
Add destination for AWS Aurora Postgres
Post-onboarding flow for AWS Aurora Postgres
Verification and data transfer for AWS Aurora Postgres
Overview of Zuora Connector for AWS RDS Postgres
Get started with Zuora Connector for AWS RDS Postgres
Set up Zuora Connector for AWS RDS Postgres
Allow access for AWS RDS Postgres
Configure the security group for AWS RDS Postgres
Configure network ACLs
Create writer user AWS RDS Postgres
Add destination for AWS RDS Postgres
Post-onboarding flow for AWS RDS Postgres
Verification and data transfer for AWS RDS Postgres
Overview of Zuora Connector for AWS Redshift
Get started with Zuora Connector for AWS Redshift
Create a limited user in AWS Redshift
Whitelist connection
Create a staging bucket for AWS Redshift
Create a policy
Create a role
Authenticate alternatively with AWS Access key ID and Secret key
Add destination for Zuora Connector for AWS Redshift
Post-onboarding flow for AWS Redshift
Verification and data transfer for AWS Redshift
Overview of Zuora Connector for AWS S3
Get started with Zuora connector for AWS S3
Set up Zuora Connector for AWS S3
Set up destination S3 bucket
Create policy and IAM role for AWS S3
Alternative authentication method for AWS S3
Add destination for AWS S3
Post-onboarding flow for AWS S3
Verification and data transfer for AWS S3
Handling duplicates in S3 extracts for Zuora data
Overview of Zuora Connector for Azure Blob Storage
Get started with Zuora Connector for Azure Blob Storage
Set up the Zuora Connector for Azure Blob Storage
Create container and access token for Azure Blob Storage
Add destination for Azure Blob Storage
Post-onboarding flow for Azure Blob Storage
Verification and data transfer Azure Blob Storage
Handling duplicates in Azure Blob Storage Extracts for Zuora data
Overview of Zuora Connector for BigQuery
Get started with Zuora connector for BigQuery
Set up Zuora Connector for BigQuery
Create a service account in BigQuery project
Alternative authentication method: Grant direct access to service account
Create a staging bucket for BigQuery
Add destination for BigQuery
Post-onboarding flow for BigQuery
Verification and data transfer for BigQuery
Workload Identity Federation configuration for BigQuery
Confirm the permissions of your GCP service account
Create a workload identity pool
Overview of Zuora Connector for Databricks
Get started with Zuora connector for Databricks
Create a SQL warehouse
Configure access: OAuth Secret (Recommended)
Configure access: Personal Access Token (PAT)
Use a Service Principal with Service Account PAT
Add destination for Databricks
Post-onboarding flow for Databricks
Service principal PAT: Creation and rotation
Choose your service principal type
Create the app registration in Microsoft Entra ID
Create a client secret in the app registration
Add Entra ID Service Principal (Import)
Grant workspace entitlements to service principal
Create Databricks managed service principal
Configure token permissions for Entra ID SP
Configure token permissions for Databricks SP
Generate Microsoft Entra ID access token
Create PAT for Databricks SP via API
Create PAT for Entra ID SP via API
Use the PAT in your integration
Service Principal PAT: Troubleshooting
Troubleshooting Databricks connection issues
Overview of Zuora Connector for Delta Lake
Get started with Zuora Connector for Delta Lake
Delta Lake key considerations
Set up Zuora Connector for Delta Lake
Set up AWS S3 Delta Lake
Set up destination S3 bucket for Delta Lake
Create policy and IAM role for Delta Lake
Alternative authentication method for AWS S3 Delta Lake
Set up Google Cloud Delta Lake
Create a service account for Delta Lake
Alternative authentication method for Google Cloud Delta Lake
Create destination GCS bucket for Delta Lake
Add destination for Delta Lake
Post-onboarding flow for Delta Lake
Delta Lake configuration options
Mount AWS S3 Delta Lake to Athena
Mount GCS Delta Lake to BigQuery
Mount AWS S3 Delta Lake to Clickhouse
Mount AWS S3 Delta Lake to DuckDB/MotherDuck
Mount S3 Delta Lake to Databricks (Unity)
Mount S3 Delta Lake to Redshift
Read S3 Delta Lake with PySpark
Mount S3 Delta Lake to Snowflake
Mount Delta Lake to Microsoft Fabric & Microsoft OneLake
Overview of Zuora Connector for GCP Postgres
Get started with Zuora connector for GCP Postgres
Set up Zuora Connector for GCP Postgres
Allow access for GCP Postgres
Create writer user for GCP Postgres
Add destination for GCP Postgres
Post-onboarding flow for GCP Postgres
Verification and data transfer GCP Postgres
Overview of Zuora Connector for Generic ClickHouse
Get started with Zuora Connector for Generic ClickHouse
Set up Zuora Connector for Generic ClickHouse
Allow access for Generic Clickhouse
Create reader user
Set up staging bucket
Google Cloud Storage staging bucket configuration for Zuora Connector for Generic ClickHouse
S3 staging bucket configuration for Zuora Connector for Generic ClickHouse
Add destination for Generic ClickHouse
Learn the difference between database and schema fields
Use the ClickHouse data
Post-onboarding flow for Generic ClickHouse
Overview of Zuora Connector for Generic MySQL
Get started with Zuora Connector for Generic MySQL
Set up Zuora Connector for Generic MySQL
Allow access to configuring firewall rules for MySQL data sync
Create writer user for Generic MySQL
Add destination for Generic MySQL
Post-onboarding flow for Generic MySQL
Verification and data transfer for Generic MySQL
Overview of Zuora Connector for Generic Postgres
Get started with Zuora connector for Generic Postgres
Set up Zuora Connector for Generic Postgres
Allow access for Generic Postgres
Create writer user for Generic Postgres
Add destination for Generic Postgres
Post-onboarding flow for Generic Postgres
Data verification and transfer
Overview of Zuora Connector for Google Cloud Storage
Get started with Zuora Connector for Google Cloud Storage
Set up Zuora Connector for Google Cloud Storage
Create a service account for GCS
Alternative authentication method: HMAC Access Key and Secret
Create a destination GCS bucket
Add destination for Google Cloud Storage
Post-onboarding flow for Google Cloud Storage
Verification and data transfer Google Cloud Storage
Handling duplicates in Google Cloud Storage extracts for Zuora data
Overview of Zuora Connector for SQL Server
Get started with Zuora Connector for SQL Server
Set up Zuora Connector for SQL Server
Allow access for SQL Server
Create writer user for SQL Server
Add destination for SQL Server
Post-onboarding flow for SQL Server
Verification and data transfer SQL Server
Zuora Secure Data Share for Snowflake
Overview of Zuora Secure Data Share for Snowflake
Use Zuora Secure Data Share for Snowflake to access Zuora data
Access the Secure Data Share UI
Configure and install Secure Data Share
Accept the Secure Data Share in Snowflake
Tables and columns available in Snowflake
Tables for monitoring
DATA_QUALITY_LOG
TAR_USAGE_HISTORY
AppStore Connectors
Data Query
Overview of Data Query
Use Data Query through API
Construct SQL queries in Data Query
Join data across multiple tables
Encryption
Available tables
Best practices when writing data queries
Best-practice samples for common queries
General best practices
Indexed fields
Common use cases of data query
Data Query help section
Data Query Templates
Use Data Query through user interface
Create new data queries
Save data queries
Update or delete data queries
View the data query history
Schema browser
Zuora Reporting
Reporting Quick Reference
Reporting overview
Standard reports
Standard Booking reports
Standard Billing reports
Standard Cash reports
Standard Revenue reports
Standard Finance reports
Standard Audit Logs reports
Currency conversion
Format of CSV report results
Zuora Reporting limitations
Use Reporting
Create a summary report
Filters
Charts in Summary Reports
Summary Report widgets
Create a detail report
Customize a standard report
Audit trail for reports
Folders and sharing
Manage report runs
Schedule report runs
Create a report from saved data queries
Create custom object reports
Create a report with a custom object data source
Create a report from saved data queries that use custom objects
Create a report from the saved query
Run a report with data warehouse
Create and run a report with data warehouse
Edit and run a report with data warehouse
Run a report with data warehouse from the report list
Reporting objects in Data Query
Reporting on MRR and TCV
Data sources and exports
Introduction to data sources
A data source reporting example
Data source availability
Manage data sources
Pick the right data source
Data source reference
Accounting Code data source
Account data source
Account Key Metrics data source
Application Group data source
AR Transaction data source
Billing Preview Run Result data source
Billing Preview Run Result Difference data source
Billing Run data source
Billing Transaction data source
Booking Transaction data source
Contact data source
Credit Balance Adjustment data source
Credit Memo Application data source
Credit Memo Application Item data source
Credit Memo data source
Credit Memo Item data source
Credit Memo Part data source
Credit Memo Part Item data source
Credit Taxation Item data source
Custom Exchange Rate data source
Daily Consumption Summary data source
Debit Memo data source
Debit Memo Item data source
Debit Taxation Item data source
Delivery Adjustment data source
Discount Applied Metrics data source
Fulfillment data source
Fulfillment Item data source
Gateway Reconciliation Event data source
Gateway Reconciliation Log data source
Guided Usage data source
HPM reCAPTCHA Validation Result data source
HPM Smart Bot Attacking Prevention Audit
Invoice Adjustment data source
Invoice data source
Invoice Item Adjustment data source
Invoice Item data source
Invoice Payment data source
Invoice Schedule data source
Invoice Schedule Item data source
Journal Entry Detail FX Gain Loss
Journal Entry Detail Objects data source
Journal Entry Detail Revenue Event
Journal Entry Item data source
Notification History - Callout
Notification History - Email
Notification History - Email Event
Order Action data source
Order data source
Order Elp data source
Order Item data source
Order Line Item data source
Order Mrr data source
Order Quantity data source
Order Tcb data source
Order Tcv data source
Payment Application data source
Payment Application Item data source
Payment data source
Payment Method data source
Payment Method Transaction Log data source
Payment Method Update data source
Payment Option data source
Payment Part data source
Payment Part Item data source
Payment Run data source
Payment Schedule Billing Document data source
Payment Schedule data source
Payment Schedule Item data source
Payment Schedule Item Payment data source
Payment Transaction Log data source
Prepaid Balance Fund data source
Prepaid Validity Period Summary data source
Processed Usage data source
Product data source
Product Rate Plan Charge data source
Product Rate Plan Charge Tier data source
Product Rate Plan data source
Ramp data source
Ramp Interval data source
Ramp Interval Metrics data source
Ramp Interval Mrr data source
Ramp Interval Delta Metrics data source
Ramp Interval Delta Mrr data source
Ramp Interval Delta Quantity data source
Rate Plan Charge data source
Find Subscriptions that have a Rate Plan Charge
Rate Plan Charge Tier data source
Rate Plan data source
Rating Result data source
Refund Application data source
Refund Application Item data source
Refund data source
Refund Invoice Payment data source
Refund Part data source
Refund Part Item data source
Refund Transaction Log data source
Revenue Charge Summary Item data source
Revenue Event Item Credit Memo Item data source
Revenue Event Item data source
Revenue Event Item Debit Memo Item data source
Revenue Event Item Invoice Item Adjustment data source
Revenue Event Item Invoice Item data source
Revenue Recognition Events Transaction data source
Revenue Schedule Item Credit Memo Item data source
Revenue Schedule Item data source
Revenue Schedule Item Debit Memo Item data source
Revenue Schedule Item Invoice Item Adjustment data source
Revenue Schedule Item Invoice Item data source
Stored Credential Profile data source
Subscription Charge Delivery Schedule data source
Subscription Charge Price Interval data source
Subscription Charge Price Interval Tier data source
Subscription data source
Subscription Status History data source
Taxation Item data source
Usage data source
Generate a data source export
Create a data source export
Accounts query
Invoices query
Subscriptions query
Working with GPG keys
Data Exports
Available exports
Export links
MRR (Contracted) Changes Export
MRR Trend Export
Reporting API Reference
Overview of the Zuora Reporting API
Search by Report Name
Run a Report
Get Report Run
Get Last Completed Report Run
Get Report Data
Export Report Run
Cancel a Report Run
Additional operations
Copy a Report and Assign Labels
Create a Report and Assign Labels
Delete a Report
Get Reports by Label
Get Report by ID
Get Report Details
Get Report Details by Label
Get Report Labels for ReportID
Get Tenant Settings
Label or Unlabel a Report
Save a Report
Update Tenant Settings
Transfer Report Ownership
Unified Reporting experience
Create a dataset-based report
Purpose of datasets
Standard datasets
Dataset creation
Report creation
Report management
Charts and dashboards
Dashboard creation and management
Permissions and access
Key information
Zuora Warehouse
Zuora Warehouse overview
Monitor Zuora Warehouse usage
TAR_USAGE_HISTORY
WAREHOUSE_METERING_HISTORY
Analytics Quick Reference
Analytics metric glossary
Analytics overview
Analytics roles
Analytics permissions
List of Permissions for Reporting Roles
Find out your Reporting role
Assign Analytics roles to users in your organization
Currency conversion in Zuora Analytics
Default Dashboard layout, cards, and datasets
Getting started with Analytics
Known issues and limitations
Legacy Cards Retirement Guide
How to recreate your legacy cards with datasets?
On-demand provisioning of Analytics
Zuora Analytics governor limits
Zuora Analytics troubleshooting guide
Template library
Churned subscriber trend
Use cases
Use case: traditional businesses just launched subscription services
Using the Explorer
Create a table card
Create a time series card
Create or edit a dataset
Create a dataset
Edit a dataset
Export-only datasets
Delete a card
Edit a card
Export data from a card or dataset
Pin a card to a dashboard
Transaction object in Analytics
Dates for Net Billing and Net Payments
Unpin a card from the Dashboard
Using the dashboard
Customize the layout of a dashboard
Resize a card
Change card display options
Manage your dashboards
Consumption Insights
Key Concepts
Frequently Asked Questions
Access the Consumption Insights dashboard
Billed Usage
Metrics available in the Billed Usage
Manage User Access
Enable Consumption Insights by yourself
Manage role-based access
Zuora In-product Benchmarks
Overview of Zuora In-product Benchmarks
Access Zuora In-product Benchmarks
Zuora Benchmark Metrics
Standard Benchmark Metrics
Compliance and Feedback
AQuA API Introduction
Authentication
Steps overview
Limits
AQuA: Stateless and stateful modes
Stateless and stateful modes
Automatic switch between full load and incremental load
Time offset for AQuA stateful queries
Examples: Data retrieval
AQuA API error codes
AQuA job finder
Access and use the AQuA job finder
Bulk data extraction from Zuora using AQuA
Best practices when querying data from Zuora
Query each data source individually
Filter by UpdatedDate only
High Water Mark Approach for AQuA Stateless Queries
Extract deleted data in AQuA queries
Best practices when loading data into your data warehouse
Data loading steps
Delete data from staging table
Bulk data extraction using other Zuora APIs
Post Query
Post query with API version
Post query with notification
Post query with retrieval time
Post query with time offset
Callout notification for completed AQuA jobs
Procedure
Create a callout template
Set up a callout notification
Get Job Results
Get results files
Get last job completed
Delete a running job
File segmentation
Export ZOQL
Data Sources and Objects
Export ZOQL Select Statements
Aggregate Functions
Export ZOQL Clauses
Export ZOQL Clause Limits
Changes to the Describe API
Field Values in Export ZOQL Data Sources
Export ZOQL Filter Statements
Filter Statement reference
Special date/time features in Export ZOQL
Compare datetimes with dates
ZOQL
Filter statements
Query statement examples
Zuora AI
Tenant access to AI
Watch Tower and AI activity logs
Usage guidelines for Zuora AI
Controls for Zuora AI
Approval Control
Control properties
Audit trail for Zuora AI
AI Source and AI SubSource in the Audit Trail
Manage files in Zuora AI
Runbooks
Create Runbooks
Zuora AI Chat features and capabilities
Zuora AI prompting and capabilities
Write an effective Zuora AI prompt
Zuora AI prompt pattern
Zuora AI agent areas
Integrated AI
Chat with Zuora AI
Supervised mode for Zuora AI
Change the AI mode for a tenant
Set a tenant to Read-Only mode
Limit Supervised mode to specific roles
User Permissions and Roles
Chat History
Data Visualization
Configure Approval controls
Behavioral control
Feedback
Zuora MCP server
Configure Zuora Remote MCP server
Enable Zuora AI
Create OAuth 2.0 credentials for remote MCP client
Redirect URIs by MCP client
Identify your MCP server endpoint
Install Zuora MCP server in ChatGPT
Install Zuora MCP server in Claude Code
Install Zuora MCP server in Claude desktop or web
Install Zuora MCP server in Cursor
Install Zuora MCP server in Glean
Install Zuora MCP server in Gemini CLI
Install Zuora MCP server in n8n
Install Zuora MCP server in Visual Studio Code
Remote MCP Configurations for Multi-Org and Multi-Entity tenants
Configure Zuora local MCP server
Create OAuth Credentials for local MCP client
Install Zuora MCP server in Claude Code for desktop client
Install Zuora MCP server in Claude Desktop for desktop client
Install Zuora MCP server in Cursor for desktop client
Install Zuora MCP server in OpenAI Codex CLI for desktop clients
Install Zuora MCP server in Windsurf for desktop clients
Optional parameters configuration for local MCP
Test your Zuora MCP Connection
Tools reference for Zuora MCP
Resources reference for Zuora MCP
Attachments
Add an attachment
Edit an attachment
Download an attachment
Delete an attachment

Developers
Docs