# Customer programs: create, get, list

URL: /code/mcp/customer/records · Id: `page:code/mcp/customer/records`

> The Customer Verbs create, get, list as MCP do programs, with inputs, result, refusals and an example.

Reference for [Customer](/business/nouns/customer), one group of [Customer programs](/code/mcp/customer).

### Customer.create
Creates a Customer. [Verb page](/business/nouns/customer/create?interface=mcp).

```text
do: return await $.Customer.create(input)
```

Emits `Customer.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `since` | `datetime` | Yes | When the party first accepted an Offer. |
| `outside` | `boolean` | No | Computed: true when it shares no owner, account, or sibling chain with the Startup. |
| `billingEmail` | `email` | No | Where Invoices and receipts go, when it differs from the sign-in email. |
| `billingAddress` | `text` | No | The address printed on new Invoices; Stripe Tax reads it to compute tax. |
| `taxIds` | `string[]` | No | The Customer’s tax ids, such as a VAT number, printed on new Invoices and read by Stripe Tax. |
| `creditRecharge` | `json` | No | When unspent credit falls below `below`, buy `amount` of the credit Offer with the default Payment Source. |
| `portal` | [Portal](/business/nouns/portal) | No | Customers sign in to a Portal to order, track delivery, accept work, and pay. |
| `acquisition` | [Acquisition](/business/nouns/acquisition) | No | A Customer inherits the Acquisition of the Lead it was; Metrics and payouts read this one row. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `customer` | [Customer](/business/nouns/customer) | Yes | The Customer. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Customer.create({ since: '2026-10-22T12:00:00Z' })"
  }
}
```

### Customer.get
Returns one Customer by id. [Verb page](/business/nouns/customer/get?interface=mcp).

```text
do: return await $.Customer.get(input)
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Customer. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `customer` | [Customer](/business/nouns/customer) | Yes | The Customer. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Customer.get({ id: 'cus_K1BROJhqzZ' })"
  }
}
```

### Customer.list
Returns Customers, newest first, one page at a time. [Verb page](/business/nouns/customer/list?interface=mcp).

```text
do: return await $.Customer.list(input)
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `customers` | list of [Customer](/business/nouns/customer) | Yes | One page of Customers. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Customer.list({ limit: 20 })"
  }
}
```