Zuora Usage Records

Open

The Zuora Usage Records is a forwarder used to send usage data to Zuora Billing using theUsage (Non-active Rating API) or with the Active Rating API.
You map fields from a source to specific target fields, and the Zuora Usage Records function then compiles and forwards the mapped fields accordingly.

You can configure this function in the following settings.

Select the Zuora environment.

Select a Zuora credential from Secrets walletPreview.

Specify the name of the entity if you have the Zuora Multi-entity feature enabled.

The configuration fields will differ if you have toggled on Use Active Rating as described below.

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.

Required fields

In Required fields, the field mapping is done for the mandatory fields for the usage record. You must specify the Source field based on the input from the previous function for the appropriate Required fields. There are three Required fields that must be mapped to the source fields: Quantity, StartDateTime, and UOM.

Open

Request configuration

Optional fields

In Optional fields, you add the remaining optional fields, or you may add additional custom fields to compile the usage record. To add an optional field, click the Add field mapping button. There are ten default Optional fields:

• AccountId

• AccountNumber

• ChargeId

• ChargeNumber

• Description

• EndDateTime

• SubscriptionId

• SubcriptionNumber

• UniqueKey

• ProductRatePlanChargeNumber

To add a custom field mapping, type the custom field name into Add field. Added custom fields will automatically be appended with the suffix ___c. You do not need to include this suffix in the field name.

Operational settings

In the Operational settings, you can take the following optional steps to configure the Zuora Usage Records function:

You can toggle Retry on fail to let the service retry each request when the server returns error codes such as 429, 500, or 503 because of intermittent server issues or rate limiting.

You can specify the number of retries in the Number of retries box, and the service performs those retries within a dynamically adjusted retry period. This retry behavior applies only to 5xx and 429(Too many requests) error codes.

Action on error controls what happens when an error occurs during processing. You can select one of the following options:

• Ignore - The stream continues processing the next records even if an error occurs. This is the default option.

• Stop stream - The stream stops when an error occurs.

If Retry on fail is enabled, retries always take precedence over Action on error:

• If the retry limit is reached and the error still persists, the selected Action on error option is applied (Ignore or Stop stream).

Open

Operational settings configuration

Response handling

Toggling the Response handling on will allow you to Select Interconnect receiver. The Zuora Usage Records function has a built-in Interconnect sender which will forward the status ID, request and record details received from Zuora. A second stream can use the Interconnect receiverPreview to accept the status ID, request and records details forwarded by the Zuora Usage Records function to track the status of the submitted usage record in Zuora. If the stream fails for any reason, the Zuora Usage Records function will not send anything through the Interconnect sender.

Open

Response handling configuration

In Required fields, the field mapping is done for the mandatory fields for the usage record. You must specify the Source field based on the input from the previous function for the appropriate Required fields. There are five Required fields that must be mapped to the source fields: 

• accountNumber

• tag

• unitOfMeasure

• startDateTime

• quantity

Open

Request configuration

In Optional fields, you add the remaining optional fields, or you may add additional custom fields to compile the usage record. To add an optional field, click the Add field mapping button. There are three Optional fields and those are description, groupId, and uniqueKey. To add a custom field mapping, type the custom field name into Add field. 

Open

Optional fields configuration

In the Operational settings, you can take the following optional steps to configure Zuora Usage Records function:

You can toggle Retry on fail to let the service retry each request when the server returns error codes such as 429, 500, or 503 because of intermittent server issues or rate limiting.

You can specify the number of retries in the Number of retries box, and the service performs those retries within a dynamically adjusted retry period. This retry behavior applies only to 5xx and 429(Too many requests) error codes.

Action on error controls what happens when an error occurs during processing. You can select one of the following options:

• Ignore - The stream continues processing the next records even if an error occurs. This is the default option.

• Stop stream - The stream stops when an error occurs.

If Retry on fail is enabled, retries always take precedence over Action on error:

• If the retry limit is reached and the error still persists, the selected Action on error option is applied (Ignore or Stop stream).

Open

Operational settings configuration

Toggling the Response handling on will allow you to Select Interconnect receiver. The Zuora Usage Records function has a built-in Interconnect sender which will forward the status ID, request and records details received from Zuora. A second stream can use the Interconnect receiverPreview to accept the status ID, request and records details forwarded by the Zuora Usage Records function to track the status of the submitted usage record in Zuora. If the stream fails for any reason, Zuora Usage Records function will not send anything through the Interconnect sender.