CRUD: Create a unit of measure

Request
query Parameters
rejectUnknownFields
boolean
Default: false

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

header Parameters
Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encoding
string

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-Encoding
string

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.

Authorization
string

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

Zuora-Entity-Ids
string

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

Request Body schema: application/json
required
Active
boolean

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

DecimalPlaces
required
integer <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

DisplayedAs
string

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

RoundingMode
string

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

UomName
required
string

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

Responses
200
400
401
post/v1/object/unit-of-measure
Request samples
application/json
{
  • "Active": true,
  • "DecimalPlaces": 9,
  • "DisplayedAs": "name_display_name_1476935033519",
  • "RoundingMode": "UP",
  • "UomName": "name_1476935033519"
}
Response samples
application/json
{
  • "Success": true,
  • "Id": "2c93808457d787030157e030232f3748"
}