Updates the configuration of a feature on the entitlement.

PUT

/api/v1/provision/admin/entitlements/{entitlementId}/features/{featureId}

curl --request PUT \
  --url https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/features/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "featureCode": "example", "value": "example", "isAvailableDuringTrialPeriod": true, "isEnabled": true, "isPaidFeature": true, "featureExpiration": "2026-04-15T12:00:00Z", "clearFeatureExpiration": true }'

Parameters

Path Parameters

entitlementId

required

string format: uuid

Target entitlement.

featureId

required

string format: uuid

Target feature.

Request Body^required

Updated feature payload.

Admin request to set a feature’s entitlement-level state (value, enablement, trial availability, expiration). The feature is addressed by string UpdateEntitlementFeatureDto.FeatureCode.

object

featureCode

string

value

Feature value as a string, interpreted per the feature’s data type (bool, number, enum, text, or JSON).

null | string

isAvailableDuringTrialPeriod

boolean

isEnabled

boolean

isPaidFeature

When true, the feature is withheld for the duration of a trial even if enabled.

boolean

featureExpiration

When the feature stops being available. Null means the field was not sent and leaves the stored expiry untouched; use clearFeatureExpiration to remove one.

null | string format: date-time

clearFeatureExpiration

When true, removes the feature’s expiry so it follows the entitlement’s own expiration again. Sending this together with a featureExpiration is a contradiction and is refused with a 400.

boolean

Example^generated

{
  "featureCode": "example",
  "value": "example",
  "isAvailableDuringTrialPeriod": true,
  "isEnabled": true,
  "isPaidFeature": true,
  "featureExpiration": "2026-04-15T12:00:00Z",
  "clearFeatureExpiration": true
}

Admin request to set a feature’s entitlement-level state (value, enablement, trial availability, expiration). The feature is addressed by string UpdateEntitlementFeatureDto.FeatureCode.

object

featureCode

string

value

Feature value as a string, interpreted per the feature’s data type (bool, number, enum, text, or JSON).

null | string

isAvailableDuringTrialPeriod

boolean

isEnabled

boolean

isPaidFeature

When true, the feature is withheld for the duration of a trial even if enabled.

boolean

featureExpiration

When the feature stops being available. Null means the field was not sent and leaves the stored expiry untouched; use clearFeatureExpiration to remove one.

null | string format: date-time

clearFeatureExpiration

When true, removes the feature’s expiry so it follows the entitlement’s own expiration again. Sending this together with a featureExpiration is a contradiction and is refused with a 400.

boolean

Example^generated

{
  "featureCode": "example",
  "value": "example",
  "isAvailableDuringTrialPeriod": true,
  "isEnabled": true,
  "isPaidFeature": true,
  "featureExpiration": "2026-04-15T12:00:00Z",
  "clearFeatureExpiration": true
}

Admin request to set a feature’s entitlement-level state (value, enablement, trial availability, expiration). The feature is addressed by string UpdateEntitlementFeatureDto.FeatureCode.

object

featureCode

string

value

Feature value as a string, interpreted per the feature’s data type (bool, number, enum, text, or JSON).

null | string

isAvailableDuringTrialPeriod

boolean

isEnabled

boolean

isPaidFeature

When true, the feature is withheld for the duration of a trial even if enabled.

boolean

featureExpiration

When the feature stops being available. Null means the field was not sent and leaves the stored expiry untouched; use clearFeatureExpiration to remove one.

null | string format: date-time

clearFeatureExpiration

When true, removes the feature’s expiry so it follows the entitlement’s own expiration again. Sending this together with a featureExpiration is a contradiction and is refused with a 400.

boolean

Example^generated

{
  "featureCode": "example",
  "value": "example",
  "isAvailableDuringTrialPeriod": true,
  "isEnabled": true,
  "isPaidFeature": true,
  "featureExpiration": "2026-04-15T12:00:00Z",
  "clearFeatureExpiration": true
}

Responses

200

OK

400

Bad Request

object

type

null | string

title

null | string

status

null | integer | string format: int32

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

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

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

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

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

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

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

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

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

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

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

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}