Create Unit

Beta
POST/v1/catalog/units

Idempotent with Idempotency-Key header. Learn more

Creates an account-owned unit.

include[]optional arrayenumValues:ownerowner.account

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

namestring

Display name of the unit (e.g. "Gram").

abbreviationstring

Short abbreviation for the unit (e.g. "g").

typestringenumValues:currencyquantitytime

Unit dimension code.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit, as a decimal string.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit, as a decimal string.

offset_numeratorstring (decimal)

Conversion offset numerator, as a decimal string.

offset_denominatorstring (decimal)

Conversion offset denominator, as a decimal string.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Unit dimension.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions. Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator. Typically 1.

is_base_unitboolean

Whether this is the base unit for its dimension. Conversion ratios are relative to this unit.

ownerobjectExpandablenullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.
default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.
brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.
portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

Responses

201

Successful response for Create Unit