Skip to main content
POST
Create entitlement

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Body

application/json

Create Entitlement Request Schema

name
string
required

Entitlement name

description
string | null

Entitlement Description

entitlement_type
enum<string> | null

Entitlement Type

Available options:
Feature,
Quantity,
Credits
units
string | null

Entitlement Units

is_active
boolean | null

Entitlement is active

product_id
string<uuid> | null

Product ID

Response

Successful Response

Create Entitlement Response Schema

id
string<uuid>
required

Entitlement Id

name
string
required

Entitlement name

description
string | null

Entitlement Description

entitlement_type
enum<string> | null

Entitlement Type

Available options:
Feature,
Quantity,
Credits
units
string | null

Entitlement Units

is_active
boolean | null
default:true

Entitlement is active

product_id
string<uuid> | null

Product ID

created_at
string<date-time> | null

created time