Update Feature

POST /features/{feature_id}

TypeScript

TypeScript

import { Autumn } from 'autumn-js';

const autumn = new Autumn();

const { data, error } = await autumn.features.update('feature_id');

200

{
  "id": "<string>",
  "type": "boolean",
  "name": "<string>",
  "display": {
    "singular": "<string>",
    "plural": "<string>"
  },
  "credit_schema": [
    {
      "metered_feature_id": "<string>",
      "credit_cost": 123
    }
  ],
  "archived": true
}

Authorizations

Authorization · string · header · required

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

Path Parameters

feature_id · string · required

Body

application/json

id · string

The ID of the feature. This is used to refer to it in other API calls like /track or /check.

Pattern: ^[a-zA-Z0-9_-]+$

name · string

The name of the feature.

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: static, boolean, single_use, continuous_use, credit_system

display · object

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

Show child attributes

credit_schema · object[]

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

Show child attributes

archived · boolean

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

Response

200 - application/json

id · string · required

The ID of the feature, used to refer to it in other API calls like /track or /check.

type · enum<string> · required

Available options: boolean, single_use, continuous_use, credit_system

name · string | null

The name of the feature.

display · object

Singular and plural display names for the feature.

Show child attributes

credit_schema · object[] | null

Credit cost schema for credit system features.

Show child attributes

archived · boolean | null

Whether or not the feature is archived.