Updates an existing product; only the fields set on the body are changed.

PATCH

/api/v1/provision/admin/products/{productId}

curl --request PATCH \
  --url https://example.com/api/v1/provision/admin/products/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "propertyValues": "example", "name": "example", "productCode": "example", "description": "example", "productVersion": "example", "expirationDate": "2026-04-15T12:00:00Z", "clearExpirationDate": true, "productInformation": { "displayVersion": "example", "additionalInformation": "example", "revisionInformation": "example", "downloadUrl": "example", "informationUrl": "example", "supportUrl": "example" }, "externalId": "example", "productNamespace": "example", "productMetaData": "example", "applicationScopes": [ "example" ] }'

Parameters

Path Parameters

productId

required

string format: uuid

The unique identifier of the product to update.

Request Body ^required

Patch payload — unset/null properties are left unchanged.

object

propertyValues

Custom properties for storing additional information associated with the product.

null | object

name

Public-facing name of the product used for display purposes.

null | string

productCode

Unique internal code of the product. Must be unique in combination with string? UpdateProductDto.ProductVersion.

null | string

description

Description of the product as displayed in the customer portal.

null | string

productVersion

Version of the product visible to the end user, recommended in Semantic Versioning (SemVer) format, e.g., “Major.Minor.Patch”. Optional build information may follow a plus sign, e.g., “2.1.3+build.12345”.

null | string

expirationDate

null | string format: date-time

clearExpirationDate

null | boolean

productInformation

One of:

null

null

object

Additional product information, including URLs and revision details.

object

displayVersion

null | string

additionalInformation

null | string

revisionInformation

null | string

downloadUrl

null | string

informationUrl

null | string

supportUrl

null | string

externalId

Optional external identifier, such as a CMS or ERP ID.

null | string

productNamespace

Optional namespace used to group products logically.

null | string

productMetaData

Additional metadata about the product stored as a JSON string. May include technical specifications, system requirements, or custom attributes.

null | string

applicationScopes

List of application scopes that are authorized to use this product. Application scopes define which application types or deployment targets can activate this product. If null or empty, any application can use this product (no scope restrictions).

Array<string> | null

Example ^generated

{
  "propertyValues": "example",
  "name": "example",
  "productCode": "example",
  "description": "example",
  "productVersion": "example",
  "expirationDate": "2026-04-15T12:00:00Z",
  "clearExpirationDate": true,
  "productInformation": {
    "displayVersion": "example",
    "additionalInformation": "example",
    "revisionInformation": "example",
    "downloadUrl": "example",
    "informationUrl": "example",
    "supportUrl": "example"
  },
  "externalId": "example",
  "productNamespace": "example",
  "productMetaData": "example",
  "applicationScopes": [
    "example"
  ]
}

object

propertyValues

Custom properties for storing additional information associated with the product.

null | object

name

Public-facing name of the product used for display purposes.

null | string

productCode

Unique internal code of the product. Must be unique in combination with string? UpdateProductDto.ProductVersion.

null | string

description

Description of the product as displayed in the customer portal.

null | string

productVersion

Version of the product visible to the end user, recommended in Semantic Versioning (SemVer) format, e.g., “Major.Minor.Patch”. Optional build information may follow a plus sign, e.g., “2.1.3+build.12345”.

null | string

expirationDate

null | string format: date-time

clearExpirationDate

null | boolean

productInformation

One of:

null

null

object

Additional product information, including URLs and revision details.

object

displayVersion

null | string

additionalInformation

null | string

revisionInformation

null | string

downloadUrl

null | string

informationUrl

null | string

supportUrl

null | string

externalId

Optional external identifier, such as a CMS or ERP ID.

null | string

productNamespace

Optional namespace used to group products logically.

null | string

productMetaData

Additional metadata about the product stored as a JSON string. May include technical specifications, system requirements, or custom attributes.

null | string

applicationScopes

List of application scopes that are authorized to use this product. Application scopes define which application types or deployment targets can activate this product. If null or empty, any application can use this product (no scope restrictions).

Array<string> | null

Example ^generated

{
  "propertyValues": "example",
  "name": "example",
  "productCode": "example",
  "description": "example",
  "productVersion": "example",
  "expirationDate": "2026-04-15T12:00:00Z",
  "clearExpirationDate": true,
  "productInformation": {
    "displayVersion": "example",
    "additionalInformation": "example",
    "revisionInformation": "example",
    "downloadUrl": "example",
    "informationUrl": "example",
    "supportUrl": "example"
  },
  "externalId": "example",
  "productNamespace": "example",
  "productMetaData": "example",
  "applicationScopes": [
    "example"
  ]
}

