Zuora Revenue

Zuora is a leading subscription management platform, and the Zuora Revenue API connector enables seamless integration for automating, tracking, and managing revenue recognition processes in compliance with accounting standards.

Power end-to-end data operations for your Zuora Revenue API with Nexla. Our bi-directional Zuora Revenue connector is purpose-built for Zuora Revenue, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Zuora Revenue or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Zuora Revenue workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Zuora Revenue credential, you need to obtain your Zuora Revenue API Base URL, Authorization Key (Base64-encoded username:password), API User Role, and Client Name from your Zuora Revenue account. Zuora Revenue uses custom header-based authentication with Basic Authentication for token generation.

To obtain your Zuora Revenue credentials, follow these steps:

1. Sign in to your Zuora Revenue account using your administrator credentials.

2. Navigate to your Zuora Revenue account settings or API configuration in your Zuora Revenue dashboard.

3. To obtain your Zuora Revenue API Base URL, identify your Zuora Revenue environment. The Base URL depends on your Zuora Revenue environment and region. See https://www.zuora.com/developer/revpro-api/#section/Introduction/Endpoints for details about different environment URLs.

4. To obtain your Authorization Key, you need to Base64-encode your Zuora Revenue username and password in the format username:password. For example, if your username is user@example.com and your password is password123, you would encode user@example.com:password123 using Base64 encoding. The encoded value is used as the Authorization Key.

5. To obtain your API User Role, this should be the role assigned to your API user in Zuora Revenue. The default value is API Role. The API User Role is sent in the role header for API requests.

6. To obtain your Client Name, this should be the client name associated with your API user in Zuora Revenue. The default value is Default. The Client Name is sent in the clientname header for API requests.

7. Store all credentials securely, as you will need them to configure your Nexla credential. The Authorization Key is sensitive information and should be kept confidential.

The Authorization Key (Base64-encoded username:password) is used in Basic Authentication to obtain an authentication token, which is then used in subsequent API requests. The API User Role and Client Name are sent in request headers for API authentication. If your credentials are compromised, you should immediately change your password in your Zuora Revenue account settings and regenerate the Authorization Key. For detailed information about Zuora Revenue API authentication, API base URLs, and available endpoints, see the Zuora Revenue API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Zuora Revenue API Base URL	Yes	No	Enter the Base URL for your Zuora Revenue Cloud API. See https://www.zuora.com/developer/revpro-api/#section/Introduction/Endpoints for details.
Authorization Key (Use Base64Encode(username:password))	Yes	No	Zuora basic authorization token. Set this to Base64Encode(username:password).
API User Role	Yes	No	Zuora API Role
Client Name	Yes	No	Zuora API Client Name

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Zuora Revenue

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Zuora Revenue uses custom header-based authentication with Basic Authentication for token generation. Enter your Zuora Revenue API Base URL in the Zuora Revenue API Base URL field. This should be the Base URL for your Zuora Revenue Cloud API. The Base URL depends on your Zuora Revenue environment and region. See https://www.zuora.com/developer/revpro-api/#section/Introduction/Endpoints for details about different environment URLs. The Base URL determines which Zuora Revenue environment will be accessed.

4. Enter your Authorization Key (Use Base64Encode(username:password)) in the Authorization Key (Use Base64Encode(username:password)) field. This should be your Zuora basic authorization token, set to Base64Encode(username:password). For example, if your username is user@example.com and your password is password123, you would encode user@example.com:password123 using Base64 encoding. The Authorization Key is used in Basic Authentication to obtain an authentication token for subsequent API requests. The Authorization Key is sensitive information and must be kept confidential.

5. Enter your API User Role in the API User Role field. This should be the Zuora API Role assigned to your API user. The default value is API Role. The API User Role is sent in the role header for API requests.

6. Enter your Client Name in the Client Name field. This should be the Zuora API Client Name associated with your API user. The default value is Default. The Client Name is sent in the clientname header for API requests.

   Your Zuora Revenue credentials (Base URL, Authorization Key, API User Role, Client Name) can be found in your Zuora Revenue account settings. The Base URL depends on your Zuora Revenue environment and region. The Authorization Key must be Base64-encoded in the format username:password. The API User Role and Client Name are sent in request headers for API authentication.

   If your credentials are compromised, you should immediately change your password in your Zuora Revenue account settings and regenerate the Authorization Key. The credentials provide access to your Zuora Revenue account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

   For detailed information about Zuora Revenue API authentication, API base URLs, and available endpoints, see the Zuora Revenue API documentation.

7. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.

Use as a data source

To create a new data flow, navigate to the Integrate section, click the New Data Flow button, then select the desired flow type and click Create. Select the Zuora Revenue connector tile from the list of available connectors, then select the credential that will be used to connect to the Zuora Revenue instance, and click Next; or, create a new Zuora Revenue credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Zuora Revenue endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get all Task Status

This endpoint template gets the status information about all BI view related tasks from your Zuora Revenue account. Use this template when you need to access task status information, BI view task data, or task metadata for analysis, reporting, or integration purposes.

• This endpoint automatically retrieves status information about all BI view related tasks from your Zuora Revenue account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses a 2-step authentication and data retrieval process: first authenticating to obtain a token, then retrieving task status information.

This endpoint gets the status information about all BI view related tasks from your Zuora Revenue account, including task IDs, statuses, timestamps, and other task metadata. The endpoint uses a 2-step process: first authenticating to obtain a Revpro-Token, then retrieving task status information using that token.

For detailed information about task status, API response structures, and available task data, see the Zuora Revenue API documentation.

Get Report Data

This endpoint template fetches data for a Report by generating a signed URL from Zuora Revenue to download the report. This API operation is available in Zuora Revenue 37.002.00.00 and later. Use this template when you need to access report data, download reports, or retrieve report information for analysis, reporting, or integration purposes.

• Enter the Report ID in the Report ID field. This should be the ID of the report to be downloaded. You can get the report ID in the Get report list response. The Report ID determines which report will be downloaded.

This endpoint fetches data for a Report by generating a signed URL from Zuora Revenue to download the report. The endpoint processes data in a 3-step sequence: first authenticating to obtain a Revpro-Token, then generating a signed URL for the report, and finally downloading the report file. This API operation is available in Zuora Revenue 37.002.00.00 and later.

For detailed information about report data, API response structures, signed URLs, and available report data, see the Zuora Revenue API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Zuora Revenue data sources can also be manually configured to ingest data from any valid Zuora Revenue API endpoint, including endpoints not covered by the pre-built templates. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Zuora Revenue API endpoints typically follow the pattern {base_url}/api/integration/v{version}/{endpoint_path}, and require custom header-based authentication with Basic Authentication for token generation, which is handled automatically by your credential configuration.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Zuora Revenue data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.