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 feature assignments
Retrieves the collection of Feature resources.
Value for the Authorization header parameter.
The ID of the feature
The object type
The ID of the object
The collection page number
The number of items per page
Authorizations
Value for the Authorization header parameter.
Query Parameters
The ID of the feature
The object type
The ID of the object
The collection page number
The number of items per page
0 < x < 100
Response
The ID of the feature assignment
The object to which the feature is assigned
product-price
, product
The ID of the object to which the feature is assigned
The feature that is assigned
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.
The name of the feature. Examples: number of users
, disk usage
, traffic
, CRM integration
, API access
.
The description of the feature, shown in the admin-UI.
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
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
The full readable name of the feature assignment
The value of the feature assignment
The date from which the feature assignment is valid. In the given time range it will be applied to new subscriptions.
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?