Skip to main content
GET
/
catalog
/
features
/
{pk}
Retrieve a feature
curl --request GET \
  --url https://api.kelviq.com/api/v1/catalog/features/{pk}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01",
  "identifier": "api-calls",
  "name": "API Calls",
  "description": "Number of API calls per billing cycle.",
  "featureType": "METER",
  "featureDetails": {
    "featureSubType": "PRE_AGGREGATED_USAGE",
    "units": {
      "singular": "call",
      "plural": "calls"
    }
  },
  "meter": {},
  "details": {},
  "metadata": {
    "category": "core"
  },
  "isArchived": false,
  "modifiedOn": "2025-04-12T08:21:14.910Z"
}

Authorizations

​
Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

​
pk
string<uuid>
required

Feature UUID.

Response

Feature details.

A feature that can be granted as an entitlement on a plan.

​
id
string<uuid>
read-only
Example:

"3a3e92ab-90a3-4f43-8e87-9d4c8c5a9c01"

​
identifier
string

URL-safe slug, auto-generated from name if not provided.

Example:

"api-calls"

​
name
string
Example:

"API Calls"

​
description
string
Example:

"Number of API calls per billing cycle."

​
featureType
enum<string>

BOOLEAN: on/off flag. CUSTOMIZABLE: numeric limit. METER: usage-based metering.

Available options:
BOOLEAN,
CUSTOMIZABLE,
METER
Example:

"METER"

​
featureDetails
object

Configuration for the feature. For METER features, expects featureSubType (PRE_AGGREGATED_USAGE or RAW_EVENTS), units, and optionally customerUnit for unit conversion.

Example:
{
  "featureSubType": "PRE_AGGREGATED_USAGE",
  "units": { "singular": "call", "plural": "calls" }
}
​
meter
object

For RAW_EVENTS meter features: an object with aggregation (function, field) and filters.

Example:
{}
​
details
object
read-only
Example:
{}
​
metadata
object
Example:
{ "category": "core" }
​
isArchived
boolean
read-only
Example:

false

​
modifiedOn
string<date-time>
read-only
Example:

"2025-04-12T08:21:14.910Z"