Sign in
Meters

Test a specific version of a meter

Test a specific version of a meter in Zuora Mediation without executing a full run. It supports multiple input methods, including uploaded files, sample files, and manual test data. This is useful for validating meter logic and transformations before meter run.

post/meters/debug/{meterId}/{version}

Path parameters

meterIdinteger required

The ID of the meter to be tested.

versionstring required

The version of the meter to be tested.

Headers

Content-Typestring required

Specify the content type of the request body. Use application/json.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Request body

Response

Successfully tested meter version.

idstring

Internal run history ID, unique within tenant.

sessionIdstring

The corresponding session ID of this run.

jobIdstring

The corresponding job ID of this run.

meterIdinteger

The meter ID.

versionstring

The version of the meter.

revisioninteger

The revision of the meter version when it runs.

runTypeinteger

The run type of the meter (1 for NORMAL, 2 for DEBUG).

runTypeDescriptionstring

Description of the run type.

startTimestring

The start time of the run in ISO 8601 format.

endTimestring

The end time of the run in ISO 8601 format.

runStatusstring

The status of the run (e.g., NEVER_RUN, TESTING, FAILED).

runStatusDescriptionstring

Description of the run status.

canExportSummaryboolean

Whether the summary is ready to export.

hasLineageEnabledboolean

Whether lineage is enabled for this run.

Changes