Skip to main content
GET
Get features

Headers

x-api-key
string
required

API key from your PriceOS dashboard.

Response

Feature list

id
string
required

Feature ID.

featureKey
string
required

Feature key.

name
string
required

Feature name.

description
string | null
required

Feature description.

type
enum<string>
required

Feature access type.

Available options:
boolean,
limit
tracksUsage
boolean
required

Whether the feature tracks usage.

usageResetInterval
enum<string>
required

Usage reset interval.

Available options:
never,
day,
week,
month,
year
usageResetAnchor
enum<string>
required

Usage reset anchor.

Available options:
billing_period,
calendar
isArchived
boolean
required

Whether the feature is archived.

archivedAt
string | null
required

When the feature was archived.

archivedReason
string | null
required

Why the feature was archived.