Skip to main content
GET
/
v1
/
features
Get features
curl --request GET \
  --url https://api.example.com/v1/features \
  --header 'x-api-key: <x-api-key>'
[
  {
    "id": "<string>",
    "featureKey": "<string>",
    "name": "<string>",
    "description": "<string>",
    "tracksUsage": true,
    "isArchived": true,
    "archivedAt": "<string>",
    "archivedReason": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.priceos.com/llms.txt

Use this file to discover all available pages before exploring further.

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.