Skip to content

CRUD: Retrieve a unit of measure

Request

Path
idstringrequired

Object id

Query
fieldsstring

Object fields to return

Headers
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.

Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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 do not need to set this header.

Zuora-Track-Idstring, <= 64 characters

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 (').

cURL
curl -i -X GET \
  'https://rest.zuora.com/v1/object/unit-of-measure/{id}?fields=string' \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: string' \
  -H 'Content-Encoding: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Track-Id: string'

Responses

Headers
Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json
Activeboolean

Indicates if the UOM is available for new product rate plans. The default value is true. Character limit: 5 Values: true, false

CreatedByIdstring

The ID of the Zuora user who created the UOM. Character limit: 32 Values: automatically generated

CreatedDatestring, (date-time)

The date when the UOM was created. Character limit: 29 Values: automatically generated

DecimalPlacesinteger, (int64)

The number of digits to the right of the decimal point that you want to measure for the unit. To use whole numbers only, set this value to 0. You can't change this value after this UOM is used in any product, subscription, or usage. Character limit: 1 Values: an integer between 0 and 9, exclusive

DisplayedAsstring

The name of the UOM that you want displayed on invoices. The default value is the UomName field value. Character limit: 50 Values: A string of 50 characters or fewer

Idstring

Object identifier.

RoundingModestring

Specifies whether to round the UOM value up or down when the value exceeds the DecimalPlaces field value. The default value is Up. Character limit: 4 Values: Up, Down

UomNamestring

The name of the UOM, such as license or GB. This name is displayed in query results and in the web-based UI labels. If you want a different name to be displayed on invoices, then use the DisplayedAs field to provide the invoice label. Character limit: 50 Values: a string of 50 characters or fewer

UpdatedByIdstring

The ID of the user who lasted updated the UOM. Character limit: 32 Values: automatically generated

UpdatedDatestring, (date-time)

The date when the UOM was last updated. Character limit: 29 Values: automatically generated

Response
{ "Active": true, "Id": "2c93808457d787030157e030232f3748", "CreatedById": "2c93808457d787030157e0300f6735d3", "CreatedDate": "2016-10-20T05:43:53.000+02:00", "UpdatedDate": "2016-10-20T05:43:53.000+02:00", "DisplayedAs": "name_display_name_1476935033519", "UomName": "name_1476935033519", "RoundingMode": "UP", "UpdatedById": "2c93808457d787030157e0300f6735d3", "DecimalPlaces": 9 }