Skip to main content

Zuora Connection Settings

Zuora

Zuora Connection Settings

  1. Last updated
  2. Save as PDF

Configure your organization's Zuora API connection settings

To establish the API connection to Zuora, you must configure the Zuora Connection Settings to 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.

To configure Zuora connection settings:

  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.

Field Description Required?
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 Cloud Production - https://eu.zuora.com
  • EU Cloud API Sandbox - https://sandbox.eu.zuora.com
  • EU Central Sandbox - https://test.eu.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
 Yes
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://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 Performance Test  - https://rest.pt1.zuora.com
  • US Central 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 Sandbox - https://rest.test.eu.zuora.com
 Yes
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.

 Yes
API Password Use the password provided by Zuora. Yes

Authorize the additional Zuora REST API

If you have installed Zuora Quotes 9.22+ or CPQ X is enabled in your organization, the Zuora REST API is automatically authorized. For a full list of REST API URLs, see Access to the URL.

However, if you upgrade Zuora Quotes from an version ealier than 9.22 to version 9.22+, you must manually authorize Zuora REST API. Otherwise, a warning will be reported when you click Test Connection to verify the connection setting to Zuora.

To authorize Zuora REST API:

  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. Click Test Connection (You may need to authorize the Remote Site of Zuora REST API with the steps below.).
  5. Click Save.

To authorize the Remote Site of Zuora REST API:

  1. Navigate to Setup > Administrater > Security Controls > Remote Site Settings.
  2. Click Edit on the left of Zuora_Rest (Production) or Zuora_ApiSandbox_REST_API_Endpoint (Sandbox) on the All Remote Sites page.
  3. Tick the Active checkbox.
  4. Click Save.