Feature types categorise billable services and define the defaults that features inherit. Use this endpoint to read and maintain them programmatically. For a plain-English explanation, see the Feature Types user guide.
Methods
GET
Retrieve Single Feature Type
/backend/api/v1/featureTypes/ID: fetch feature type with specified ID.
List Feature Types
/backend/api/v1/featureTypes/: list all feature types.
Additional Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit |
integer | No | Maximum items to return |
offset |
integer | No | Number of items to skip |
createdSince |
datetime | No | Only include items created since |
updatedSince |
datetime | No | Only include items updated since |
Example:
curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://example.com/backend/api/v1/featureTypes/"
The Features endpoint accepts a ?featureType=name filter, so you can list features of a given type without first looking up its ID.
POST
/backend/api/v1/featureTypes/: create a new feature type. The newly-created feature type is returned.
PATCH
/backend/api/v1/featureTypes/ID: update feature type with specified ID. The modified feature type is returned.
DELETE
/backend/api/v1/featureTypes/ID: delete feature type with specified ID.
Set the availability to Historic instead of deleting if the type is already referenced by existing features.
Fields
| Field | Name | Type | Description |
|---|---|---|---|
| featureTypeName | Feature Type | Text | Name of the feature type |
| availability | Feature Type Availability | Preset Value | Availability of this feature type |
| customerProducts | Customer Products | Text | Array of customer product names associated with this feature type |
| isSeat | Is Seat | Preset Value | Whether this feature type represents a seat or user licence |
| featureCountCommittedAuto | Feature Auto Committed Count | Preset Value | Automatic committed count setting for features of this type |
| defaultTransactionCode | Default Transaction Code | Text | Default transaction code for features of this type |
| connectionTransactionType | Default One-Off Transaction Type | Preset Value | Name of the default transaction type for one-off charges |
| serviceTransactionType | Default Recurring Transaction Type | Preset Value | Name of the default transaction type for recurring charges |
| defaultTransactionCarrier | Default Transaction Carrier | Preset Value | Name of the default carrier for transactions |
| featureTypeDisplayName | Feature Invoice Name | Text | Name to display on customer invoices for features of this type |
| featureTypePosition | Feature Type Position | Number | Sort order position for features of this type on invoices |
| featureTypeAlwaysShow | Always Show on Invoice | Text | Invoice styles where features of this type should always appear |
| renewalPeriodLength | Renewal Period Length | Text | Length of the renewal period for features of this type |
| renewalPeriodLengthType | Renewal Period Length Type | Preset Value | Unit type for the renewal period length (days, weeks, months, years) |
| minimumTermPeriodLength | Minimum Term Length | Text | Minimum contract term length for features of this type |
| minimumTermPeriodLengthType | Minimum Term Length Type | Preset Value | Unit type for the minimum term length (days, weeks, months, years) |
| committedTermPeriodLength | Committed Term Length | Text | Committed contract term length for features of this type |
| committedTermPeriodLengthType | Committed Term Length Type | Preset Value | Unit type for the committed term length (days, weeks, months, years) |
| noticePeriodLength | Notice Period Length | Number | Required notice period length for cancelling features of this type |
| noticePeriodLengthType | Notice Period Length Type | Preset Value | Unit type for the notice period length (days, weeks, months, years) |
| onCustomer | On Customer | Preset Value | Whether features of this type can be applied at customer level |
| onNumber | On Number | Preset Value | Whether features of this type can be applied at number level |
| onService | On Service | Preset Value | Whether features of this type can be applied at service level |
| id | Feature Type ID | Text | The unique identifier for this feature type |
Related Endpoints
- Features: individual features that inherit defaults from a feature type.
- Transaction Types: referenced by the one-off and recurring defaults.
- Fixed Fee Tariffs: tariff rates can filter by feature type.