Skip to main content
PUT
Update Entitlement

Authorizations

X-API-KEY
string
header
required

The authorization key obtained from MarketONE.

Path Parameters

id
string<uuid>
required

The id parameter is the entitlement identifier.

Body

application/json

Entitlement update request for a single entitlement (identified by the entitlement id in the path). All fields are optional. The itemId and commerceProductCode cannot be modified independently; when changing either of them the merchantProductCode representing that combination must also be supplied.

itemId
string

The entitlement item identifier. Cannot be changed on its own - must be sent together with the corresponding merchantProductCode.

commerceProductCode
string

The commerce (reseller/service provider) product code. Cannot be changed on its own - must be sent together with the corresponding merchantProductCode.

merchantProductCode
string

The merchant product code. Required when changing itemId or commerceProductCode.

quantity
integer

Populate the quantity that this entitlement should represent. Required for products with QUANTITY entitlementType.

Required range: x >= 1
Example:

500

metadata
object

A set of key/value pairs that you can attach to an object. Useful for storing additional information.

Response

OK

Response returned when updating a single entitlement. Mirrors the provisioning response but contains a single item rather than a list.

subscription
object