object

propertyValues

Custom properties for storing additional information associated with the product.

null | object

name

Public-facing name of the product used for display purposes.

null | string

productCode

Unique internal code of the product. Must be unique in combination with string? UpdateProductDto.ProductVersion.

null | string

description

Description of the product as displayed in the customer portal.

null | string

productVersion

Version of the product visible to the end user, recommended in Semantic Versioning (SemVer) format, e.g., “Major.Minor.Patch”. Optional build information may follow a plus sign, e.g., “2.1.3+build.12345”.

null | string

expirationDate

null | string format: date-time

clearExpirationDate

null | boolean

productInformation

One of:

null

null

object

Additional product information, including URLs and revision details.

object

displayVersion

null | string

additionalInformation

null | string

revisionInformation

null | string

downloadUrl

null | string

informationUrl

null | string

supportUrl

null | string

externalId

Optional external identifier, such as a CMS or ERP ID.

null | string

productNamespace

Optional namespace used to group products logically.

null | string

productMetaData

Additional metadata about the product stored as a JSON string. May include technical specifications, system requirements, or custom attributes.

null | string

applicationScopes

List of application scopes that are authorized to use this product. Application scopes define which application types or deployment targets can activate this product. If null or empty, any application can use this product (no scope restrictions).

Array<string> | null

Example ^generated

{
  "propertyValues": "example",
  "name": "example",
  "productCode": "example",
  "description": "example",
  "productVersion": "example",
  "expirationDate": "2026-04-15T12:00:00Z",
  "clearExpirationDate": true,
  "productInformation": {
    "displayVersion": "example",
    "additionalInformation": "example",
    "revisionInformation": "example",
    "downloadUrl": "example",
    "informationUrl": "example",
    "supportUrl": "example"
  },
  "externalId": "example",
  "productNamespace": "example",
  "productMetaData": "example",
  "applicationScopes": [
    "example"
  ]
}

Responses

200

Returns the updated product details.

object

id

string format: uuid

status

Indicates the current product status in its lifecycle.

integer

providerId

Unique identifier of the provider associated with this product.

string format: uuid

name

Public-facing name of the product used for display purposes.

string

description

Description of the product as displayed in the customer portal.

string

productCode

Unique internal code of the product. Must be unique in combination with string ProductDto.ProductVersion.

string

productVersion

Version of the product visible to the end user, recommended in Semantic Versioning (SemVer) format, e.g., “Major.Minor.Patch”. Optional build information may follow a plus sign, e.g., “2.1.3+build.12345”.

string

expirationDate

Expiration date, after which the product is no longer available for deployment. Null if no expiration is set.

null | string format: date-time

externalId

Optional external identifier, such as a CMS or ERP ID.

null | string

productNamespace

Optional namespace used to group products logically.

null | string

features

Collection of features that define additional functionalities of the product.

Array<object>

object

id

string format: uuid

featureCatalogId

null | string format: uuid

featureCode

string

featurePath

null | string

moduleName

null | string

name

string

description

null | string

usageMetric

null | string

units

null | string

featureType

integer

enumOptions

Array<object>

object

value

string

description

null | string

value

null | string

version

null | string

isEnabled

boolean

includeInLicenseToken

boolean

isAvailableDuringTrialPeriod

boolean

isAvailableDuringGracePeriod

boolean

canModifyValueOnEntitlement

boolean

meterAggregationType

One of:

null

null

integer

integer

visibility

integer

isDeleted

boolean

creationTimeStamp

string format: date-time

lastUpdateTimeStamp

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

monitoredAssets

Assets associated with the product for usage monitoring.

Array<object>

object

id

string format: uuid

entitlementId

null | string format: uuid

productId

null | string format: uuid

metricName

string

name

string

description

string

unit

string

category

string

tags

Array<string>

numberFormat

string

metricType

integer

meteredUsageId

null | string format: uuid

meteredUsage

One of:

null

null

object

object

id

string format: uuid

suspendedUntilAt

null | string format: date-time

lastReportedOverageSeverityStatus

integer

usageTiers

Array<object>

Represents a tier of usage with associated credits and severity status.

object

startUsage

Gets or sets the start usage for the tier.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

