Skip to main content

​
Overview

Retrieve detailed information about a specific feature, including its type, configuration, and display settings.

​
Endpoint

POST /v1/features.get

​
Request Body

​
feature_id
string
required
The unique identifier of the feature to retrieve.Example: "api-calls", "seats", "credits"

​
Response

Returns the feature object.
​
id
string
The unique identifier for this feature.
​
name
string
Human-readable name displayed in the dashboard and billing UI.
​
type
enum
Feature type: "boolean", "metered", or "credit_system".
​
consumable
boolean
Whether the feature is consumable. true for features that reset periodically, false for persistent allocations.
​
archived
boolean
Whether the feature is archived and hidden from the dashboard.
​
display
object
Display names for the feature in billing UI and customer-facing components.
​
credit_schema
array
Credit schema mapping (only present for credit_system features).
​
event_names
array
Event names that trigger this feature’s balance.

​
Examples

const response = await fetch('https://api.autumn.com/v1/features.get', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    feature_id: 'api-calls'
  })
});

const feature = await response.json();
console.log(feature);

​
Get Metered Feature

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

​
Get Credit System Feature

Request
{
  "feature_id": "credits"
}
Response
{
  "id": "credits",
  "name": "Credits",
  "type": "credit_system",
  "consumable": true,
  "archived": false,
  "credit_schema": [
    {
      "metered_feature_id": "api-calls",
      "credit_cost": 1
    },
    {
      "metered_feature_id": "image-generations",
      "credit_cost": 10
    }
  ],
  "display": {
    "singular": "credit",
    "plural": "credits"
  }
}

​
Get Boolean Feature

Request
{
  "feature_id": "advanced-analytics"
}
Response
{
  "id": "advanced-analytics",
  "name": "Advanced Analytics",
  "type": "boolean",
  "consumable": false,
  "archived": false
}

​
Use Cases

Feature Validation

Verify a feature exists and retrieve its configuration before using it in /track or /check calls.

Dashboard Display

Fetch feature details to display in your admin dashboard or customer portal.

Configuration Sync

Keep your local feature definitions in sync with your Autumn configuration.

Pricing Display

Retrieve feature names and display settings to show in pricing tables.

​
Error Responses

​
code
string
Error code identifying the type of error.
​
message
string
Human-readable error message.

​
Common Errors

  • feature_not_found - No feature exists with this ID
  • invalid_feature_id - Feature ID format is invalid

Build docs developers (and LLMs) love

Get started for freeTalk to us