Get feature assignments

GET

entitlement

feature-assignments

curl -X GET \
 /entitlement/feature-assignments \
 --header "Authorization: Bearer <token>"

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Query Parameters

feature

string

required

The ID of the feature

object

enum<string>

required

The object type

objectId

string

required

The ID of the object

page

integer

default:1

The collection page number

limit

integer

default:30

The number of items per page

Required range: 0 <= x <= 100

string

id[]

string[]

name

string

description

string

status

string

status[]

string[]

type

string

type[]

string[]

string

Response

200

application/json

Feature collection

data

object[]

Get feature assignments

data.id

string

The ID of the feature assignment

data.object

enum<string>

The object to which the feature is assigned

Available options:

product-price,

product

data.objectId

string

The ID of the object to which the feature is assigned

data.feature

object

The feature that is assigned

data.feature.id

string

The identifier of the feature, this can be a slug or a id. If not provided, it will be generated automatically. This must be unique.

Example:

"feature-1"

data.feature.name

string

The name of the feature. Examples: number of users, disk usage, traffic, CRM integration, API access.

Example:

"number of users"

data.feature.description

string | null

The description of the feature, shown in the admin-UI.

Example:

"This feature allows you to manage the number of users in your account."

data.feature.status

enum<string>

The status of the feature. Draft: The feature is not yet published. Those can be used to create entitlements but they won't be available until activation. Active: The feature is available and can be used. Archived: The feature is no longer available and can't be used for new entitlements. Existing entitlements will still work. Archived features can be activated again.

Available options:

draft,

active,

archived

Example:

"active"

data.feature.type

enum<string>

The type of the feature. switch: The feature can be enabled or disabled for a subscription. You can add additional config options in the options key. custom: The levels of the feature can be fully customized. As an example, you can define a feature SLA with 3 levels: basic, premium, enterprise. quantity: The levels of the feature are based on a quantity. As an example, you can define a feature number of users with levels 5, 10, 25, 50, 100. You can also provide a unlimited level. range: The value can be customized in a given range. As an example, you can define a feature disk usage with a range from 1GB to 1000GB, you can also provide a unlimited level to allow all values.

Available options:

switch,

custom,

quantity,

range

Example:

"switch"

data.feature.config

The config of the feature. This is only required for the types custom, quantity and range.

data.feature.unit

string | null

data.name

string

The full readable name of the feature assignment

data.value

string | null

The value of the feature assignment

data.validFrom

string | null

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

data.validUntil

string | null

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

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get feature assignments

Authorizations

Query Parameters

Response