startPercentage

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endUsage

Gets or sets the end usage for the tier. Nullable.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endPercentage

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

baseCredits

Gets or sets the flat fee credits for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

creditsPerUnitOfConsumption

Gets or sets the credits per unit of consumption for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

name

Gets or sets the name of the usage tier.

string

quotaUsageLevel

Gets or sets the overage severity status for the tier.

integer

quotaUsagePolicy

Defines the enforcement behavior applied by the resource controller or interceptor when a specific usage tier threshold is reached. Ordered from least to most restrictive.

integer

consumptionPeriod

string

accumulationMethod

integer

balanceUsageId

null | string format: uuid

balanceUsage

One of:

null

null

object

object

id

string format: uuid

name

string

description

string

creditsUsed

Consumed credits since last deposit. Remaining credits are calculated as TotalCredits - CreditsUsed.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

totalCredits

Total available credits.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

cumulativeCreditsUsed

The total of all credits used over time.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

object

endUsage

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

name

string

quotaUsageLevel

integer

suspendedUntilAt

null | string format: date-time

overageSeverityStatus

integer

initialCreditAmount

The credits available when the entitlement is created.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

isUnlimitedCredits

Indicates if the resource has unlimited credits.

boolean

autoBalanceCronSchedule

Cron schedule for automatic credit balance. The cron syntax consists of five fields separated by spaces:

• Minute (0-59)
• Hour (0-23)
• Day of the Month (1-31)
• Month (1-12 or Jan-Dec)
• Day of the Week (0-6 or Sun-Sat) Special characters:
• • (asterisk): Represents any value for the field.
• , (comma): Separates multiple values.
• • (hyphen): Specifies a range of values.
• / (slash): Specifies increments. Example: “0 0 * * *” means “at midnight every day.”

null | string

lastAutoBalanceDate

Date and time of the last automatic credit balance.

string format: date-time

shouldAutoBalanceTransferCurrentCredits

Indicates if the current credits should be transferred.

boolean

maxAutoBalanceCreditTransferAmount

Maximum amount of credits that can be transferred automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

autoBalanceCreditAmount

Amount of credits to balance automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

allowedBackDatingTolerance

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

metrics

Lightweight metric definitions for this product.

Array<object>

object

id

string format: uuid

productId

string format: uuid

metricName

string

name

string

description

null | string

metricType

integer

unit

string

category

string

numberFormat

string

productInformation

Additional product information, including URLs and revision details.

object

displayVersion

null | string

additionalInformation

null | string

revisionInformation

null | string

downloadUrl

null | string

informationUrl

null | string

supportUrl

null | string

propertyValues

Custom properties for storing additional information associated with the product.

object

key

additional properties

object

key

string

value

string

metadata

Array<object> | null

object

key

string

value

string

isDeleted

boolean

createdAt

string format: date-time

updatedAt

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isLocked

Indicates if the product is locked for editing. Locked products cannot be modified.

boolean

productMetaData

Additional metadata about the product stored as a JSON string. May include technical specifications, system requirements, or custom attributes.

null | string

applicationScopes

List of application scopes that are authorized to use this product. Application scopes define which application types or deployment targets can activate this product. If null or empty, any application can use this product (no scope restrictions).

Array<string> | null

parentProductId

Parent product ID if this product belongs to an inherited version lineage.

null | string format: uuid

object

id

string format: uuid

status

Indicates the current product status in its lifecycle.

integer

providerId

Unique identifier of the provider associated with this product.

string format: uuid

name

Public-facing name of the product used for display purposes.

string

description

Description of the product as displayed in the customer portal.

string

productCode

Unique internal code of the product. Must be unique in combination with string ProductDto.ProductVersion.

string

productVersion

Version of the product visible to the end user, recommended in Semantic Versioning (SemVer) format, e.g., “Major.Minor.Patch”. Optional build information may follow a plus sign, e.g., “2.1.3+build.12345”.

string

expirationDate

Expiration date, after which the product is no longer available for deployment. Null if no expiration is set.

null | string format: date-time

externalId

Optional external identifier, such as a CMS or ERP ID.

null | string

productNamespace

Optional namespace used to group products logically.

null | string

features

Collection of features that define additional functionalities of the product.

Array<object>

object

id

string format: uuid

featureCatalogId

null | string format: uuid

featureCode

string

featurePath

null | string

moduleName

null | string

name

string

description

null | string

usageMetric

null | string

units

null | string

