POST
/
entitlement
/
feature-assignments
curl -X POST \
 /entitlement/feature-assignments \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "feature": "https:\/\/example.com\/",
    "value": "",
    "validFrom": "",
    "validUntil": "",
    "objectId": "",
    "applyToExistingSubscriptions": ""
}'
{
  "id": "<string>",
  "object": "product-price",
  "objectId": "<string>",
  "feature": {
    "id": "feature-1",
    "name": "number of users",
    "description": "This feature allows you to manage the number of users in your account.",
    "status": "active",
    "type": "switch",
    "config": [
      {
        "value": "<string>",
        "label": "<string>"
      }
    ],
    "unit": "<string>"
  },
  "name": "<string>",
  "value": "<string>",
  "validFrom": "2023-11-07T05:31:56Z",
  "validUntil": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Body

The new Feature resource

Assign a feature

​
feature
string | null
required

The feature which should be assigned. Can be in any state.

Example:

"https://example.com/"

​
value
string | null
required

The value of the feature assignment

​
object
enum<string>
required

The object to which the feature should be assigned

Available options:
product-price,
product
​
objectId
string
required

The ID of the object to which the feature should be assigned

​
validFrom
string | null

The date from which the feature assignment is valid

​
validUntil
string | null

The date until which the feature assignment is valid

​
applyToExistingSubscriptions
boolean

Whether the new entitlement should be applied to existing subscriptions using this product or price.

Response

201
application/json
Feature resource created

Get feature assignments

​
id
string

The ID of the feature assignment

​
object
enum<string>

The object to which the feature is assigned

Available options:
product-price,
product
​
objectId
string

The ID of the object to which the feature is assigned

​
feature
object

The feature that is assigned

​
name
string

The full readable name of the feature assignment

​
value
string | null

The value of the feature assignment

​
validFrom
string | null

The date from which the feature assignment is valid. In the given time range it will be applied to new subscriptions.

​
validUntil
string | null

The date until which the feature assignment is valid. In the given time range it will be applied to new subscriptions.

Was this page helpful?

Get featureUnassign feature