Sign in

v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
customers

Lists customers with cursor pagination and optional filters. Pass start_cursor: "" (or omit) for the first page; use next_cursor from a prior response for subsequent pages.

post/v1/customers.list

Headers

x-api-versionstring required

Request body

start_cursorstring

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

limitinteger

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

subscription_status'active' | 'scheduled'

Filter by customer product status. Defaults to active and scheduled.

searchstring

Search customers by id, name, or email.

processorsstring[]

Filter by customer processor type (stripe, revenuecat, vercel).

Example request

{
  "start_cursor": "",
  "limit": 10
}

Response

OK

next_cursorstring nullable required

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

Example response

{
  "list": [
    {
      "id": "2ee25a41-0d81-4ad2-8451-ec1aadaefe58",
      "name": "Patrick",
      "email": "patrick@useautumn.com",
      "createdAt": 1771409161016,
      "fingerprint": null,
      "stripeId": "cus_U0BKxpq1mFhuJO",
      "processors": {
        "stripe": {
          "id": "cus_U0BKxpq1mFhuJO"
        }
      },
      "env": "sandbox",
      "metadata": {},
      "sendEmailReceipts": false,
      "billingControls": {
        "autoTopups": []
      },
      "subscriptions": [
        {
          "planId": "pro_plan",
          "autoEnable": true,
          "addOn": false,
          "status": "active",
          "pastDue": false,
          "canceledAt": null,
          "expiresAt": null,
          "trialEndsAt": null,
          "startedAt": 1771431921437,
          "currentPeriodStart": 1771431921437,
          "currentPeriodEnd": 1771999921437,
          "quantity": 1
        }
      ],
      "purchases": [],
      "licenses": [],
      "balances": {
        "messages": {
          "featureId": "messages",
          "granted": 100,
          "remaining": 0,
          "usage": 100,
          "unlimited": false,
          "overageAllowed": false,
          "maxPurchase": null,
          "nextResetAt": 1773851121437,
          "breakdown": [
            {
              "id": "cus_ent_39qmLooixXLAqMywgXywjAz96rV",
              "planId": "pro_plan",
              "includedGrant": 100,
              "prepaidGrant": 0,
              "remaining": 0,
              "usage": 100,
              "unlimited": false,
              "reset": {
                "interval": "month",
                "resetsAt": 1773851121437
              },
              "price": null,
              "expiresAt": null
            }
          ]
        }
      },
      "flags": {
        "advanced_workflows": {
          "id": "cus_ent_abc123",
          "plan_id": "pro_plan",
          "expires_at": null,
          "feature_id": "advanced_workflows"
        }
      },
      "config": {
        "disable_pooled_balance": false,
        "disable_overage_billing": false
      }
    }
  ],
  "next_cursor": null
}