Skip to main content
POST
/
v1
/
features.update
Typescript (SDK)
import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.features.update({
  name: "API Requests",
  display: {
    singular: "API request",
    plural: "API requests",
  },
  featureId: "api-calls",
});
{
  "id": "api-calls",
  "name": "API Calls",
  "type": "metered",
  "consumable": true,
  "archived": false,
  "display": {
    "singular": "API call",
    "plural": "API calls"
  }
}

​
Body Parameters

​
Response

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-version
string
default:2.1
required

Body

application/json
​
feature_id
string
required

The ID of the feature to update.

​
name
string

The name of the feature.

Minimum string length: 1
​
type
enum<string>

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.

Available options:
boolean,
metered,
credit_system
​
consumable
boolean

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.

​
display
object

Singular and plural display names for the feature in your user interface.

​
credit_schema
object[]

A schema that maps 'single_use' feature IDs to credit costs. Applicable only for 'credit_system' features.

​
event_names
string[]
​
archived
boolean

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

​
new_feature_id
string

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

Response

200 - application/json

OK

​
id
string
required

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

​
name
string
required

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

​
type
enum<string>
required

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

Available options:
boolean,
metered,
credit_system
​
consumable
boolean
required

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

​
archived
boolean
required

Whether the feature is archived and hidden from the dashboard.

​
event_names
string[]

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

​
credit_schema
object[]

For credit_system features: maps metered features to their credit costs.

​
display
object

Display names for the feature in billing UI and customer-facing components.