Applies a temporary plan override that supersedes the assigned plan for a bounded period.

POST

/api/v1/provision/admin/entitlements/{entitlementId}/temporary-override

curl --request POST \
  --url https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/temporary-override \
  --header 'Content-Type: application/json' \
  --data '{ "planSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "planName": "example", "validFromUtc": "2026-04-15T12:00:00Z", "validUntilUtc": "2026-04-15T12:00:00Z", "reason": "example", "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Parameters

Path Parameters

entitlementId

required

string format: uuid

Entitlement id.

Request Body^required

Cancellation token.

Request to apply a temporary usage plan override to an entitlement.

object

planSetId

string format: uuid

planName

string

validFromUtc

Start of the override window; null starts it immediately.

null | string format: date-time

validUntilUtc

End of the override window; null applies it without a scheduled end.

null | string format: date-time

reason

Free-form justification recorded with the override.

null | string

campaignId

Campaign the override runs under; records a PlanOverride attribution touch on the entitlement.

null | string format: uuid

Example^generated

{
  "planSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "planName": "example",
  "validFromUtc": "2026-04-15T12:00:00Z",
  "validUntilUtc": "2026-04-15T12:00:00Z",
  "reason": "example",
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request to apply a temporary usage plan override to an entitlement.

object

planSetId

string format: uuid

planName

string

validFromUtc

Start of the override window; null starts it immediately.

null | string format: date-time

validUntilUtc

End of the override window; null applies it without a scheduled end.

null | string format: date-time

reason

Free-form justification recorded with the override.

null | string

campaignId

Campaign the override runs under; records a PlanOverride attribution touch on the entitlement.

null | string format: uuid

Example^generated

{
  "planSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "planName": "example",
  "validFromUtc": "2026-04-15T12:00:00Z",
  "validUntilUtc": "2026-04-15T12:00:00Z",
  "reason": "example",
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Request to apply a temporary usage plan override to an entitlement.

object

planSetId

string format: uuid

planName

string

validFromUtc

Start of the override window; null starts it immediately.

null | string format: date-time

validUntilUtc

End of the override window; null applies it without a scheduled end.

null | string format: date-time

reason

Free-form justification recorded with the override.

null | string

campaignId

Campaign the override runs under; records a PlanOverride attribution touch on the entitlement.

null | string format: uuid

Example^generated

{
  "planSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "planName": "example",
  "validFromUtc": "2026-04-15T12:00:00Z",
  "validUntilUtc": "2026-04-15T12:00:00Z",
  "reason": "example",
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

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