# Subscription commands: keep, pause, renew, resize

URL: /code/cli/subscription/verbs · Id: `page:code/cli/subscription/verbs`

> The Subscription Verbs keep, pause, renew, resize as CLI commands, with inputs, result, refusals and an example.

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

### Subscription.keep
Keep takes back a cancel before the period closes, so the Subscription renews on its date at the same terms. [Verb page](/business/nouns/subscription/keep?interface=cli).

```text
npx startup-builder do Subscription.keep --json '<input>' [--try | --send | --do]
```

Emits [`Subscription.kept`](/business/events/Subscription.kept).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `subscription` | [Subscription](/business/nouns/subscription) | Yes | The ending Subscription. |
| `offer` | [Offer](/business/nouns/offer) | No | The Offer to renew on, when the Customer took the save offer. |

**Returns**

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

**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. |
| Once the period has closed; a canceled Subscription starts again as a new one | [`refused`](/code/api/errors/refused) | Clear what the check names, then call it again. | None. |

**Example**

```bash
npx startup-builder do Subscription.keep --json '{"subscription":"sub_whVFaHKWIV"}'
```

### Subscription.pause
Pause stops billing and Entitlements on a Subscription until a date, without ending it. [Verb page](/business/nouns/subscription/pause?interface=cli).

```text
npx startup-builder do Subscription.pause --json '<input>' [--try | --send | --do]
```

Emits [`Subscription.paused`](/business/events/Subscription.paused).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `subscription` | [Subscription](/business/nouns/subscription) | Yes | The active Subscription. |
| `until` | `date` | Yes | When billing resumes on its own. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `subscription` | [Subscription](/business/nouns/subscription) | Yes | The paused 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**

```bash
npx startup-builder do Subscription.pause --json '{"subscription":"sub_whVFaHKWIV","until":"2026-10-22"}'
```

### Subscription.renew
Renew starts a Subscription’s next period and bills it at the Offer Version the Customer accepted. [Verb page](/business/nouns/subscription/renew?interface=cli).

```text
npx startup-builder do Subscription.renew --json '<input>' [--try | --send | --do]
```

Emits [`Subscription.renewed`](/business/events/Subscription.renewed).

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `invoice` | [Invoice](/business/nouns/invoice) | Yes | The Invoice for the new period. |
| `subscription` | [Subscription](/business/nouns/subscription) | Yes | The Subscription in its new period. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The operation is part of an Offer the caller has not accepted or paid for. | [`payment-required`](/code/api/errors/payment-required) | Accept the Offer named in the response, then retry the call. | [Offer.accept](/business/nouns/offer/accept) |
| 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
npx startup-builder do Subscription.renew --json '{"subscription":"sub_zgJUx08kwY"}'
```

### Subscription.resize
Resize changes how many units a Subscription holds and prorates the current period. [Verb page](/business/nouns/subscription/resize?interface=cli).

```text
npx startup-builder do Subscription.resize --json '<input>' [--try | --send | --do]
```

Emits [`Subscription.resized`](/business/events/Subscription.resized).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `subscription` | [Subscription](/business/nouns/subscription) | Yes | The Subscription to change. |
| `quantity` | `integer` | Yes | The new unit count. |

**Returns**

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

**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
npx startup-builder do Subscription.resize --json '{"subscription":"sub_whVFaHKWIV","quantity":1}'
```