Grants an add-on to the entitlement.

POST

/api/v1/provision/admin/entitlements/{entitlementId}/add-on-grants

curl --request POST \
  --url https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/add-on-grants \
  --header 'Content-Type: application/json' \
  --data '{ "addOnId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "startsAtUtc": "2026-04-15T12:00:00Z", "expiresAtUtc": "2026-04-15T12:00:00Z", "reference": "example", "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Parameters

Path Parameters

entitlementId

required

string format: uuid

Entitlement id.

Request Body^required

Cancellation token.

Admin request to grant an add-on to an entitlement.

object

addOnId

string format: uuid

startsAtUtc

When the grant takes effect; null starts it immediately.

null | string format: date-time

expiresAtUtc

When the grant ends; null grants it without expiry.

null | string format: date-time

reference

Free-form reference (e.g. order number) recorded on the grant.

null | string

campaignId

Campaign the grant runs under; records an AddOnGrant attribution touch on the entitlement.

null | string format: uuid

Example^generated

{
  "addOnId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "startsAtUtc": "2026-04-15T12:00:00Z",
  "expiresAtUtc": "2026-04-15T12:00:00Z",
  "reference": "example",
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Admin request to grant an add-on to an entitlement.

object

addOnId

string format: uuid

startsAtUtc

When the grant takes effect; null starts it immediately.

null | string format: date-time

expiresAtUtc

When the grant ends; null grants it without expiry.

null | string format: date-time

reference

Free-form reference (e.g. order number) recorded on the grant.

null | string

campaignId

Campaign the grant runs under; records an AddOnGrant attribution touch on the entitlement.

null | string format: uuid

Example^generated

{
  "addOnId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "startsAtUtc": "2026-04-15T12:00:00Z",
  "expiresAtUtc": "2026-04-15T12:00:00Z",
  "reference": "example",
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Admin request to grant an add-on to an entitlement.

object

addOnId

string format: uuid

startsAtUtc

When the grant takes effect; null starts it immediately.

null | string format: date-time

expiresAtUtc

When the grant ends; null grants it without expiry.

null | string format: date-time

reference

Free-form reference (e.g. order number) recorded on the grant.

null | string

campaignId

Campaign the grant runs under; records an AddOnGrant attribution touch on the entitlement.

null | string format: uuid

Example^generated

{
  "addOnId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "startsAtUtc": "2026-04-15T12:00:00Z",
  "expiresAtUtc": "2026-04-15T12:00:00Z",
  "reference": "example",
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

OK

An add-on grant on an entitlement as returned by the admin API, denormalized with the add-on and suite display fields.

object

id

string format: uuid

addOnId

string format: uuid

addOnCode

string

addOnName

string

suiteId

The suite this add-on overlays.

string format: uuid

suiteName

Display name of that suite.

string

startsAt

string format: date-time

expiresAt

null | string format: date-time

isRevoked

boolean

revokedAt

null | string format: date-time

reference

null | string

campaignId

Campaign the grant was made under, when it was part of one.

null | string format: uuid

isActive

True when the grant is inside its start/expiry window and not revoked.

boolean

An add-on grant on an entitlement as returned by the admin API, denormalized with the add-on and suite display fields.

object

id

string format: uuid

addOnId

string format: uuid

addOnCode

string

addOnName

string

suiteId

The suite this add-on overlays.

string format: uuid

suiteName

Display name of that suite.

string

startsAt

string format: date-time

expiresAt

null | string format: date-time

isRevoked

boolean

revokedAt

null | string format: date-time

reference

null | string

campaignId

Campaign the grant was made under, when it was part of one.

null | string format: uuid

isActive

True when the grant is inside its start/expiry window and not revoked.

boolean

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "addOnId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "addOnCode": "example",
  "addOnName": "example",
  "suiteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "suiteName": "example",
  "startsAt": "2026-04-15T12:00:00Z",
  "expiresAt": "2026-04-15T12:00:00Z",
  "isRevoked": true,
  "revokedAt": "2026-04-15T12:00:00Z",
  "reference": "example",
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "isActive": true
}

An add-on grant on an entitlement as returned by the admin API, denormalized with the add-on and suite display fields.

object

id

string format: uuid

addOnId

string format: uuid

addOnCode

string

addOnName

string

suiteId

The suite this add-on overlays.

string format: uuid

suiteName

Display name of that suite.

string

startsAt

string format: date-time

expiresAt

null | string format: date-time

isRevoked

boolean

revokedAt

null | string format: date-time

reference

null | string

campaignId

Campaign the grant was made under, when it was part of one.

null | string format: uuid

isActive

True when the grant is inside its start/expiry window and not revoked.

boolean

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "addOnId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "addOnCode": "example",
  "addOnName": "example",
  "suiteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "suiteName": "example",
  "startsAt": "2026-04-15T12:00:00Z",
  "expiresAt": "2026-04-15T12:00:00Z",
  "isRevoked": true,
  "revokedAt": "2026-04-15T12:00:00Z",
  "reference": "example",
  "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "isActive": true
}

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