Welcome to Zuora Product Documentation

Explore our rich library of product information

Update usage records

This reference document provides a list of all fields in the Update Usage data dictionary.

Note: Fields with an asterisk mark indicate mandatory fields.
ObjectField NameValueRequired to UpdateDescription
UsageId*stringRequired for updating field usageObject id
UsageEnd Date Timestring <date-time>OptionalThe end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation. Character limit: 29 Values: a valid date and time value.
UsageQuantitynumber <double>OptionalIndicates the number of units used. Character limit: 16 Values: A valid decimal amount.
UsageRBE StatusstringOptionalIndicates if the rating and billing engine (RBE) processed usage data for an invoice. Character limit: 9 Values: automatically generated to be one of the following values: Importing, Pending, Processed.
UsageStart Date Timestring <date-time>OptionalThe start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the EndDateTime, the StartDateTime field does affect usage calculation. Character limit: 29 Values: a valid date and time value.
UsageUnit Of MeasurestringOptionalSpecifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in Billing Settings. Character limit: Values: a valid unit of measure