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": "<string>",
      "created_at": 123,
      "name": "<string>",
      "email": "<string>",
      "fingerprint": "<string>",
      "stripe_id": "<string>",
      "env": "sandbox",
      "metadata": {},
      "products": [
        {
          "id": "pro_plan",
          "name": "Pro Plan",
          "group": "product_set_1",
          "status": "active",
          "started_at": 1700000000000,
          "is_default": true,
          "is_add_on": false,
          "canceled_at": 1717000000,
          "version": 1,
          "stripe_subscription_ids": [
            "sub_1Nc0JzBAbcxyz",
            "sub_1Nc0xyBAnopq"
          ],
          "current_period_start": 1717000000,
          "current_period_end": 1719600000,
          "entity_id": "entity_1234abcd",
          "items": [
            {
              "feature_id": "<string>",
              "feature_type": "single_use",
              "included_usage": 123,
              "interval": "month",
              "usage_model": "prepaid",
              "price": 123,
              "billing_units": 1000,
              "entity_feature_id": "<string>",
              "reset_usage_when_enabled": true,
              "tiers": [
                {
                  "to": 100,
                  "amount": 10
                }
              ]
            }
          ],
          "quantity": 1
        }
      ],
      "features": {},
      "rewards": {
        "discounts": [
          {
            "id": "disc_123456",
            "name": "SUMMER20",
            "type": "percentage",
            "discount_value": 20
          }
        ]
      },
      "upcoming_invoice": {
        "lines": [
          {
            "description": "<string>",
            "amount": 123,
            "product_id": "<string>"
          }
        ],
        "discounts": [
          {
            "id": "disc_123456",
            "name": "SUMMER20",
            "type": "percentage",
            "discount_value": 20,
            "duration_type": "forever",
            "duration_value": 3,
            "currency": "usd",
            "start": 1759247877000,
            "end": 1761839877000,
            "subscription_id": "sub_1A2B3C4D5E6F7G8H",
            "total_discount_amount": 599
          }
        ],
        "subtotal": 123,
        "total": 123,
        "currency": "<string>"
      }
    }
  ],
  "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