# Meter methods: create, get, list

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

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

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

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

```ts
interface MeterVerbs {
  create(input: MeterCreateInput, options?: SB.CallOptions): SB.Call<Meter>
}
```

Emits `Meter.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `unit` | `string` | Yes | What it counts, such as calls or tokens. |
| `of` | `string` | Yes | The declared Event the Meter counts. |
| `aggregation` | `string` | Yes | How counted Events combine over the window: a sum of a value, a count, or the last value. |
| `window` | `string` | Yes | The period usage accrues over before it bills, such as a month. |

**Returns**

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

**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 meter = await $.Meter.create({ unit: 'call', of: 'Reminder.sent', aggregation: 'sum', window: 'month' })
```

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

```ts
interface MeterVerbs {
  get(input: MeterGetInput, options?: SB.CallOptions): SB.Call<Meter>
}
```

Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

**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 meter = await $.Meter.get({ id: 'mtr_z08Ufi8LwY' })
```

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

```ts
interface MeterVerbs {
  list(input?: MeterListInput, options?: SB.CallOptions): SB.ListCall<Meter>
}
```

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 |
| --- | --- | --- | --- |
| `meters` | list of [Meter](/business/nouns/meter) | Yes | One page of Meters. |

**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 meters = await $.Meter.list({ limit: 20 })
```