API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
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 features
Retrieves the collection of Feature resources.
curl -X GET \
/entitlement/features \
--header "Authorization: Bearer <token>"{
"data": [
{
"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>"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Authorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
0 <= x <= 100Response
Get all entitlement features.
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-1"
The name of the feature. Examples: number of users, disk usage, traffic, CRM integration, API access.
"number of users"
The description of the feature, shown in the admin-UI.
"This feature allows you to manage the number of users in your account."
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.
draft, active, archived "active"
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.
switch, custom, quantity, range "switch"
Was this page helpful?
curl -X GET \
/entitlement/features \
--header "Authorization: Bearer <token>"{
"data": [
{
"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>"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}