# Limit methods: create, get, list

URL: /code/sdk/limit/records · Id: `page:code/sdk/limit/records`

> The Limit Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.

Reference for [Limit](/business/nouns/limit), one group of [Limit methods](/code/sdk/limit).

### Limit.create
Creates a Limit. [Verb page](/business/nouns/limit/create?interface=sdk).

```ts
interface LimitVerbs {
  create(input?: LimitCreateInput, options?: SB.CallOptions): SB.Call<Limit>
}
```

Emits `Limit.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `amount` | `money` | No | The most money it allows. |
| `count` | `integer` | No | The most calls or units it allows. |
| `period` | `string` | No | The window a rate resets over, such as a month. |
| `percent` | `number` | No | The largest share off a reference amount it allows, such as 15 percent off list Price. |
| `resets` | `string` | No | One of `calendar`, `rolling`: a calendar Limit resets at the start of each period, a rolling one counts the last period from now. |

**Returns**

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

**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**

```ts
import { $ } from 'startup-builder'

const limit = await $.Limit.create({ amount: { amount: 29, currency: 'USD' } })
```

### Limit.get
Returns one Limit by id. [Verb page](/business/nouns/limit/get?interface=sdk).

```ts
interface LimitVerbs {
  get(input: LimitGetInput, options?: SB.CallOptions): SB.Call<Limit>
}
```

Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

**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**

```ts
import { $ } from 'startup-builder'

const limit = await $.Limit.get({ id: 'limit_UWHXYVKsJB' })
```

### Limit.list
Returns Limits, newest first, one page at a time. [Verb page](/business/nouns/limit/list?interface=sdk).

```ts
interface LimitVerbs {
  list(input?: LimitListInput, options?: SB.CallOptions): SB.ListCall<Limit>
}
```

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 |
| --- | --- | --- | --- |
| `limits` | list of [Limit](/business/nouns/limit) | Yes | One page of Limits. |

**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**

```ts
import { $ } from 'startup-builder'

const limits = await $.Limit.list({ limit: 20 })
```