featureType

integer

enumOptions

Array<object>

object

value

string

description

null | string

value

null | string

version

null | string

isEnabled

boolean

includeInLicenseToken

boolean

isAvailableDuringTrialPeriod

boolean

isAvailableDuringGracePeriod

boolean

canModifyValueOnEntitlement

boolean

meterAggregationType

One of:

null

null

integer

integer

visibility

integer

isDeleted

boolean

creationTimeStamp

string format: date-time

lastUpdateTimeStamp

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

monitoredAssets

Assets associated with the product for usage monitoring.

Array<object>

object

id

string format: uuid

entitlementId

null | string format: uuid

productId

null | string format: uuid

metricName

string

name

string

description

string

unit

string

category

string

tags

Array<string>

numberFormat

string

metricType

integer

meteredUsageId

null | string format: uuid

meteredUsage

One of:

null

null

object

object

id

string format: uuid

suspendedUntilAt

null | string format: date-time

lastReportedOverageSeverityStatus

integer

usageTiers

Array<object>

Represents a tier of usage with associated credits and severity status.

object

startUsage

Gets or sets the start usage for the tier.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

startPercentage

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endUsage

Gets or sets the end usage for the tier. Nullable.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endPercentage

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

baseCredits

Gets or sets the flat fee credits for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

creditsPerUnitOfConsumption

Gets or sets the credits per unit of consumption for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

name

Gets or sets the name of the usage tier.

string

quotaUsageLevel

Gets or sets the overage severity status for the tier.

integer

quotaUsagePolicy

Defines the enforcement behavior applied by the resource controller or interceptor when a specific usage tier threshold is reached. Ordered from least to most restrictive.

integer

consumptionPeriod

string

accumulationMethod

integer

balanceUsageId

null | string format: uuid

balanceUsage

One of:

null

null

object

object

id

string format: uuid

name

string

description

string

creditsUsed

Consumed credits since last deposit. Remaining credits are calculated as TotalCredits - CreditsUsed.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

totalCredits

Total available credits.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

cumulativeCreditsUsed

The total of all credits used over time.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

object

endUsage

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

name

string

quotaUsageLevel

integer

suspendedUntilAt

null | string format: date-time

overageSeverityStatus

integer

initialCreditAmount

The credits available when the entitlement is created.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

isUnlimitedCredits

Indicates if the resource has unlimited credits.

boolean

autoBalanceCronSchedule

Cron schedule for automatic credit balance. The cron syntax consists of five fields separated by spaces:

• Minute (0-59)
• Hour (0-23)
• Day of the Month (1-31)
• Month (1-12 or Jan-Dec)
• Day of the Week (0-6 or Sun-Sat) Special characters:
• • (asterisk): Represents any value for the field.
• , (comma): Separates multiple values.
• • (hyphen): Specifies a range of values.
• / (slash): Specifies increments. Example: “0 0 * * *” means “at midnight every day.”

null | string

lastAutoBalanceDate

Date and time of the last automatic credit balance.

string format: date-time

shouldAutoBalanceTransferCurrentCredits

Indicates if the current credits should be transferred.

boolean

maxAutoBalanceCreditTransferAmount

Maximum amount of credits that can be transferred automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

autoBalanceCreditAmount

Amount of credits to balance automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

allowedBackDatingTolerance

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

metrics

Lightweight metric definitions for this product.

Array<object>

object

id

string format: uuid

productId

string format: uuid

metricName

string

name

string

description

null | string

metricType

integer

unit

string

category

string

numberFormat

string

productInformation

Additional product information, including URLs and revision details.

object

displayVersion

null | string

additionalInformation

null | string

revisionInformation

null | string

downloadUrl

null | string

informationUrl

null | string

supportUrl

null | string

propertyValues

Custom properties for storing additional information associated with the product.

object

key

additional properties

object

key

string

value

string

metadata

Array<object> | null

object

key

string

value

string

isDeleted

boolean

createdAt

string format: date-time

updatedAt

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isLocked

Indicates if the product is locked for editing. Locked products cannot be modified.

boolean

productMetaData

Additional metadata about the product stored as a JSON string. May include technical specifications, system requirements, or custom attributes.

null | string

applicationScopes

List of application scopes that are authorized to use this product. Application scopes define which application types or deployment targets can activate this product. If null or empty, any application can use this product (no scope restrictions).

Array<string> | null

parentProductId

