Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure Zuora connection settings

Learn how to configure the Zuora Connection Settings to establish the API connection to Zuora and authorize Zuora SOAP API for your Salesforce organization.

The Zuora Quotes Connection Settings are at the global level of your organization. If you have the Multi-entity enabled, all the Zuora entities in your org share the same user name and password. When you test the connection, you receive the connection status for each entity.

  1. In Zuora Quotes, click the Zuora Config tab.
  2. On the Zuora Quotes Configuration Settings page, click Zuora Connection Settings.
  3. Click Edit Settings.
  4. Enter information for the configuration fields. The values that you enter in these fields depend on your Zuora and Salesforce configuration. The table below describes these fields in more detail.
    Note: If you do not have an API User Name and API Password, you must create one.
  5. Click Test Connection to verify the new connection setting to Zuora.
  6. Click Save.

    The following fields are available to set up a connection to Zuora.

    FieldDescriptionRequired?Legacy CPQCPQ X
    SOAP API URL

    Specify the URL provided by Zuora, including the WSDL version that you want to use. This will typically be in the format:

    <Zuora Domain URL>/apps/services/a/<version>

    <Zuora Domain URL> depends on the Zuora environment:

    • US Cloud 1 Production - https://na.zuora.com
    • US Cloud 1 API Sandbox - https://sandbox.na.zuora.com
    • US Cloud 2 Production - https://www.zuora.com
    • US Cloud 2 API Sandbox - https://apisandbox.zuora.com
    • US Central Sandbox - https://test.zuora.com
    • Production Copy - https://servicesNNN.zuora.com
    • Performance Test - https://pt1-api.zuora.com
    • EU Production - https://eu.zuora.com
    • EU API Sandbox - https://sandbox.eu.zuora.com
    • EU Central & Developer Sandbox - https://test.eu.zuora.com
    • APAC Production - https://ap.zuora.com
    • APAC Central & Developer Sandbox - https://test.ap.zuora.com

    The latest WSDL version can be found in the latest Zuora Release Notes, or in the downloaded WSDL file by navigating to Billing Settings > Download the Zuora WSDL in your Zuora tenant.

    For example:

    • https://www.zuora.com/apps/services/a/80.0
    • https://apisandbox.zuora.com/apps/services/a/80.0
    • https://test.ap.zuora.com/apps/services/a/80.0
    YesFile:Z_Media/checkmarkGreen_xsm.pngFile:Z_Media/checkmarkGreen_xsm.png
    REST API URL

    The REST API URL is automatically generated based on the SOAP API URL field. For example, if you specified https://apisandbox.zuora.com/apps/services/a/80.0 as the SOAP API URL, the generated REST API URL is https://rest.apisandbox.zuora.com.

    The following list provides all supported REST API URLs:

    • US Cloud 1 Production - https://rest.na.zuora.com
    • US Cloud 1 API Sandbox - https://rest.sandbox.na.zuora.com
    • US Cloud 2 Production - https://rest.zuora.com
    • US Cloud 2 API Sandbox - https://rest.apisandbox.zuora.com
    • US Performance Test - https://rest.pt1.zuora.com
    • US Central & Developer Sandbox - https://rest.test.zuora.com
    • US Production Copy - Submit a request at Zuora Global Support to enable the Zuora REST API in your tenant and obtain the base URL for REST endpoints. See REST endpoint base URL of Production Copy (Service) Environment for existing and new customers for more information.
    • EU Production - https://rest.eu.zuora.com
    • EU API Sandbox - https://rest.sandbox.eu.zuora.com
    • EU Central & Developer Sandbox - https://rest.test.eu.zuora.com
    • APAC Production - https://rest.ap.zuora.com
    • APAC Central & Developer Sandbox - https://rest.test.ap.zuora.com
    YesFile:Z_Media/checkmarkGreen_xsm.pngFile:Z_Media/checkmarkGreen_xsm.png
    API User Name

    Use the user name provided by Zuora.

    Zuora recommends that you use an API user for the connection setting so that the password does not expire. However, you can use either a UI or an API user to successfully establish a connection.

    YesFile:Z_Media/checkmarkGreen_xsm.pngFile:Z_Media/checkmarkGreen_xsm.png
    API PasswordUse the password provided by Zuora.YesFile:Z_Media/checkmarkGreen_xsm.pngFile:Z_Media/checkmarkGreen_xsm.png
    Note: If you plan to use flexible billing, you must use OAuth, for which API client ID and API client secret are mandatory to enter in your Zuora connections. For information about flexible billing features in CPQ X, see

    Enable and use Flexible Billing Attributes

    .
    FieldDescriptionRequiredLegacy CPQCPQ X
    API Client IdWhen you create an OAuth client for a user, Zuora displays the information for these fields. For more information about how to generate the authentication credentials, see .YesFile:Z_Media/checkmarkGreen_xsm.png
    API Client SecretYesFile:Z_Media/checkmarkGreen_xsm.png