Sign in
Commerce

Create a feature

Creates a catalog feature. Supported feature types are boolean (bool), enum (enumType), numbered metered, and numbered unmetered.

Numbered metered features must include metricId to reference a billable metric. Numbered unmetered features omit metricId.

post/commerce/features

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/commerce/features
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

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

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

namestring required

Unique name of the feature.

descriptionstring

Optional description of the feature.

type'bool' | 'enumType' | 'numbered' | 'unmetered' required

Feature type.

Supported values:

  • bool - Grants or denies access with a true or false value.
  • enumType - Restricts the feature to a predefined set of values. Include values.
  • numbered - Represents a numeric quantity. Include unitOfMeasure and isMetered. For numbered metered features, also include metricId and optionally isCapped.
  • unmetered - Represents a non-event-driven feature. values is not allowed.
status'Active' | 'Inactive'

Lifecycle status of the feature.

Supported values:

  • Active - The feature can be linked to products and used in entitlements.
  • Inactive - The feature is not available for new entitlements.
valuesstring[]

Permitted values for an enumType feature. Required when type is enumType. Duplicate values are not allowed.

tagsstring[]

Tags used to search and challenge features as a group.

unitOfMeasurestring

Unit used to measure a numbered feature quantity, such as Each or GB. Required when type is numbered.

unit_of_measurestring

Snake-case form of unitOfMeasure. Not allowed on boolean or enum features.

default_quantitynumber

Default quantity associated with the feature.

minimum_quantitynumber

Minimum quantity allowed for a numbered feature. Must be omitted or 0 for boolean and enum features.

maximum_quantitynumber

Maximum quantity allowed for a numbered feature.

isMeteredboolean

Indicates whether a numbered feature tracks consumption. Set to true for numbered metered features and false for numbered unmetered features. Required when type is numbered.

isCappedboolean

Indicates whether a numbered metered feature stops consumption when the entitlement quantity is reached.

metricIdstring

Identifier of the billable metric that measures usage. Required when type is numbered and isMetered is true. Omit this field for numbered unmetered features.

Example request

{
  "name": "sso_access",
  "description": "Grants single sign-on access",
  "type": "bool",
  "status": "Active",
  "values": [
    "basic",
    "premium",
    "enterprise"
  ],
  "tags": [
    "premium"
  ],
  "unitOfMeasure": "API Calls",
  "unit_of_measure": "Each",
  "default_quantity": 1000,
  "maximum_quantity": 100000,
  "isMetered": true,
  "isCapped": true,
  "metricId": "7ec58fadb6f84bc18e59c7529058d941"
}

Response

OK

Example response

{
  "value": {
    "id": "8ad088009840d1c2019855e15c993f2f",
    "featureNumber": "FEAT-00000001",
    "name": "sso_access",
    "description": "Grants single sign-on access",
    "type": "bool",
    "status": "Active",
    "values": [
      "basic",
      "premium",
      "enterprise"
    ],
    "tags": [
      "premium"
    ],
    "unitOfMeasure": "API Calls",
    "isMetered": true,
    "isCapped": true,
    "metricId": "7ec58fadb6f84bc18e59c7529058d941"
  }
}

Changes

No operation changes recorded.