> ## Documentation Index
> Fetch the complete documentation index at: https://autumn-b9b4c0fb-dev.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# List Features
> Lists all features in the current environment.
Use this to retrieve all features configured for your organization to display in dashboards or for feature management.
### Response
The unique identifier for this feature, used in /check and /track calls.
Human-readable name displayed in the dashboard and billing UI.
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.
For metered features: true if usage resets periodically (API calls, credits), false if allocated persistently (seats, storage).
Event names that trigger this feature's balance. Allows multiple features to respond to a single event.
For classic credit systems: maps metered features to flat or graduated credit costs.
ID of the metered feature that draws from this credit system.
Number of metered-feature units priced together. Defaults to one when omitted.
Named rates chosen by event properties. The most specific match sets the rate; with no match the item's own rate applies.
Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
Breaks ties between dimensions that match the same number of keys. Higher wins.
Inclusive upper usage boundary for this graduated tier. The final tier must be 'inf'.
Credits consumed per billing-unit group within this tier.
Named adjustments chosen by event properties. Every match applies: factors multiply, then adds are summed.
Event properties this entry applies to. Every key must equal the tracked property, compared as strings.
Multiplies the matched rate. All matching multipliers stack.
Added to the rate after every factor is applied, in credits per billing-unit group.
Inclusive upper usage boundary for this graduated tier. The final tier must be 'inf'.
Credits consumed per billing-unit group within this tier.
Credits consumed per billing-unit group.
Whether usage of this classic credit system should be itemized as invoice credits.
Per-model markup overrides for AI credit systems.
Default percentage markup for AI credit systems. Use -100 to make usage free.
Per-provider default markup percentages for AI credit systems.
Display names for the feature in billing UI and customer-facing components.
Singular form for UI display (e.g., 'API call', 'seat').
Plural form for UI display (e.g., 'API calls', 'seats').
Whether the feature is archived and hidden from the dashboard.
Processor mappings for this feature. Present when a Stripe product or meter is set.
Stripe product ID this feature's usage prices bill under.
Stripe meter ID used to create this feature's metered price.
```json 200 theme={null}
{
"list": [
{
"id": "api-calls",
"name": "API Calls",
"type": "metered",
"consumable": true,
"archived": false,
"display": {
"singular": "API call",
"plural": "API calls"
}
},
{
"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"
}
}
]
}
```
## OpenAPI
````yaml openapi POST /v1/features.list
openapi: 3.1.0
info:
title: Autumn API
version: 2.4.0
servers:
- url: https://api.useautumn.com
description: Production server
security:
- secretKey: []
paths:
/v1/features.list:
post:
tags:
- features
description: >-
Lists all features in the current environment.
Use this to retrieve all features configured for your organization to
display in dashboards or for feature management.
operationId: listFeatures
parameters:
- name: x-api-version
in: header
required: true
schema:
type: string
default: 2.4.0
x-speakeasy-globals-hidden: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
list:
type: array
items:
type: object
properties:
id:
type: string
description: >-
The unique identifier for this feature, used in
/check and /track calls.
name:
type: string
description: >-
Human-readable name displayed in the dashboard and
billing UI.
type:
enum:
- boolean
- metered
- credit_system
- ai_credit_system
type: string
description: >-
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.
consumable:
type: boolean
description: >-
For metered features: true if usage resets
periodically (API calls, credits), false if
allocated persistently (seats, storage).
event_names:
type: array
items:
type: string
description: >-
Event names that trigger this feature's balance.
Allows multiple features to respond to a single
event.
credit_schema:
type: array
items:
anyOf:
- type: object
properties:
metered_feature_id:
type: string
minLength: 1
description: >-
ID of the metered feature that draws from
this credit system.
billing_units:
type: number
exclusiveMinimum: 0
description: >-
Number of metered-feature units priced
together. Defaults to one when omitted.
dimensions:
type: object
propertyNames:
type: string
minLength: 1
maxLength: 64
additionalProperties:
anyOf:
- type: object
properties:
match:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
Event properties this entry applies to.
Every key must equal the tracked
property, compared as strings.
priority:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
description: >-
Breaks ties between dimensions that
match the same number of keys. Higher
wins.
tier_behavior:
const: graduated
tiers:
type: array
minItems: 1
items:
type: object
properties:
to:
anyOf:
- type: number
exclusiveMinimum: 0
- enum:
- inf
type: string
description: >-
Inclusive upper usage boundary for this
graduated tier. The final tier must be
'inf'.
credit_cost:
type: number
minimum: 0
description: >-
Credits consumed per billing-unit group
within this tier.
required:
- to
- credit_cost
required:
- match
- tier_behavior
- tiers
additionalProperties: false
- type: object
properties:
match:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
Event properties this entry applies to.
Every key must equal the tracked
property, compared as strings.
priority:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
description: >-
Breaks ties between dimensions that
match the same number of keys. Higher
wins.
credit_cost:
type: number
minimum: 0
description: >-
Credits consumed per billing-unit group
when this dimension matches.
required:
- match
- credit_cost
additionalProperties: false
description: >-
Named rates chosen by event properties.
The most specific match sets the rate;
with no match the item's own rate applies.
multipliers:
type: object
propertyNames:
type: string
minLength: 1
maxLength: 64
additionalProperties:
type: object
properties:
match:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
Event properties this entry applies to.
Every key must equal the tracked
property, compared as strings.
factor:
type: number
exclusiveMinimum: 0
description: >-
Multiplies the matched rate. All
matching multipliers stack.
add:
type: number
description: >-
Added to the rate after every factor is
applied, in credits per billing-unit
group.
required:
- match
additionalProperties: false
description: >-
Named adjustments chosen by event
properties. Every match applies: factors
multiply, then adds are summed.
tier_behavior:
const: graduated
tiers:
type: array
minItems: 1
items:
type: object
properties:
to:
anyOf:
- type: number
exclusiveMinimum: 0
- enum:
- inf
type: string
description: >-
Inclusive upper usage boundary for this
graduated tier. The final tier must be
'inf'.
credit_cost:
type: number
minimum: 0
description: >-
Credits consumed per billing-unit group
within this tier.
required:
- to
- credit_cost
required:
- metered_feature_id
- tier_behavior
- tiers
additionalProperties: false
- type: object
properties:
metered_feature_id:
type: string
minLength: 1
description: >-
ID of the metered feature that draws from
this credit system.
billing_units:
type: number
exclusiveMinimum: 0
description: >-
Number of metered-feature units priced
together. Defaults to one when omitted.
dimensions:
type: object
propertyNames:
type: string
minLength: 1
maxLength: 64
additionalProperties:
anyOf:
- type: object
properties:
match:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
Event properties this entry applies to.
Every key must equal the tracked
property, compared as strings.
priority:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
description: >-
Breaks ties between dimensions that
match the same number of keys. Higher
wins.
tier_behavior:
const: graduated
tiers:
type: array
minItems: 1
items:
type: object
properties:
to:
anyOf:
- type: number
exclusiveMinimum: 0
- enum:
- inf
type: string
description: >-
Inclusive upper usage boundary for this
graduated tier. The final tier must be
'inf'.
credit_cost:
type: number
minimum: 0
description: >-
Credits consumed per billing-unit group
within this tier.
required:
- to
- credit_cost
required:
- match
- tier_behavior
- tiers
additionalProperties: false
- type: object
properties:
match:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
Event properties this entry applies to.
Every key must equal the tracked
property, compared as strings.
priority:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
description: >-
Breaks ties between dimensions that
match the same number of keys. Higher
wins.
credit_cost:
type: number
minimum: 0
description: >-
Credits consumed per billing-unit group
when this dimension matches.
required:
- match
- credit_cost
additionalProperties: false
description: >-
Named rates chosen by event properties.
The most specific match sets the rate;
with no match the item's own rate applies.
multipliers:
type: object
propertyNames:
type: string
minLength: 1
maxLength: 64
additionalProperties:
type: object
properties:
match:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
Event properties this entry applies to.
Every key must equal the tracked
property, compared as strings.
factor:
type: number
exclusiveMinimum: 0
description: >-
Multiplies the matched rate. All
matching multipliers stack.
add:
type: number
description: >-
Added to the rate after every factor is
applied, in credits per billing-unit
group.
required:
- match
additionalProperties: false
description: >-
Named adjustments chosen by event
properties. Every match applies: factors
multiply, then adds are summed.
credit_cost:
type: number
minimum: 0
description: Credits consumed per billing-unit group.
required:
- metered_feature_id
- credit_cost
additionalProperties: false
- type: object
properties:
metered_feature_id:
const: ''
billing_units:
type: number
exclusiveMinimum: 0
description: >-
Number of metered-feature units priced
together. Defaults to one when omitted.
dimensions:
type: object
propertyNames:
type: string
minLength: 1
maxLength: 64
additionalProperties:
anyOf:
- type: object
properties:
match:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
Event properties this entry applies to.
Every key must equal the tracked
property, compared as strings.
priority:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
description: >-
Breaks ties between dimensions that
match the same number of keys. Higher
wins.
tier_behavior:
const: graduated
tiers:
type: array
minItems: 1
items:
type: object
properties:
to:
anyOf:
- type: number
exclusiveMinimum: 0
- enum:
- inf
type: string
description: >-
Inclusive upper usage boundary for this
graduated tier. The final tier must be
'inf'.
credit_cost:
type: number
minimum: 0
description: >-
Credits consumed per billing-unit group
within this tier.
required:
- to
- credit_cost
required:
- match
- tier_behavior
- tiers
additionalProperties: false
- type: object
properties:
match:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
Event properties this entry applies to.
Every key must equal the tracked
property, compared as strings.
priority:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
description: >-
Breaks ties between dimensions that
match the same number of keys. Higher
wins.
credit_cost:
type: number
minimum: 0
description: >-
Credits consumed per billing-unit group
when this dimension matches.
required:
- match
- credit_cost
additionalProperties: false
description: >-
Named rates chosen by event properties.
The most specific match sets the rate;
with no match the item's own rate applies.
multipliers:
type: object
propertyNames:
type: string
minLength: 1
maxLength: 64
additionalProperties:
type: object
properties:
match:
type: object
propertyNames:
type: string
additionalProperties:
type: string
description: >-
Event properties this entry applies to.
Every key must equal the tracked
property, compared as strings.
factor:
type: number
exclusiveMinimum: 0
description: >-
Multiplies the matched rate. All
matching multipliers stack.
add:
type: number
description: >-
Added to the rate after every factor is
applied, in credits per billing-unit
group.
required:
- match
additionalProperties: false
description: >-
Named adjustments chosen by event
properties. Every match applies: factors
multiply, then adds are summed.
credit_cost:
type: number
minimum: 0
description: Credits consumed per billing-unit group.
required:
- metered_feature_id
- credit_cost
additionalProperties: false
description: >-
For classic credit systems: maps metered features to
flat or graduated credit costs.
invoice_credit:
type: boolean
description: >-
Whether usage of this classic credit system should
be itemized as invoice credits.
model_markups:
anyOf:
- type: object
propertyNames:
type: string
pattern: .+\/.+
additionalProperties:
type: object
properties:
markup:
type: number
minimum: -100
input_cost:
type: number
minimum: 0
output_cost:
type: number
minimum: 0
- type: 'null'
description: Per-model markup overrides for AI credit systems.
default_markup:
type: number
minimum: -100
description: >-
Default percentage markup for AI credit systems. Use
-100 to make usage free.
provider_markups:
anyOf:
- type: object
propertyNames:
type: string
additionalProperties:
type: object
properties:
markup:
type: number
minimum: -100
required:
- markup
- type: 'null'
description: >-
Per-provider default markup percentages for AI
credit systems.
display:
type: object
properties:
singular:
anyOf:
- type: string
- type: 'null'
description: >-
Singular form for UI display (e.g., 'API call',
'seat').
plural:
anyOf:
- type: string
- type: 'null'
description: >-
Plural form for UI display (e.g., 'API calls',
'seats').
description: >-
Display names for the feature in billing UI and
customer-facing components.
archived:
type: boolean
description: >-
Whether the feature is archived and hidden from the
dashboard.
processors:
type: object
properties:
stripe:
type: object
properties:
product_id:
type: string
description: >-
Stripe product ID this feature's usage
prices bill under.
meter_id:
type: string
description: >-
Stripe meter ID used to create this
feature's metered price.
description: >-
Processor mappings for this feature. Present when a
Stripe product or meter is set.
required:
- id
- name
- type
- consumable
- archived
required:
- list
examples:
- list:
- id: api-calls
name: API Calls
type: metered
consumable: true
archived: false
display:
singular: API call
plural: API calls
- 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
example:
list:
- id: api-calls
name: API Calls
type: metered
consumable: true
archived: false
display:
singular: API call
plural: API calls
- 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
x-codeSamples:
- lang: typescript
label: Typescript (SDK)
source: |-
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.features.list();
- lang: python
label: Python (SDK)
source: |-
from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.features.list()
components:
securitySchemes:
secretKey:
type: http
scheme: bearer
bearerFormat: JWT
````