# Meter routes: create, get, list

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

> The Meter Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

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

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

```text
POST /{namespace}/meters
```

Body, as JSON: the inputs. 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**

```bash
curl -X POST https://api.sb/ratebook.dev/meters \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"unit":"call","of":"Reminder.sent","aggregation":"sum","window":"month"}'
```

```json
{
  "api": "https://api.sb/ratebook.dev",
  "meter": {
    "$id": "https://api.sb/ratebook.dev/meters/mtr_z08Ufi8LwY",
    "$type": "Meter",
    "unit": "call",
    "of": "Reminder.sent",
    "aggregation": "sum",
    "window": "month"
  },
  "action": {
    "$id": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq",
    "operation": "Meter.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq"
  }
}
```

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

```text
GET /{namespace}/meters/{id}
```

Path: `id`. Query: the other inputs. 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**

```bash
curl https://api.sb/ratebook.dev/meters/mtr_z08Ufi8LwY \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "Meter",
  "$id": "https://api.sb/ratebook.dev/meters/mtr_z08Ufi8LwY",
  "meter": {
    "$id": "https://api.sb/ratebook.dev/meters/mtr_z08Ufi8LwY",
    "$type": "Meter",
    "unit": "call",
    "of": "Reminder.sent",
    "aggregation": "sum",
    "window": "month"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/meters/mtr_z08Ufi8LwY",
    "up": "https://api.sb/ratebook.dev/meters"
  }
}
```

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

```text
GET /{namespace}/meters
```

Query: the inputs. 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**

```bash
curl "https://api.sb/ratebook.dev/meters?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "Meter",
  "meters": [
    {
      "$id": "https://api.sb/ratebook.dev/meters/mtr_z08Ufi8LwY",
      "$type": "Meter",
      "unit": "call",
      "of": "Reminder.sent",
      "aggregation": "sum",
      "window": "month"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "mtr_z08Ufi8LwY"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/meters?limit=20",
    "next": "https://api.sb/ratebook.dev/meters?after=mtr_z08Ufi8LwY"
  }
}
```