Zuora Usage Record Forwarder

The Zuora Usage Record Forwarder is used to send usage data to Zuora Billing using the Zuora Post Usage API or with the Active Rating Post Usage API. You map fields from a source to specific target fields, and Zuora Usage Record Forwarder then compiles and forwards the mapped fields accordingly.

The options are available under the Parameters and Configuration tabs. The Parameters tab allows you to set the values for how the Zuora Usage Record Forwarder would behave when communicating with the Zuora Billing system. The Configuration tab allows you to configure options to send the usage data and allows you to enable the use of Active Rating on the Zuora Usage Record Forwarder.

Parameters

Under Parameters, you get the Environment, Credentials, and Entity options to configure your connection settings.

Parameters.png

Environment

Field

Description

Field

Description

Tenant

The name of the Zuora environment. The following endpoints are available for selection:

US DC1 Production: https://rest.na.zuora.com/
US DC2 Production: https://rest.zuora.com/
US DC1 API Sandbox: https://rest.sandbox.na.zuora.com/
US DC2 API Sandbox: https://rest.apisandbox.zuora.com/
US Central Sandbox: https://rest.test.zuora.com/

EU Production: https://rest.eu.zuora.com/
EU Sandbox: https://rest.sandbox.eu.zuora.com/
EU Central Sandbox: https://rest.test.eu.zuora.com/

Custom - Use this option to access your own custom tenant environment. Specify the URL for your endpoint.

 

Credentials

Field

Description

Field

Description

Secrets Wallet

 

Secrets Wallet

Choose from a list of Zuora secret wallet passes.

 

Entity

Field

Description

Field

Description

Multi-Entity

If you have the Zuora Multi-entity feature enabled, you can specify the name of the entity you want access to. Zuora Multi-entity provides the capability to create and manage multiple entities within a single Zuora tenant.

For more information on Zuora Multi-entity, refer to https://knowledgecenter.zuora.com/Billing/Tenant_Management/Multi-entity .

 

Configuration

Under Configuration, you get the Request, Field mapping, Required fields, Optional fields, Operational Settings, and Response handling options to set for the Zuora Usage Record Forwarder. The configuration fields will be different if you have toggled on Use Active Rating described below.

Request

To send usage data to a Zuora Billing system, toggle off Use Active Rating. The Active Rating option is only applicable to Zuora customers that have the Active Rating feature activated, and the Use Active Rating toggle should always be off if this is not the case.