Sets the subscription policy on the entitlement.

POST

/api/v1/provision/admin/entitlements/{entitlementId}/policies/subscription

curl --request POST \
  --url https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/policies/subscription \
  --header 'Content-Type: application/json' \
  --data '{ "renewPeriod": "example", "renewInterval": 1, "cannotActivateBeforeTimestamp": "2026-04-15T12:00:00Z", "notValidAfterTimestamp": "2026-04-15T12:00:00Z", "isSubscriptionActive": true, "subscriptionPeriodsLeft": 1, "softEnforcement": true, "nextRenewalTimeStamp": "2026-04-15T12:00:00Z" }'

Parameters

Path Parameters

entitlementId

required

string format: uuid

Target entitlement.

Request Body^required

Policy payload.

Recurring-renewal policy on an entitlement: how often it renews, how many periods remain, and the outer validity bounds.

object

renewPeriod

Calendar unit of one renewal period (e.g. "month"); combined with int SubscriptionPolicyDto.RenewInterval.

string

renewInterval

Number of string SubscriptionPolicyDto.RenewPeriod units per renewal (e.g. 3 with “month” renews quarterly).

integer | string format: int32

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

cannotActivateBeforeTimestamp

null | string format: date-time

notValidAfterTimestamp

null | string format: date-time

isSubscriptionActive

boolean

subscriptionPeriodsLeft

Renewal periods remaining before the subscription lapses (capped at int SubscriptionPolicyDto.MaxSubscriptionPeriods).

integer | string format: int32

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

softEnforcement

Stored with the policy and returned on reads; license validation does not currently act on this flag.

boolean

nextRenewalTimeStamp

string format: date-time

Example^generated

{
  "renewPeriod": "example",
  "renewInterval": 1,
  "cannotActivateBeforeTimestamp": "2026-04-15T12:00:00Z",
  "notValidAfterTimestamp": "2026-04-15T12:00:00Z",
  "isSubscriptionActive": true,
  "subscriptionPeriodsLeft": 1,
  "softEnforcement": true,
  "nextRenewalTimeStamp": "2026-04-15T12:00:00Z"
}

Recurring-renewal policy on an entitlement: how often it renews, how many periods remain, and the outer validity bounds.

object

renewPeriod

Calendar unit of one renewal period (e.g. "month"); combined with int SubscriptionPolicyDto.RenewInterval.

string

renewInterval

Number of string SubscriptionPolicyDto.RenewPeriod units per renewal (e.g. 3 with “month” renews quarterly).

integer | string format: int32

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

cannotActivateBeforeTimestamp

null | string format: date-time

notValidAfterTimestamp

null | string format: date-time

isSubscriptionActive

boolean

subscriptionPeriodsLeft

Renewal periods remaining before the subscription lapses (capped at int SubscriptionPolicyDto.MaxSubscriptionPeriods).

integer | string format: int32

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

softEnforcement

Stored with the policy and returned on reads; license validation does not currently act on this flag.

boolean

nextRenewalTimeStamp

string format: date-time

Example^generated

{
  "renewPeriod": "example",
  "renewInterval": 1,
  "cannotActivateBeforeTimestamp": "2026-04-15T12:00:00Z",
  "notValidAfterTimestamp": "2026-04-15T12:00:00Z",
  "isSubscriptionActive": true,
  "subscriptionPeriodsLeft": 1,
  "softEnforcement": true,
  "nextRenewalTimeStamp": "2026-04-15T12:00:00Z"
}

Recurring-renewal policy on an entitlement: how often it renews, how many periods remain, and the outer validity bounds.

object

renewPeriod

Calendar unit of one renewal period (e.g. "month"); combined with int SubscriptionPolicyDto.RenewInterval.

string

renewInterval

Number of string SubscriptionPolicyDto.RenewPeriod units per renewal (e.g. 3 with “month” renews quarterly).

integer | string format: int32

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

cannotActivateBeforeTimestamp

null | string format: date-time

notValidAfterTimestamp

null | string format: date-time

isSubscriptionActive

boolean

subscriptionPeriodsLeft

Renewal periods remaining before the subscription lapses (capped at int SubscriptionPolicyDto.MaxSubscriptionPeriods).

integer | string format: int32

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

softEnforcement

Stored with the policy and returned on reads; license validation does not currently act on this flag.

boolean

nextRenewalTimeStamp

string format: date-time

Example^generated

{
  "renewPeriod": "example",
  "renewInterval": 1,
  "cannotActivateBeforeTimestamp": "2026-04-15T12:00:00Z",
  "notValidAfterTimestamp": "2026-04-15T12:00:00Z",
  "isSubscriptionActive": true,
  "subscriptionPeriodsLeft": 1,
  "softEnforcement": true,
  "nextRenewalTimeStamp": "2026-04-15T12:00:00Z"
}

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"
}