Sign in

v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
features

Updates an existing feature.

Use this to modify feature properties like name, display settings, or to archive a feature.

post/v1/features.update

Headers

x-api-versionstring required

Request body

namestring

The name of the feature.

type'boolean' | 'metered' | 'credit_system' | 'ai_credit_system'

The type of the feature. 'single_use' features are consumed, like API calls, tokens, or messages. 'continuous_use' features are allocated, like seats, workspaces, or projects. 'credit_system' features are schemas that unify multiple 'single_use' features into a single credit system.

consumableboolean

Whether this feature is consumable. A consumable feature is one that periodically resets and is consumed rather than allocated (like credits, API requests, etc.). Applicable only for 'metered' features.

model_markupsobject nullable

Per-model markup overrides for AI credit systems. Maps model IDs to their markup configuration.

default_markupnumber

Default percentage markup for this AI credit system. Used when no model or provider markup applies. Use -100 to make usage free.

provider_markupsobject nullable

Per-provider default markup percentages for AI credit systems. Provider keys match the first segment of model_id.

event_namesstring[]
archivedboolean

Whether the feature is archived. Archived features are hidden from the dashboard.

feature_idstring required

The ID of the feature to update.

new_feature_idstring

The new ID of the feature. Feature ID can only be updated if it's not being used by any customers.

Example request

{
  "feature_id": "api-calls",
  "name": "API Requests",
  "display": {
    "singular": "API request",
    "plural": "API requests"
  }
}

Response

OK

idstring required

The unique identifier for this feature, used in /check and /track calls.

namestring required

Human-readable name displayed in the dashboard and billing UI.

type'boolean' | 'metered' | 'credit_system' | 'ai_credit_system' required

Feature type: 'boolean' for on/off access, 'metered' for usage-tracked features, 'credit_system' for unified credit pools, 'ai_credit_system' for model-based token pricing.

consumableboolean required

For metered features: true if usage resets periodically (API calls, credits), false if allocated persistently (seats, storage).

event_namesstring[]

Event names that trigger this feature's balance. Allows multiple features to respond to a single event.

model_markupsobject nullable

Per-model markup overrides for AI credit systems.

default_markupnumber

Default percentage markup for AI credit systems. Use -100 to make usage free.

provider_markupsobject nullable

Per-provider default markup percentages for AI credit systems.

archivedboolean required

Whether the feature is archived and hidden from the dashboard.

Example response

{
  "id": "api-calls",
  "name": "API Calls",
  "type": "metered",
  "consumable": true,
  "archived": false,
  "display": {
    "singular": "API call",
    "plural": "API calls"
  }
}