Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure Usage Records as a target

Create a custom meter to send output data to usage records by selecting Usage Records as the target and configuring the required settings.

The Usage Records target also supports deleting usage records through the same target configuration. Delete support through the Usage Records target is available only for tenants that use the new rating pipeline.

  1. Navigate to Mediation > Meters
  2. Create a Custom meter.
  3. Select Usage Records as the target.

    Usage Record target settings

  4. Enter a Name for this target configuration.
  5. Map each source field from the upstream schema to the corresponding Zuora Billing usage record field. Select a value from the dropdown for each mapping. If your Zuora Billing tenant has custom fields defined on the Usage object, they appear in a separate custom field mappings section below the standard fields. Map each custom field to the corresponding source field as needed.
    You can search for supported data types in the search field. On the mapping screen, usage custom fields are listed in alphanumeric (A–Z) order, which makes it easier to locate related fields and reduces mapping errors when you have large numbers of custom fields.
  6. If your feed can include delete events:
    1. Enable Allow delete records in this feed.
      When enabled, the Usage Records target can treat certain incoming rows as delete requests instead of usage uploads. This is useful for correcting previously submitted data.
    2. In the Delete records when section, under Column, select the source field that signals a delete and enter the value that, when matched, marks the row as a delete request.
      When a row matches the condition, the system removes the corresponding usage record instead of creating or updating one.
    3. In Field Mappings, make sure the delete event includes Unique Key and one of the following identifier combinations:
      • Account Number and Charge Number for a subscription charge.
      • Account Number and Product Rate Plan Charge Number for a dynamic usage charge.

    A delete event is identified by the deleted flag in the payload. When deleted is true or "true", the usage pipeline locates the usage record by uniqueKey and deletes it.

    For a delete event payload, Start Date Time, Quantity, and UOM are not mandatory.

    If required delete inputs are missing, the target returns validation errors. Validation includes cases such as a missing Unique Key, a missing Charge Number or Product Rate Plan Charge Number, or an empty delete condition value when delete support is configured.

  7. Edit the mapping field if required.
  8. Click Save to save the usage records target settings.
    If the Time format for the Start Date Time field is not specified, Mediation tries predefined formats until a match is found.
    After the meter runs, you can view the resulting usage records in the usage section of your Zuora Billing tenant. A link to the usage records list is provided.