You're viewing the docs for Autumn's v2 API. You can find the previous API version here.
Billing
Balances
Customers
Webhook Events
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.entities.list({});{
"list": [
{
"id": "seat_42",
"name": "Seat 42",
"customer_id": "cus_123",
"feature_id": "seats",
"created_at": 1771409161016,
"env": "sandbox",
"subscriptions": [
{
"plan_id": "pro_plan",
"auto_enable": true,
"add_on": false,
"status": "active",
"past_due": false,
"canceled_at": null,
"expires_at": null,
"trial_ends_at": null,
"started_at": 1771431921437,
"current_period_start": 1771431921437,
"current_period_end": 1771999921437,
"quantity": 1
}
],
"purchases": [],
"balances": {
"messages": {
"feature_id": "messages",
"granted": 100,
"remaining": 72,
"usage": 28,
"unlimited": false,
"overage_allowed": false,
"max_purchase": null,
"next_reset_at": 1773851121437,
"breakdown": [
{
"id": "cus_ent_39qmLooixXLAqMywgXywjAz96rV",
"plan_id": "pro_plan",
"included_grant": 100,
"prepaid_grant": 0,
"remaining": 72,
"usage": 28,
"unlimited": false,
"reset": {
"interval": "month",
"resets_at": 1773851121437
},
"price": null,
"expires_at": null
}
]
}
},
"invoices": []
}
],
"has_more": false,
"offset": 0,
"total": 1,
"limit": 10,
"total_count": 100,
"total_filtered_count": 42
}
List Entities
Lists entities across the organization with pagination and optional filters.
Use this to page through entities globally, including filtering by plans inherited from parent customers or attached directly to entities.
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.entities.list({});{
"list": [
{
"id": "seat_42",
"name": "Seat 42",
"customer_id": "cus_123",
"feature_id": "seats",
"created_at": 1771409161016,
"env": "sandbox",
"subscriptions": [
{
"plan_id": "pro_plan",
"auto_enable": true,
"add_on": false,
"status": "active",
"past_due": false,
"canceled_at": null,
"expires_at": null,
"trial_ends_at": null,
"started_at": 1771431921437,
"current_period_start": 1771431921437,
"current_period_end": 1771999921437,
"quantity": 1
}
],
"purchases": [],
"balances": {
"messages": {
"feature_id": "messages",
"granted": 100,
"remaining": 72,
"usage": 28,
"unlimited": false,
"overage_allowed": false,
"max_purchase": null,
"next_reset_at": 1773851121437,
"breakdown": [
{
"id": "cus_ent_39qmLooixXLAqMywgXywjAz96rV",
"plan_id": "pro_plan",
"included_grant": 100,
"prepaid_grant": 0,
"remaining": 72,
"usage": 28,
"unlimited": false,
"reset": {
"interval": "month",
"resets_at": 1773851121437
},
"price": null,
"expires_at": null
}
]
}
},
"invoices": []
}
],
"has_more": false,
"offset": 0,
"total": 1,
"limit": 10,
"total_count": 100,
"total_filtered_count": 42
}
Documentation Index
Fetch the complete documentation index at: https://docs.useautumn.com/llms.txt
Use this file to discover all available pages before exploring further.
Body Parameters
Response
{
"list": [
{
"id": "seat_42",
"name": "Seat 42",
"customer_id": "cus_123",
"feature_id": "seats",
"created_at": 1771409161016,
"env": "sandbox",
"subscriptions": [
{
"plan_id": "pro_plan",
"auto_enable": true,
"add_on": false,
"status": "active",
"past_due": false,
"canceled_at": null,
"expires_at": null,
"trial_ends_at": null,
"started_at": 1771431921437,
"current_period_start": 1771431921437,
"current_period_end": 1771999921437,
"quantity": 1
}
],
"purchases": [],
"balances": {
"messages": {
"feature_id": "messages",
"granted": 100,
"remaining": 72,
"usage": 28,
"unlimited": false,
"overage_allowed": false,
"max_purchase": null,
"next_reset_at": 1773851121437,
"breakdown": [
{
"id": "cus_ent_39qmLooixXLAqMywgXywjAz96rV",
"plan_id": "pro_plan",
"included_grant": 100,
"prepaid_grant": 0,
"remaining": 72,
"usage": 28,
"unlimited": false,
"reset": {
"interval": "month",
"resets_at": 1773851121437
},
"price": null,
"expires_at": null
}
]
}
},
"invoices": []
}
],
"has_more": false,
"offset": 0,
"total": 1,
"limit": 10,
"total_count": 100,
"total_filtered_count": 42
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
Number of items to skip
0 <= x <= 9007199254740991Number of items to return. Default 10, max 1000.
1 <= x <= 1000Filter by plan ID and version. Returns entities with active subscriptions to this plan, including plans inherited from the parent customer.
Show child attributes
Show child attributes
Filter customer products used for entity hydration and plan matching. Defaults to active and scheduled.
active, scheduled Search entities by id or name.
Filter by parent customer processor type (stripe, revenuecat, vercel).
stripe, revenuecat, vercel Response
OK
Array of items for current page
Show child attributes
Show child attributes
Whether more results exist after this page
Current offset position
Limit passed in the request
Total number of items returned in the current page
Total number of entities available in the current organization and environment
Total number of entities matching the current filter before pagination is applied