Parent product ID if this product belongs to an inherited version lineage.

null | string format: uuid

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": 1,
  "providerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "productCode": "example",
  "productVersion": "example",
  "expirationDate": "2026-04-15T12:00:00Z",
  "externalId": "example",
  "productNamespace": "example",
  "features": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "featureCatalogId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "featureCode": "example",
      "featurePath": "example",
      "moduleName": "example",
      "name": "example",
      "description": "example",
      "usageMetric": "example",
      "units": "example",
      "featureType": 1,
      "enumOptions": [
        {
          "value": "example",
          "description": "example"
        }
      ],
      "value": "example",
      "version": "example",
      "isEnabled": true,
      "includeInLicenseToken": true,
      "isAvailableDuringTrialPeriod": true,
      "isAvailableDuringGracePeriod": true,
      "canModifyValueOnEntitlement": true,
      "meterAggregationType": "example",
      "visibility": 1,
      "isDeleted": true,
      "creationTimeStamp": "2026-04-15T12:00:00Z",
      "lastUpdateTimeStamp": "2026-04-15T12:00:00Z",
      "revisionNumber": 1
    }
  ],
  "monitoredAssets": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "metricName": "example",
      "name": "example",
      "description": "example",
      "unit": "example",
      "category": "example",
      "tags": [
        "example"
      ],
      "numberFormat": "example",
      "metricType": 1,
      "meteredUsageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "meteredUsage": {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "suspendedUntilAt": "2026-04-15T12:00:00Z",
        "lastReportedOverageSeverityStatus": 1,
        "usageTiers": [
          {
            "startUsage": 1,
            "startPercentage": 1,
            "endUsage": 1,
            "endPercentage": 1,
            "baseCredits": 1,
            "creditsPerUnitOfConsumption": 1,
            "name": "example",
            "quotaUsageLevel": 1,
            "quotaUsagePolicy": 1
          }
        ],
        "consumptionPeriod": "example",
        "accumulationMethod": 1
      },
      "balanceUsageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "balanceUsage": {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "description": "example",
        "creditsUsed": 1,
        "totalCredits": 1,
        "cumulativeCreditsUsed": 1,
        "unit": "example",
        "numberFormat": "example",
        "lastDeposit": "2026-04-15T12:00:00Z",
        "usageQuota": [
          {
            "endUsage": 1,
            "name": "example",
            "quotaUsageLevel": 1
          }
        ],
        "suspendedUntilAt": "2026-04-15T12:00:00Z",
        "overageSeverityStatus": 1,
        "initialCreditAmount": 1,
        "isUnlimitedCredits": true,
        "autoBalanceCronSchedule": "example",
        "lastAutoBalanceDate": "2026-04-15T12:00:00Z",
        "shouldAutoBalanceTransferCurrentCredits": true,
        "maxAutoBalanceCreditTransferAmount": 1,
        "autoBalanceCreditAmount": 1
      },
      "allowedBackDatingTolerance": "example"
    }
  ],
  "metrics": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "metricName": "example",
      "name": "example",
      "description": "example",
      "metricType": 1,
      "unit": "example",
      "category": "example",
      "numberFormat": "example"
    }
  ],
  "productInformation": {
    "displayVersion": "example",
    "additionalInformation": "example",
    "revisionInformation": "example",
    "downloadUrl": "example",
    "informationUrl": "example",
    "supportUrl": "example"
  },
  "propertyValues": {
    "additionalProperty": {
      "key": "example",
      "value": "example",
      "metadata": [
        {
          "key": "example",
          "value": "example"
        }
      ]
    }
  },
  "isDeleted": true,
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z",
  "revisionNumber": 1,
  "isLocked": true,
  "productMetaData": "example",
  "applicationScopes": [
    "example"
  ],
  "parentProductId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

object

id

string format: uuid

status

Indicates the current product status in its lifecycle.

integer

providerId

Unique identifier of the provider associated with this product.

string format: uuid

name

Public-facing name of the product used for display purposes.

string

description

Description of the product as displayed in the customer portal.

string

productCode

Unique internal code of the product. Must be unique in combination with string ProductDto.ProductVersion.

string

productVersion

Version of the product visible to the end user, recommended in Semantic Versioning (SemVer) format, e.g., “Major.Minor.Patch”. Optional build information may follow a plus sign, e.g., “2.1.3+build.12345”.

string

expirationDate

Expiration date, after which the product is no longer available for deployment. Null if no expiration is set.

