List Events

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.events.list({
  customerId: "cus_123",
});

from autumn_sdk import Autumn

autumn = Autumn(secret_key="am_sk_test...")

res = autumn.events.list(
    start_cursor="",
    limit=50,
    customer_id="cus_123",
)

curl --request POST \
  --url https://api.useautumn.com/v1/events.list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "start_cursor": "",
  "customer_id": "cus_123",
  "limit": 50
}
'

{
  "list": [
    {
      "id": "evt_36xpk2TmuQX5zVPPQ8tCtnR5Weg",
      "timestamp": 1765958215459,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 30,
      "properties": {},
      "deductions": [
        {
          "balance_id": "cus_ent_3DdSDtFBlvDbjyUuJeUIbQlyN12",
          "feature_id": "credits",
          "plan_id": "pro",
          "reset": {
            "interval": "month",
            "resets_at": 1765958215459
          },
          "value": 30
        }
      ]
    },
    {
      "id": "evt_36xmHxxjAkqxufDf9yHAPNfRrLM",
      "timestamp": 1765956512057,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 49,
      "properties": {},
      "deductions": null
    }
  ],
  "next_cursor": "eyJ2IjowLCJpZCI6ImV2dF8zNnhtSHh4akFrcXh1ZkRmOXlIQVBOZlJyTE0iLCJ0IjoxNzY1OTU2NTEyMDU3fQ"
}

POST

events.list

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.events.list({
  customerId: "cus_123",
});

from autumn_sdk import Autumn

autumn = Autumn(secret_key="am_sk_test...")

res = autumn.events.list(
    start_cursor="",
    limit=50,
    customer_id="cus_123",
)

curl --request POST \
  --url https://api.useautumn.com/v1/events.list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "start_cursor": "",
  "customer_id": "cus_123",
  "limit": 50
}
'

{
  "list": [
    {
      "id": "evt_36xpk2TmuQX5zVPPQ8tCtnR5Weg",
      "timestamp": 1765958215459,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 30,
      "properties": {},
      "deductions": [
        {
          "balance_id": "cus_ent_3DdSDtFBlvDbjyUuJeUIbQlyN12",
          "feature_id": "credits",
          "plan_id": "pro",
          "reset": {
            "interval": "month",
            "resets_at": 1765958215459
          },
          "value": 30
        }
      ]
    },
    {
      "id": "evt_36xmHxxjAkqxufDf9yHAPNfRrLM",
      "timestamp": 1765956512057,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 49,
      "properties": {},
      "deductions": null
    }
  ],
  "next_cursor": "eyJ2IjowLCJpZCI6ImV2dF8zNnhtSHh4akFrcXh1ZkRmOXlIQVBOZlJyTE0iLCJ0IjoxNzY1OTU2NTEyMDU3fQ"
}

Body Parameters

Response

{
  "list": [
    {
      "id": "evt_36xpk2TmuQX5zVPPQ8tCtnR5Weg",
      "timestamp": 1765958215459,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 30,
      "properties": {},
      "deductions": [
        {
          "balance_id": "cus_ent_3DdSDtFBlvDbjyUuJeUIbQlyN12",
          "feature_id": "credits",
          "plan_id": "pro",
          "reset": {
            "interval": "month",
            "resets_at": 1765958215459
          },
          "value": 30
        }
      ]
    },
    {
      "id": "evt_36xmHxxjAkqxufDf9yHAPNfRrLM",
      "timestamp": 1765956512057,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 49,
      "properties": {},
      "deductions": null
    }
  ],
  "next_cursor": "eyJ2IjowLCJpZCI6ImV2dF8zNnhtSHh4akFrcXh1ZkRmOXlIQVBOZlJyTE0iLCJ0IjoxNzY1OTU2NTEyMDU3fQ"
}

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.3.0

required

Body

application/json

start_cursor

string

default:""

Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.

limit

integer

default:50

Number of items to return. Default 50, hard ceiling 5000.

Required range: 1 <= x <= 5000

customer_id

string

Filter events by customer ID

entity_id

string

Filter events by entity ID (e.g., per-seat or per-resource)

Minimum string length: 1

feature_id

Filter by specific feature ID(s)

Minimum string length: 1

custom_range

object

Filter events by time range

Show child attributes

Response

200 - application/json

list

object[]

required

Items for current page.

Show child attributes

next_cursor

string | null

required

Opaque cursor for the next page. Null when there are no more results.

Revoke Aggregate Events

⌘I

Billing

Balances

Customers

Authorization

Events

Entities

Plans

Features

Rewards & Referrals

Webhook Events

Platform (Beta)

Body Parameters

Response

Authorizations

Headers

Body

Response

​Body Parameters

​Response

Authorizations

Headers

Body

Response

Body Parameters

Response