Welcome to Zuora Product Documentation

Explore our rich library of product information

Zuora Central Sandbox guidelines

Review the guidance for using the developer sandbox.

General information and implementation guidelines

  • Zuora Central Sandbox supports copying multiple entities from your production environment with the following limitations:

    • Central Sandbox does not support swapping the parent and child entity hierarchy structure. The swapping of the entity hierarchy in a Production environment will not be reflected in the Central Sandbox.

    • We only support the refresh at the global level. Refreshing just a single child entity is not supported.

  • To avoid compliance issues, Zuora Central Sandbox does not support downloading finance reports and invoice PDFs generated from your production environment. Once data is copied over from production to Central Sandbox, the data is scrubbed and is considered as testing data. You can still perform common activities like reopen accounting periods and re-run trial balance, which will generate finance reports based on the latest testing data. The original reports or invoice PDFs can only be downloaded from your production environment.

  • The refresh from Production to Central Sandbox is limited to every 28 days.

  • Central Sandbox only allows the copy of the entire production data and does not allow the copy of a subset of data.

  • When copied from Production to CSBX, PII data stored within custom objects or custom fields are not automatically scrubbed and must be removed by the user.

  • Zuora Central Sandbox copies only usage data from the previous month. Contact Zuora Global Support if you require more than a month of usage data. Depending on your tenants' usage volume, requests for more than a month may increase refresh time.

  • Zuora Central Sandbox copies SSL certificates in callout templates on refreshes. However, if a callout template in Central Sandbox has been overwritten with another SSL certificate, Zuora Central Sandbox will keep the updated certificate on future refreshes.

  • Zuora Central Sandbox uses Coordinated Universal Time (UTC) as the system time.

  • Zuora Central Sandbox supports the availability and data copy of many features to help you achieve your testing and deployment needs. In addition to the supported Zuora features, Zuora Central Sandbox supports Workflow, Collections, and other Marketplace applications in different levels in terms of feature availability and data copy.

  • All Central Sandbox tenants must be copied or refreshed from a production environment. It is not possible to create or provision a standalone Central Sandbox tenant.

  • All data in your central sandbox is deleted during the refresh process and the data from your production environment is copied to the sandbox. For central sandbox, full configuration and transactional data is copied from production, in contrast to developer sandbox, to which only the metadata from production is copied. Your sandbox will be unavailable until the refresh is complete.

  • Feature availability is defined as whether features can be used to create new configurations and data based on your entitlements. For example, if you have Workflow entitled, you can use Zuora Central Sandbox to create and test new Workflows against your production data. If you have Collections entitled, you can create new Collections configurations and test how it works with your production data.

  • Limit testing to end-to-end feature testing and start with smaller data sets.

  • Contact Zuora Global Support if you plan on any activity that exceeds the guidelines in a 24-hour period.

  • Reduce or turn off notifications and callouts.

Data copy guidelines

You can request for a data copy once every 28 days through the following ways:

  • Request through the Zuora Central Sandbox homepage.

  • It takes up to 7 business days to complete the data copy of your environment.

    Zuora recommends that you plan ahead for your testing and data copy request. While the data copy for most tenants can be completed in less than 3 business days, it can take a longer time to complete the data copy for large tenants.

  • Submit a request at Zuora Global Support. You must provide the endpoint of your environment when submitting the request.

  • Zuora system's concurrent request limits are applicable to all sandboxes and production environments.

  • The data limitations of every Zuora application or service in the production environment are also applicable to the Zuora Central Sandbox environment.

Access Zuora Central Sandbox environments

You can access Zuora Central Sandbox environments through the Zuora UI and API.

Username and password

The naming convention of your Zuora Central Sandbox login username is:

<username>_<tenant id>

<username> is your username of Zuora production environment, and <tenant id> is your Zuora Central Sandbox tenant ID that is sent to you when your Zuora Central Sandbox environment is provisioned. For example, john.doe@zuora.com_10000001.

The tenant ID appears in the username to help identify which Zuora Central Sandbox tenant you are logging into.

Your login password for the Zuora Central Sandbox environment is the same as that of the corresponding production environment.

Initial setup

After first login, use this checklist to update configurations. These initial configurations are retained for every subsequent refresh. To learn what key attributes are scrubbed during a refresh, see Scrubbed data.

  • Reconfigure the integration with external applications (for example, Salesforce, Avalara, Payment Gateways, and so on) as credentials for the external applications are scrubbed for security purposes when your Zuora Central Sandbox environment is provisioned.

  • If you have a Salesforce integration, Zuora 360 in Salesforce must be updated with a new Entity Key and Id representing the new Zuora Central Sandbox tenant.

  • Reconfigure all required certificates as certificates will be scrubbed.

  • Reconfigure your APIs, callouts, and schedules in Workflow, as Workflow endpoints and credentials may change.

  • Reconfigure your callouts within Workflow, as callout data may be scrubbed.

  • Central Sandbox refresh does not copy the scheduled Bill Run and Payment Run, so the Bill Run and Payment Run will not work as scheduled after the refresh.

  • Central Sandbox refresh does not copy the OAuth 2.0 providers. You can create and manage OAuth 2.0 providers independently across Production and Central Sandbox environments.

  • Ensure any additional information within Workflows such as callout endpoints, credentials, and liquid templates are updated as needed.

  • Ensure any additional information within Events & Notifications such as callout endpoints, credentials, and activation are configured.

  • Add new users to Commerce Portal. Note that your users from production are not inherited to Central Sandbox automatically.

  • Reconfigure tokens that relate Commerce Portal to other apps (for example, Customer Catalog). Tokens from each source app will be regenerated and must be obtained from that app within the Central Sandbox environment.

  • Within the Collections application, tokens that relate to various applications (for example, Workflow, Payment Plans, Notes) must be reconfigured.