App Login
Termin buchen
Support
App Login

Entitlement

Add subscription item entitlement

Dokumentation

Integrationen

API documentation

Getting started
Authentication
Guides

User

POST
Register a new user
POST
Complete the user registration
GET
Get the current user's accounts
POST
Set the default tenant of the current user
GET
Get all login activities
GET
Get the current user
Api Tokens

Tenant

POST
Create a new tenant
GET
Get a tenant
PATCH
Update a tenant
GET
Get the tenants of the current user

Feature

POST
Create feature
PUT
Update feature
PUT
Update feature status
GET
Get features
GET
Get feature
POST
Assign feature
DEL
Unassign feature
GET
Get feature assignments

Entitlement

GET
Get available features
POST
Add subscription entitlement
GET
Get subscription entitlements
POST
Add subscription item entitlement
GET
Get subscription item entitlements
PUT
Update entitlement status
DEL
Delete entitlement

User & permissions

GET
Get all accounts of the current tenant.
PUT
Deactivate account
PUT
Reactivate account
PUT
Update account role

Settings

Settings
Media
Webhook
Notification

Payment

Payment Method
Transaction
SEPA XML
Open Banking
Bank Account Transaction

Analytics

GET
Get series data
GET
Get series data for subscription

Customer

Customer
Customer Address
Customer Email
Customer Settings
Customer Otp

Billing

Invoice
Invoice Position Item
Billing Run

Dunning

Dunning Document
Dunning Rule

Subscription

Subscription
Subscription Item
Subscription Measurement
Billing Group

Offers

Offer
Offer Recipient
Offer Template

Catalogue

Unit
Measurement
Product
Product Family
Price Plan
Coupon

Checkout

Checkout Link
Cart

Accounting

GET
Get accounts
PUT
Update account
GET
Get postings
Cost Centre

Taxes

GET
Get tax groups
GET
Get tax group

Entitlement

Add subscription item entitlement

Creates a Entitlement resource.

POST

subscription-items

{subscriptionItemId}

entitlements

Authorization

string

Authorization

Required

string

Value for the Authorization header parameter.

subscriptionItemId

string

subscriptionItemId

Required

string

Entitlement identifier

object

feature

string

feature

Required

string

The feature which should be assigned. Must be in "active" state.

Add Example Value

value

string

value

Required

string

The value of the feature

validFrom

string

validFrom

string

The date from which the feature is valid

validUntil

string

validUntil

string

The date until which the feature is valid

Authorizations

Authorization

string

headerrequired

Value for the Authorization header parameter.

Path Parameters

subscriptionItemId

string

required

Entitlement identifier

Body

feature

string | null

required

The feature which should be assigned. Must be in "active" state.

value

string | null

required

The value of the feature

validFrom

string | null

The date from which the feature is valid

validUntil

string | null

The date until which the feature is valid

Response

201 - application/json

Get all entitlements of a subscription

string

subscriptionItem

object | null

subscriptionItem.id

string

subscriptionItem.name

string

The name of the item which will be used in the invoice. The name is translated based on the customer's locale.

subscriptionItem.description

string | null

The description of the item which will be used in the invoice. The description is translated based on the customer's locale.

subscriptionItem.furtherInformation

string | null

Further information defines additional information for the item which will be displayed in the invoice.

subscriptionItem.status

enum<string>

The status of the item.

Possible values:

active: The item is active and will be billed.
canceled: The item is canceled and will be billed until the end of the contract.
pending: The item is pending and will be billed after the contract start.
terminated: The item is terminated and will not be billed.

Available options:

active,

canceled,

pending,

terminated

subscriptionItem.subscriptionId

string

feature

object | null

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.

feature.name

string

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

feature.description

string | null

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

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

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

feature.config

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

feature.config.value

required

feature.config.label

string

required

feature.unit

string | null

value

string

The value of the entitlement. Can be a boolean (switch), a string (custom), a number (quantity) or a custom number (range).

validFrom

string | null

The date from which the entitlement is valid

validUntil

string | null

The date until which the entitlement is valid

active

boolean

Was this page helpful?

Get subscription entitlements Get subscription item entitlements

twitter github linkedin