> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentaos.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Customers

> Everyone who paid you or whom you billed, with their revenue and payments. Built for you from checkouts and invoices.

The Customers page lists the people who paid you and the people you billed. AgentaOS adds a customer when someone pays you for the first time. It also adds one when you bill someone by email, on an invoice or on a checkout your server creates. You do not add or import customers yourself.

A customer's details come from what the buyer typed at checkout, or from what you entered on the invoice: email, name, country, and VAT number. Test mode and live mode keep separate customer lists.

## The Customers page

<Frame caption="The Customers page. Each row shows the customer's revenue and number of payments.">
  <img src="https://mintcdn.com/agentokratia/ob7A8SZLgGb2oPrT/images/product/customers.png?fit=max&auto=format&n=ob7A8SZLgGb2oPrT&q=85&s=032ce3f7ce0ea87323cffe614cc29b4c" alt="The Customers page with three customers: Alex Buyer with 10 euros revenue and 1 payment, and two billed customers with no payments yet, each row with a Create invoice button" width="1440" height="785" data-path="images/product/customers.png" />
</Frame>

In the sidebar, click **Customers**. Each row shows:

* The customer's name or email.
* **Revenue**: what the customer paid you, before VAT.
* **Payments**: how many payments they made.
* **Last active**: their most recent activity.

A customer you billed who has not paid yet shows a dash for revenue and payments. Type in **Search customers** to find a customer by name or email. Click **Create invoice** in a row to bill that customer.

Click a row to open the customer. The customer page shows their details, when you first saw them, and their invoices.

## From code

The API returns the same list. It is read-only: there is no call to create or update a customer. The full reference is in [Customers (SDK)](/sdk/pay-customers) and [agenta customers](/cli/customers).

<Tabs>
  <Tab title="SDK">
    ```typescript theme={"system"}
    const page = await agentaos.customers.list({ limit: 20, offset: 0 });
    console.log(page.total, page.hasMore);
    ```
  </Tab>

  <Tab title="CLI">
    ```bash theme={"system"}
    agenta customers list --limit 20
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={"system"}
    curl "https://api.agentaos.ai/api/v1/gateway/customers?limit=20&offset=0" \
      -H "x-api-key: sk_live_..."
    ```
  </Tab>
</Tabs>

The list is newest first, and each call returns `{ items, total, hasMore }`.

```json theme={"system"}
{
  "items": [
    {
      "id": "a1b2c3d4-...",
      "email": "buyer@example.com",
      "name": "Jane Doe",
      "country": "DE",
      "vatNumber": "DE123456789",
      "stripeCustomerId": "cus_...",
      "createdAt": "2026-03-17T02:00:00.000Z"
    }
  ],
  "total": 1,
  "hasMore": false
}
```

<ResponseField name="id" type="string">Customer UUID.</ResponseField>
<ResponseField name="email" type="string">Customer email.</ResponseField>
<ResponseField name="name" type="string | null">Customer name.</ResponseField>
<ResponseField name="country" type="string | null">ISO 3166-1 alpha-2 country code.</ResponseField>
<ResponseField name="vatNumber" type="string | null">VAT number, if the customer gave one.</ResponseField>
<ResponseField name="stripeCustomerId" type="string | null">The card processor's customer ID. Set when the customer first subscribes or saves a card.</ResponseField>
<ResponseField name="createdAt" type="string">ISO 8601. When AgentaOS first added this customer.</ResponseField>

## Next steps

<Columns cols={2}>
  <Card title="Invoices" icon="file-invoice" href="/payments/invoices">
    Every invoice a customer has.
  </Card>

  <Card title="Subscriptions" icon="rotate" href="/payments/subscriptions">
    Customers with a running subscription.
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.