Skip to main content

Zuora Testing Environments

Zuora

Zuora Testing Environments

Zuora environments represent private tenant access to the Zuora application, APIs, and supported integrations and payments gateways. This article describes the different types of Zuora testing environments and is targeted to help you determine the right environment for your needs.

Zuora offers the following testing environments:

  • API Sandbox

    Intended for integration testing and release preview testing. Does not come with any data. Zuora application version is one week ahead of the main production environment.

  • Zuora Central Sandbox
    Provides additional capabilities on top of API Sandbox. Zuora Central Sandbox copies production data securely and supports production-like performance.  Zuora Central Sandbox can be utilized for integration testing, end-to-end production testing, user acceptance testing, and performance testing with guidelines. See Getting started with Zuora Central Sandbox for more information.

The Production Copy, enhanced Production Copy, and Performance Test Environments described in this article are no longer offered as add-on products starting from July 2020.  Zuora Central Sandbox is the latest testing environment that combines the capability to copy scrubbed production data and support performance testing.  Zuora will continue to support the Production Copy, enhanced Production Copy, and Performance Test Environments for customers who have been actively using them.

  • Production Copy Environment

    Intended for system testing and data modeling. Comes with a copy of your production data. Zuora application version is refreshed on demand to match the main production environment.

  • Performance Test Environment

    Intended for heavy performance testing and load testing. Does not come with any data. Zuora application version is refreshed a few minutes after updates to the main production environment.

You can access the main production environment at https://www.zuora.com.

API Sandbox

The API Sandbox is Zuora's "release preview" environment. It is a customer facing, multi-tenant environment that gets code deployed to it before Zuora's production environment. How early code gets deployed depends on the type of release: Major releases are usually deployed a week in advance, whereas minor releases and emergency patches get deployed days, hours or minutes before production. Zuora customers can purchase any number of tenants in this environment for a recurring annual fee.

API Sandbox is co-located in the same data center as the production environment, running on bare metal, but on a smaller footprint, offering less capacity.

The main use cases for API Sandbox include:

  • Basic implementation configuration and integrations
  • Training
  • Integration testing
  • Regression testing
  • Release preview testing

This environment is located at:

Zuora Central Sandbox

Zuora Central Sandbox combines the capability to copy production data along with production-like performance into a single test environment tenant.  While Zuora Central Sandbox always comes with a snapshot of scrubbed production data, it can also be utilized for a brand new implementation in case the production tenant has no data at that time.  The use cases for Zuora Central Sandbox include everything that an API Sandbox does, and more:

  • Basic implementation configuration and integration

  • Training

  • Integration testing

  • Regression testing

  • Performance testing (with guidelines)

  • Pre-production testing

  • User acceptance testing 

Zuora Central Sandbox is hosted on a production-like AWS infrastructure, allowing our customers to test the API response time, the bill runs and payment runs with production-level data loading. It provides a more realistic view of performance than API Sandbox.

While the Zuora Central Sandbox is designed for production-level performance, Zuora recommends you to contact Zuora Global Support if you plan to test over a certain amount of volume in a 24 hour period in the Zuora Central Sandbox. See Performance guidelines for the details.

In addition, the testing results can still vary from Production since both the Zuora Central Sandbox and Production are distinct multi-tenant environments, the performance of which are based on the overall usage across all your customers.


This environment is located at:

Note that the support for EU Data Center customers is currently on a limited basis only.  Contact Zuora Global Support or your account manager for more information.

Zuora Central Sandbox has the following limitations:

  • Beta or Early Adopter features may not be supported. Contact Zuora Global Support or your account manager for more information.
  • Zuora Central Sandbox is currently hosted in the US only.
  • While Zuora Central Sandbox supports the capability to create and save reports in the Reporting tool, the saved reports in the production environment are currently not copied to Zuora Central Sandbox.

Performance Test Environment

The Production Copy, enhanced Production Copy, and Performance Test Environments described in this article are no longer offered as add-on products starting from July 2020.  Zuora Central Sandbox is the latest testing environment that combines the capability to copy scrubbed production data and support performance testing.  Zuora will continue to support the Production Copy, enhanced Production Copy, and Performance Test Environments for customers who have been actively using them.

