GET
/
customers
TypeScript
import { Autumn as autumn } from 'autumn-js';

const { data } = await autumn.customers.list({ limit: 10, offset: 0 });
{
  "list": [
    {
      "autumn_id": "<string>",
      "created_at": 123,
      "env": "production",
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "fingerprint": "<string>",
      "stripe_id": "<string>",
      "products": [
        {
          "id": "<string>",
          "name": "<string>",
          "group": "<string>",
          "status": "active",
          "started_at": 123,
          "canceled_at": 123,
          "current_period_start": 123,
          "current_period_end": 123
        }
      ],
      "features": [
        {
          "feature_id": "<string>",
          "unlimited": true,
          "interval": "month",
          "balance": 123,
          "usage": 123,
          "included_usage": 123,
          "next_reset_at": 123
        }
      ]
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Your secret key must be used as the Bearer token for this endpoint.

Query Parameters

limit
integer
default:10

Maximum number of customers to return

Required range: 10 <= x <= 100
offset
integer
default:0

Number of customers to skip before returning results

Required range: x >= 0

Response

200 - application/json

The response is of type object.