Skip to main content
GET
/
customers
TypeScript
import { Autumn } from 'autumn-js';

const autumn = new Autumn();

const { data, error } = await autumn.customers.list();
{
  "list": [
    {
      "id": "customer_123",
      "created_at": 1762971906762,
      "name": "John Doe",
      "email": "john@doe.com",
      "fingerprint": null,
      "stripe_id": "cus_J8A5c31A8tlpwN",
      "env": "sandbox",
      "metadata": {},
      "products": [
        {
          "id": "pro_plan",
          "name": "Pro Plan",
          "group": "product_set_1",
          "status": "active",
          "canceled_at": null,
          "started_at": 1762971923843,
          "is_default": false,
          "is_add_on": false,
          "version": 1,
          "current_period_start": 1762971905000,
          "current_period_end": 1765563905000,
          "items": [
            {
              "type": "feature",
              "feature_id": "dashboard",
              "feature_type": "static",
              "included_usage": 0,
              "interval": null,
              "entity_feature_id": null,
              "display": {
                "primary_text": "Dashboard"
              }
            },
            {
              "type": "feature",
              "feature_id": "messages",
              "feature_type": "single_use",
              "included_usage": 30,
              "interval": "month",
              "reset_usage_when_enabled": true,
              "entity_feature_id": null,
              "display": {
                "primary_text": "10 Messages"
              }
            }
          ],
          "quantity": 1
        }
      ],
      "features": {
        "messages": {
          "id": "messages",
          "type": "single_use",
          "name": "Messages",
          "interval": "month",
          "interval_count": 1,
          "unlimited": false,
          "balance": 10,
          "usage": 0,
          "included_usage": 10,
          "next_reset_at": 1765563905000,
          "overage_allowed": false
        },
        "dashboard": {
          "id": "dashboard",
          "type": "static",
          "name": "Dashboard",
          "interval": null,
          "interval_count": null,
          "unlimited": false,
          "balance": 0,
          "usage": 0,
          "included_usage": 0,
          "next_reset_at": null,
          "overage_allowed": false
        }
      }
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:10

Maximum number of customers to return

offset
integer
default:0

Number of customers to skip before returning results

Response

200 - application/json
list
object[]
required
total
integer
required

Total number of customers available

limit
integer
required

Maximum number of customers returned

offset
integer
required

Number of customers skipped before returning results