The Performance Test Environment is Zuora's de-facto Performance Test environment. It's the multi-tenant environment which we recommend customers and partners to use for extensive performance testing and trying to test the integration with Zuora or identify bottlenecks with an integration. Zuora customers can purchase any number of tenants in this environment, paying for them on a monthly basis.

Code releases are deployed to Performance Test Environment shortly after they are deployed to the production environment, typically a few minutes after production deployment, keeping the Performance Test environment in close parity with production.

The environment is co-located with our Production infrastructure.

The main use cases for the Performance Test Environment include:

  • Performance load testing
  • End to end timing testing (especially for data migrations)

This environment is located at https://pt1.zuora.com

Support Responsibility for the Performance Test Environment

Zuora Responsibility Customer Responsibility
  • Provision a tenant for use by the customer.
  • Enable customer features per entitlement.
  • Monitor the environment for internal operations.
  • Respond to customer inquiries about performance degradations that customers see from their end.
  • Respond to customer inquiries about functional problems they encounter in the environment.
  • Set up your tenant with all administrative settings, user roles, and integrations and configurations. All Zuora application settings must be configured to match your Zuora production tenant.
  • Copy your product catalog.
  • Populate your tenant with test data.
  • Execute performance tests.
  • Monitor end-user performance of your tests for your own purposes.

Production Copy Environment

The Production Copy, enhanced Production Copy, and Performance Test Environments described in this article are no longer offered as add-on products starting from July 2020.  Zuora Central Sandbox is the latest testing environment that combines the capability to copy scrubbed production data and support performance testing.  Zuora will continue to support the Production Copy, enhanced Production Copy, and Performance Test Environments for customers who have been actively using them.

The Production Copy Environment is an isolated customer sandbox, containing a scrubbed snapshot of customer data from Zuora's production environment, running completely on AWS on a significantly smaller capacity/footprint Zuora stack with the same release version as production. These environments are also referred to as "Service Environments". This is the only environment which supports scrubbed data and configuration copy from production.

The Production Copy Environment has some unique characteristics:

  • The Production Copy Environment are run on a best-effort basis, and do not have a guaranteed up-time or performance.

  • Customers are responsible for managing the schedule of refreshes of their environments. This includes coordinating the refresh to include a new Zuora version and data snapshot. Without careful management, service environments may lag in code and data version when compared to customer's production tenant. See Refresh Policy for more information.

    Enhanced Production Copy Environment is updated along with Production. Such updates typically involve code changes only and do not refresh existing customer data.

  • Provisioning or refreshing to a Production Copy Environment typically takes 5 business days, but the process may take longer. For instance, provisioning a Production Copy Environment may take longer than 5 business days if a large volume of data needs to be extracted from the production environment and scrubbed.

  • Various sensitive parts of production-copied data (such as API keys, credit card numbers, email addresses, and so on) are scrubbed as part of the environment provisioning process. This typically means customers need to perform some level of data grooming after an environment is provisioned or refreshed, prior to using.  See Scrubbed Data for more details on what records are scrubbed.

  • Some Zuora security features, such as SSO and MFA, and security compliance levels, such as PCI and SOC, are not supported in Production Copy Environment.

  • Production Copy environments currently do not include the following features:

    • Reporting
    • Insights
    • Zuora Revenue (formerly known as Zuora RevPro)
    • Marketplace (formerly known as Zuora Connect)
    • Collect
    • Micro-service based features, such as Notifications on Any Event, and Orders UI
  • Enhanced Production Copy environments support the following features that a basic Production Copy Environment does not support:

    • Reporting

    • OAuth authentication via REST API

    • Copying multiple entities

    • Data Model

    • Settings API

    • Data Query

    • Event Triggers and Notifications

    • Workflow, Collect, and Marketplace

  • Currently, Enhanced Production Copy environments have the following limitations:

    • Customers are limited to only 1 enhanced production copy per production tenant.

    • Enhanced Production Copy environments only copy core billing data from production environments.  Data copy for new features, such as Data Model, is not yet supported.

    • ePCE supports hosting on US and EU data centers.

    • Features that are still in development are not supported.

For more information, see Support for Zuora Features, Add-ons, Integrations.

The use cases for Production Copy environments include:

  • Regression testing

  • System testing

  • Data modeling