null | string format: date-time

externalId

Optional external identifier, such as a CMS or ERP ID.

null | string

productNamespace

Optional namespace used to group products logically.

null | string

features

Collection of features that define additional functionalities of the product.

Array<object>

object

id

string format: uuid

featureCatalogId

null | string format: uuid

featureCode

string

featurePath

null | string

moduleName

null | string

name

string

description

null | string

usageMetric

null | string

units

null | string

featureType

integer

enumOptions

Array<object>

object

value

string

description

null | string

value

null | string

version

null | string

isEnabled

boolean

includeInLicenseToken

boolean

isAvailableDuringTrialPeriod

boolean

isAvailableDuringGracePeriod

boolean

canModifyValueOnEntitlement

boolean

meterAggregationType

One of:

null

null

integer

integer

visibility

integer

isDeleted

boolean

creationTimeStamp

string format: date-time

lastUpdateTimeStamp

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

monitoredAssets

Assets associated with the product for usage monitoring.

Array<object>

object

id

string format: uuid

entitlementId

null | string format: uuid

productId

null | string format: uuid

metricName

string

name

string

description

string

unit

string

category

string

tags

Array<string>

numberFormat

string

metricType

integer

meteredUsageId

null | string format: uuid

meteredUsage

One of:

null

null

object

object

id

string format: uuid

suspendedUntilAt

null | string format: date-time

lastReportedOverageSeverityStatus

integer

usageTiers

Array<object>

Represents a tier of usage with associated credits and severity status.

object

startUsage

Gets or sets the start usage for the tier.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

startPercentage

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endUsage

Gets or sets the end usage for the tier. Nullable.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endPercentage

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

baseCredits

Gets or sets the flat fee credits for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

creditsPerUnitOfConsumption

Gets or sets the credits per unit of consumption for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

name

Gets or sets the name of the usage tier.

string

quotaUsageLevel

Gets or sets the overage severity status for the tier.

integer

quotaUsagePolicy

Defines the enforcement behavior applied by the resource controller or interceptor when a specific usage tier threshold is reached. Ordered from least to most restrictive.

integer

consumptionPeriod

string

accumulationMethod

integer

balanceUsageId

null | string format: uuid

balanceUsage

One of:

null

null

object

object

id

string format: uuid

name

string

description

string

creditsUsed

Consumed credits since last deposit. Remaining credits are calculated as TotalCredits - CreditsUsed.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

totalCredits

Total available credits.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

cumulativeCreditsUsed

The total of all credits used over time.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

unit

string

numberFormat

string

lastDeposit

string format: date-time

usageQuota

Array<object>

object

endUsage

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

name

string

quotaUsageLevel

integer

suspendedUntilAt

null | string format: date-time

overageSeverityStatus

integer

initialCreditAmount

The credits available when the entitlement is created.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

isUnlimitedCredits

Indicates if the resource has unlimited credits.

boolean

autoBalanceCronSchedule

Cron schedule for automatic credit balance. The cron syntax consists of five fields separated by spaces:

• Minute (0-59)
• Hour (0-23)
• Day of the Month (1-31)
• Month (1-12 or Jan-Dec)
• Day of the Week (0-6 or Sun-Sat) Special characters:
• • (asterisk): Represents any value for the field.
• , (comma): Separates multiple values.
• • (hyphen): Specifies a range of values.
• / (slash): Specifies increments. Example: “0 0 * * *” means “at midnight every day.”

null | string

lastAutoBalanceDate

Date and time of the last automatic credit balance.

string format: date-time

shouldAutoBalanceTransferCurrentCredits

Indicates if the current credits should be transferred.

boolean

maxAutoBalanceCreditTransferAmount

Maximum amount of credits that can be transferred automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

autoBalanceCreditAmount

Amount of credits to balance automatically.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

allowedBackDatingTolerance

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

metrics

Lightweight metric definitions for this product.

Array<object>

object

id

string format: uuid

productId

string format: uuid

metricName

string

name

string

description

null | string

metricType

integer

unit

string

category

string

numberFormat

string

productInformation

Additional product information, including URLs and revision details.

object

displayVersion

null | string

additionalInformation

null | string

revisionInformation

null | string

downloadUrl

null | string

informationUrl

null | string

supportUrl

null | string

propertyValues

Custom properties for storing additional information associated with the product.

object

key

additional properties

object

key

string

value

string

metadata

Array<object> | null

object

