Customers

agentaos.customers mirrors the dashboard’s Customers list: everyone who has completed a checkout against your org, scoped to the environment (test or live) your API key belongs to. It’s read-only. A customer record is created automatically the first time someone pays, there’s no create, update, or retrieve by ID, only list.

`customers.list(params?)`

const page = await agentaos.customers.list({
  limit: 20,   // default 20, max 100
  offset: 0,
});
console.log(page.items.length, page.total, page.hasMore);

number

default:"20"

Max 100.

number

default:"0"

Returns PaginatedList<Customer>. See Pagination for the { items, total, hasMore } shape and how to walk every page.

Customer fields

string

Customer UUID.

string

string | null

ISO 3166-1 alpha-2, e.g. 'DE'.

string | null

VAT number on file, if any.

string | null

The underlying customer ID from the card processor, set for card and bank (Merchant of Record) payments.

string

ISO 8601.

{
  "id": "9c8b7a6d-5e4f-3a2b-1c0d-e9f8a7b6c5d4",
  "email": "jane@example.com",
  "name": "Jane Doe",
  "country": "DE",
  "vatNumber": "DE123456789",
  "stripeCustomerId": "cus_1H...",
  "createdAt": "2026-08-06T02:00:00.000Z"
}

country, vatNumber, and name come from whatever the buyer entered at checkout, or from what you pre-populated via buyerCountry/buyerVat/buyerName on checkouts.create(). They can be null if the buyer skipped optional fields.

Next steps

Checkouts

Pre-populate buyer info so it lands here correctly.

Subscriptions

customerEmail/customerName on a subscription reference this record.

Invoices

Every invoice carries its own snapshot of buyer details at time of payment.

SDK

CLI

API Reference

`customers.list(params?)`

Customer fields

Next steps

Checkouts

Subscriptions

Invoices

​customers.list(params?)

​Customer fields

​Next steps

Checkouts

Subscriptions

Invoices

`customers.list(params?)`

Customer fields

Next steps