Since these environments are provisioned on an as-needed basis, the URL endpoints for the REST API may vary. Once your environment is provisioned, check with Zuora Global Support which REST API endpoint you should used.

General Information

The Production Copy, enhanced Production Copy, and Performance Test Environments described in this article are no longer offered as add-on products starting from July 2020.  Zuora Central Sandbox is the latest testing environment that combines the capability to copy scrubbed production data and support performance testing.  Zuora will continue to support the Production Copy, enhanced Production Copy, and Performance Test Environments for customers who have been actively using them.

  API Sandbox Production Copy Environment (No longer offered, refer to Zuora Central Sandbox) Performance Test Environment (No longer offered, refer to Zuora Central Sandbox) Zuora Central Sandbox
Does this sound like you?
  • I just want to test soon-to-be released features.
  • I want to perform data migration functional testing for a small customer base.
  • I want to test features in an isolated environment using my own data.
  • I want to perform small scale data migration functional testing to validate functionality.

  • I want to perform bill runs timing load tests for an expected increase in volume.
  • I want to perform data migration timing tests.
  • I want to test features in an isolated environment using my own data.

  • I want to perform small scale data migration functional testing to validate functionalities.

  • I want to perform bill runs timing load tests for an expected increase in volume.

  • I want to perform data migration timing tests.

Suitable for

Previewing and functional testing new Zuora features before they are released to Production.

Functional testing with cloned configuration and data.

 

Heavy-load performance and stress testing.

Functional testing with cloned configuration and data.

Heavy-load performance and stress testing ([with guidelines])

Not Suitable for Performance and load testing Performance and load testing Functional testing Testing beyond Zuora’s standard concurrent request limits and application limits.
Data Migration Testing

Yes

Suitable for less than 100,000 records

Yes

Suitable for a few thousand records

Yes

Suitable for more than 100,000 records

Yes
An example of 100,000 records would be 50,000 accounts + 50,000 subscriptions.   
Infrastructure Mimics Production No No Yes Yes, fully hosted on AWS.
Includes Environment Monitoring Yes No No
See Support Responsibilities for the Performance Test Environment at the end of this article for more information.
Yes
Rollback Policy Rollbacks are not supported on any environment. Zuora recommends that you revert changes yourself – if possible. Reverting changes are possible before posting transactions on a bill run. 
Hardware Bare metal (non-virtualized) environment. Does not have 1-to-1 relationship with the production environment.

Configuration varies and is based on the number of servers and the specification of each server.

Virtualized Bare metal (non-virtualized) environment. Has a 1-to-1 relationship with the production environment. AWS cloud
Location apisandbox.zuora.com servicesn.zuora.com
where n is a number allocated during provisioning
PT1.zuora.com

https://test.zuora.com

https://test.eu.zuora.com

Supported API Authentication Schemes OAuth 2.0 (recommended), username and password, authorization cookie, single-use tokens for CORS-enabled operations Username and password, authorization cookie, single-use tokens for CORS-enabled operations OAuth 2.0 (recommended), username and password, authorization cookie, single-use tokens for CORS-enabled operations OAuth 2.0 (recommended), username and password, authorization cookie, single-use tokens for CORS-enabled operations

Refresh Policy

Zuora performs two types of refreshes: A refresh for a new Zuora version and a data snapshot refresh.

To request a refresh or get more info on Zuora's refresh policy, submit a request with Zuora Global Support and include ENVIRONMENT in the subject heading.

  API Sandbox Production Copy Environment (No longer offered, refer to Zuora Central Sandbox) Performance Test Environment (No longer offered, refer to Zuora Central Sandbox) Zuora Central Sandbox
Code base Refresh with Latest Zuora Version

Yes
Automatically refreshed approximately one week before the production release. Production releases are deployed on a weekly basis unless the scheduled date is close to the month-end.

API Sandbox is also automatically refreshed for maintenance releases.

Production Copy Environment refreshes are on-demand and do not follow the production release schedule. Refresh limited to once monthly.

Enhanced Production Copy Environment refreshes follow the production release schedule.

Note: If you request a refresh for a new Zuora version, a data refresh will also occur.

Yes
Automatically refreshed. Refreshes follow the production release schedule.