key

string

value

string

isDeleted

boolean

createdAt

string format: date-time

updatedAt

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isLocked

Indicates if the product is locked for editing. Locked products cannot be modified.

boolean

productMetaData

Additional metadata about the product stored as a JSON string. May include technical specifications, system requirements, or custom attributes.

null | string

applicationScopes

List of application scopes that are authorized to use this product. Application scopes define which application types or deployment targets can activate this product. If null or empty, any application can use this product (no scope restrictions).

Array<string> | null

parentProductId

Parent product ID if this product belongs to an inherited version lineage.

null | string format: uuid

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": 1,
  "providerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "description": "example",
  "productCode": "example",
  "productVersion": "example",
  "expirationDate": "2026-04-15T12:00:00Z",
  "externalId": "example",
  "productNamespace": "example",
  "features": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "featureCatalogId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "featureCode": "example",
      "featurePath": "example",
      "moduleName": "example",
      "name": "example",
      "description": "example",
      "usageMetric": "example",
      "units": "example",
      "featureType": 1,
      "enumOptions": [
        {
          "value": "example",
          "description": "example"
        }
      ],
      "value": "example",
      "version": "example",
      "isEnabled": true,
      "includeInLicenseToken": true,
      "isAvailableDuringTrialPeriod": true,
      "isAvailableDuringGracePeriod": true,
      "canModifyValueOnEntitlement": true,
      "meterAggregationType": "example",
      "visibility": 1,
      "isDeleted": true,
      "creationTimeStamp": "2026-04-15T12:00:00Z",
      "lastUpdateTimeStamp": "2026-04-15T12:00:00Z",
      "revisionNumber": 1
    }
  ],
  "monitoredAssets": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "metricName": "example",
      "name": "example",
      "description": "example",
      "unit": "example",
      "category": "example",
      "tags": [
        "example"
      ],
      "numberFormat": "example",
      "metricType": 1,
      "meteredUsageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "meteredUsage": {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "suspendedUntilAt": "2026-04-15T12:00:00Z",
        "lastReportedOverageSeverityStatus": 1,
        "usageTiers": [
          {
            "startUsage": 1,
            "startPercentage": 1,
            "endUsage": 1,
            "endPercentage": 1,
            "baseCredits": 1,
            "creditsPerUnitOfConsumption": 1,
            "name": "example",
            "quotaUsageLevel": 1,
            "quotaUsagePolicy": 1
          }
        ],
        "consumptionPeriod": "example",
        "accumulationMethod": 1
      },
      "balanceUsageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "balanceUsage": {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "description": "example",
        "creditsUsed": 1,
        "totalCredits": 1,
        "cumulativeCreditsUsed": 1,
        "unit": "example",
        "numberFormat": "example",
        "lastDeposit": "2026-04-15T12:00:00Z",
        "usageQuota": [
          {
            "endUsage": 1,
            "name": "example",
            "quotaUsageLevel": 1
          }
        ],
        "suspendedUntilAt": "2026-04-15T12:00:00Z",
        "overageSeverityStatus": 1,
        "initialCreditAmount": 1,
        "isUnlimitedCredits": true,
        "autoBalanceCronSchedule": "example",
        "lastAutoBalanceDate": "2026-04-15T12:00:00Z",
        "shouldAutoBalanceTransferCurrentCredits": true,
        "maxAutoBalanceCreditTransferAmount": 1,
        "autoBalanceCreditAmount": 1
      },
      "allowedBackDatingTolerance": "example"
    }
  ],
  "metrics": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "metricName": "example",
      "name": "example",
      "description": "example",
      "metricType": 1,
      "unit": "example",
      "category": "example",
      "numberFormat": "example"
    }
  ],
  "productInformation": {
    "displayVersion": "example",
    "additionalInformation": "example",
    "revisionInformation": "example",
    "downloadUrl": "example",
    "informationUrl": "example",
    "supportUrl": "example"
  },
  "propertyValues": {
    "additionalProperty": {
      "key": "example",
      "value": "example",
      "metadata": [
        {
          "key": "example",
          "value": "example"
        }
      ]
    }
  },
  "isDeleted": true,
  "createdAt": "2026-04-15T12:00:00Z",
  "updatedAt": "2026-04-15T12:00:00Z",
  "revisionNumber": 1,
  "isLocked": true,
  "productMetaData": "example",
  "applicationScopes": [
    "example"
  ],
  "parentProductId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}