# Subscription programs: create, get, list

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

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

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

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

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

Emits `Subscription.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `renewsAt` | `datetime` | No | When it next renews. |
| `quantity` | `integer` | No | How many units of the Offer’s Price it holds, such as 12 members; 1 by default. |
| `trialEndsAt` | `datetime` | No | When a trial ends and the first paid period starts. |
| `termEndsAt` | `datetime` | No | When a committed term ends; the Renewal and the renewal notice read it. |
| `customer` | [Customer](/business/nouns/customer) | No | A Customer holds Subscriptions, each billed once per Period. |
| `offer` | [Offer](/business/nouns/offer) | No | A Subscription bills one recurring Offer each Period until canceled. |

**Returns**

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

**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 $.Subscription.create({ renewsAt: '2026-10-22T12:00:00Z' })"
  }
}
```

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

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

Reads only: it emits no Event.

**Inputs**

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

**Returns**

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

**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 $.Subscription.get({ id: 'sub_whVFaHKWIV' })"
  }
}
```

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

```text
do: return await $.Subscription.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 |
| --- | --- | --- | --- |
| `subscriptions` | list of [Subscription](/business/nouns/subscription) | Yes | One page of Subscriptions. |

**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 $.Subscription.list({ limit: 20 })"
  }
}
```