Maintenance releases also occur in this environment, following the same production release schedule.

Yes

Automatically refreshed. Refreshes follow the production release schedule.

Maintenance releases also occur in this environment, following the same production release schedule.

Note that release for Zuora Central Sandbox may occur a few days prior to, or following the production release.

Data Snapshot Refresh (Includes Scrubbed Data Copied from Production) No

You are responsible for loading your data, including creating user logins and global tenant settings.

On-demand. Refresh limited to once monthly.

Scrubbed data includes user logins, emails and global settings.

No

You are responsible for loading your own data, including user logins and global tenant settings.

On-demand. Refresh limited to once per monthly.

Scrubbed data includes user logins, emails and global settings.

Historical PDF-generated Invoices

No

You must generate PDF invoices from scratch.

No

You must regenerate any previously generated PDF invoices in this environment

No

You must generate PDF invoices from scratch.

No

You must generate PDF invoices from scratch.

Scrubbed Data

Zuora scrubs or cleans data that is copied to the Production Copy Environment to remove sensitive information. The following table provides a summary of the data that is scrubbed.

  API Sandbox Production Copy Environment (No longer offered, refer to Zuora Central Sandbox) Performance Test Environment (No longer offered, refer to Zuora Central Sandbox) Zuora Central Sandbox
Personal Settings N/A

User’s work email address.
Note: Email addresses are replaced with benign information or dummy data.

N/A

User’s work email address.                                  Note: Email addresses are replaced with benign information or dummy data.

Commerce  
Zuora for Salesforce - 360 Sync N/A Salesforce Credentials N/A Salesforce Credentials
Billing & Payments  
Customer Account N/A Bill To and Sold To Contact information:
  • Work and Personal Email
  • Work, Mobile, Home and Other phone numbers, and Address fields
  • Default Payment Method plus any Electronic Payment Methods
N/A Bill To and Sold To Contact information:
  • Work and Personal Email
  • Work, Mobile, Home and Other phone numbers, and Address fields
  • Default Payment Method plus any Electronic Payment Methods
Payment Gateways N/A Payment Gateway credentials N/A Payment Gateway credentials
Avalara Integration N/A Avalara credentials N/A Avalara credentials
Payment Pages (HPM 2.0) N/A

RSA Public Key, RSA Private Key

N/A RSA Public Key, RSA Private Key
Hosted Payment Method Pages (HPM 1.0) N/A API Security Key N/A API Security Key
Notifications and Callouts N/A Callout Base URL N/A Callout Base URL
Finance  
NetSuite N/A

NetSuite integration credentials

N/A

NetSuite integration credentials

Support for Zuora Features, Add-ons, Integrations

Zuora features, add-ons, and integrations are generally supported except where noted in the following table:

  API Sandbox   Production Copy Environment (No longer offered, refer to Zuora Central Sandbox) Performance Test Environment (No longer offered, refer to Zuora Central Sandbox) Zuora Central Sandbox
Notifications Yes

Yes

Contact Global Support if you want to disable email notifications.

Notifications related to new users, password resets, and email address changes are always enabled and cannot be disabled.

Yes Yes
Callouts Yes Yes Yes Yes
Single Sign-on Yes No Yes Yes
Two-factor Authentication Yes No Yes Yes
Reporting Yes

No

Yes Yes
New Invoice File Generation Service Yes

Yes

Submit a request at Zuora Global Support to enable this feature or service.

Yes Yes
New Quote File Generation Service Yes

Yes

Yes Yes
Orders UI, including creating Orders through the UI Yes No No Yes
Settings API Yes Yes No Yes
Data Query Yes Yes No Yes
Custom Objects Yes Yes No Yes
Events and Triggers Yes Yes No Yes
Add-ons and Integrations  

Zuora for Salesforce

Yes Yes Yes Yes
Zuora requires a 1-to-1 relationship with Salesforce for each Zuora environment.
Real-time Sync Yes Yes Yes Yes
Data Connect (Configurable Sync) Yes No No Yes
Z-Suite Yes Yes

Submit a request at Zuora Global Support to enable this feature or service.

Yes

You must submit a request at Zuora Global Support to setup and enable.

Yes
Avalara Connector Yes Yes

Submit a request at Zuora Global Support to enable this feature or service.

Yes

You must submit a request at Zuora Global Support to set up and enable the Avalara Connector.

Yes
Payment Gateways Yes
Includes any gateway that is supported in production

Yes
Includes only test gateways

You cannot use production data to simulate payment runs or update payment methods in the Production Copy Environment

Do the following to simulate a payment run in this environment:

  1. Set up a new gateway and set up new payment methods.
  2. Set a new default payment method in customer accounts.
  3. Create a simulated payment run.
Yes
Includes any gateway that is supported in production
Yes
Insights No No No No
Collect Yes No No Yes

Limits Policy

  API Sandbox Production Copy Environment (No longer offered, refer to Zuora Central Sandbox) Performance Test Environment (No longer offered, refer to Zuora Central Sandbox) Zuora Central Sandbox
Concurrent Request Limits Bounded by Policy Not Bounded by Policy Bounded by Policy Bounded by Policy

 

If Customer’s use of the Service exceeds the usage limits in the applicable contracts or as described in this Knowledge Center article for any products provided, Customer must either purchase additional usage, if applicable, or move to the next edition of the Service. If Customer does not choose either of the options, Customer shall be considered out of compliance with such Service.

Security

  API Sandbox Production Copy Environment (No longer offered, refer to Zuora Central Sandbox) Performance Test Environment (No longer offered, refer to Zuora Central Sandbox) Zuora Central Sandbox
PCI-compliant Yes No
Customers accept compliance risks
Yes No
SOC 1 and SOC 2-compliant Yes No Yes No
HIPAA-compliant Yes No Yes No
IP Whitelist Yes Yes Yes Yes
Two-factor Authentication Yes No Yes Yes

Zuora is committed to safeguarding the security, confidentiality, integrity, and availability of all physical and electronic information assets of the Company to ensure that regulatory, operational, and contractual requirements are fulfilled. Zuora's internal controls are benchmarked against industry standards such as ISO27001, ISO27018, PCI DSS Level 1, SOC 1, SOC 2 and HIPAA. Zuora Central Sandbox will be included in future ISO27001, ISO27018, PCI DSS Level 1, SOC 1, SOC 2 and HIPAA assessments starting in the fall of 2020. 

Provisioning and Refreshing Your Data

Zuora provides the following guidelines for provisioning and data refresh turnaround times for Test Environments.  We continuously strive to optimize performance and provide the best possible turnaround times for you.

When a Zuora Central Sandbox is provisioned, it will execute a data copy process that brings over a snapshot of your production data, with sensitive and P2I data scrubbed. Subsequently, every data refresh request will take a new snapshot of your scrubbed production data.  In both cases, the complete snapshot of your production data are as of the date and time when the request is submitted, as the data copy process will be triggered at a time after your request is made.

While the data copy for most tenants can be completed within less than 3 business days, it can take a longer time to complete the data copy for large tenants. In addition, the process may also take longer during the first week of a month, a peak time of data refresh requests to get a full data snapshot of the previous month.

  API Sandbox Production Copy Environment (No longer offered, refer to Zuora Central Sandbox) Performance Test Environment (No longer offered, refer to Zuora Central Sandbox) Zuora Central Sandbox
Provisioning Turnaround

(includes the copy of production data)

None

Immediate with logins

Yes

7-10 business days

Turn around is the best effort, and it may be longer for large size tenants.

Yes

7-10 business days

Turn around is the best effort, and it may be longer for large size tenants.

Yes

2-3 business days

Turn around is the best effort, and it may be longer for large size tenants.

Data Copy Request Method None Global Support None Global Support
Data Copy Frequency None Once every 29 Days None Once every 29 Days
Data Copy Requests

None

Immediate with logins

Yes

7-10 business days

Turn around is the best effort, and it may be longer for large size tenants.

Yes

7-10 business days

Yes

2-3 business days

Turn around is the best effort, and it may be longer for large size tenants.

Order Form or SOW Required

Yes

Yes

Yes

Yes
Included with Platform Fee?

Yes

Number of instances depends on Zuora Edition

No

No longer available for purchase

No

No longer available for purchase

No

Contact Zuora Global Support or your Account Contact for more information.