# Service commands: close, open, pause, setCapacity

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

> The Service Verbs close, open, pause, setCapacity as CLI commands, with inputs, result, refusals and an example.

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

### Service.close
Close stops a Service taking new Orders for good, while every placed Order runs to its end. [Verb page](/business/nouns/service/close?interface=cli).

```text
npx startup-builder do Service.close --data '<input>' [--try | --send | --do]
```

Emits [`Service.closed`](/business/events/Service.closed).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `service` | [Service](/business/nouns/service) | Yes | The Service to close. |
| `reason` | `text` | Yes | Why it closes. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `service` | [Service](/business/nouns/service) | Yes | The closed Service. |

**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. |
| `service` is missing, or is not a service | [`invalid-input`](/code/api/errors/invalid-input) | Send `service` as a service, then call it again. | None. |
| `reason` is missing, or is not a text | [`invalid-input`](/code/api/errors/invalid-input) | Send `reason` as a text, then call it again. | None. |
| The `Idempotency-Key` was sent before with another operation or other input | [`idempotency-mismatch`](/code/api/errors/idempotency-mismatch) | Send a new key for new input; reuse a key only to retry the same request. | None. |

**Example**

```bash
npx startup-builder do Service.close --data '{"service":"service_Eq1ssq4AOW","reason":"Example reason"}' \
  --idempotency-key catalogmend-service-close-1
```

### Service.open
Open starts a Service taking new Orders on every published Offer that sells it. [Verb page](/business/nouns/service/open?interface=cli).

```text
npx startup-builder do Service.open --data '<input>' [--try | --send | --do]
```

Emits [`Service.opened`](/business/events/Service.opened).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `service` | [Service](/business/nouns/service) | Yes | The Service to open. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `service` | [Service](/business/nouns/service) | Yes | The Service, now taking new Orders. |

**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. |
| `service` is missing, or is not a service | [`invalid-input`](/code/api/errors/invalid-input) | Send `service` as a service, then call it again. | None. |
| The `Idempotency-Key` was sent before with another operation or other input | [`idempotency-mismatch`](/code/api/errors/idempotency-mismatch) | Send a new key for new input; reuse a key only to retry the same request. | None. |

**Example**

```bash
npx startup-builder do Service.open --data '{"service":"service_Eq1ssq4AOW"}' \
  --idempotency-key catalogmend-service-open-1
```

### Service.pause
Pause stops a Service taking new Orders until a stated time, while every placed Order runs to its end. [Verb page](/business/nouns/service/pause?interface=cli).

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

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `service` | [Service](/business/nouns/service) | Yes | The Service to pause. |
| `reason` | `text` | Yes | Why it pauses, shown to buyers. |
| `until` | `datetime` | No | When it reopens on its own. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `service` | [Service](/business/nouns/service) | Yes | The paused Service. |

**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. |
| `service` is missing, or is not a service | [`invalid-input`](/code/api/errors/invalid-input) | Send `service` as a service, then call it again. | None. |
| `reason` is missing, or is not a text | [`invalid-input`](/code/api/errors/invalid-input) | Send `reason` as a text, then call it again. | None. |
| The `Idempotency-Key` was sent before with another operation or other input | [`idempotency-mismatch`](/code/api/errors/idempotency-mismatch) | Send a new key for new input; reuse a key only to retry the same request. | None. |

**Example**

```bash
npx startup-builder do Service.pause --data '{"service":"service_Eq1ssq4AOW","reason":"Example reason"}' \
  --idempotency-key catalogmend-service-pause-1
```

### Service.setCapacity
SetCapacity sets the most work a Service holds in flight, in the unit its intake counts. [Verb page](/business/nouns/service/set-capacity?interface=cli).

```text
npx startup-builder do Service.setCapacity --data '<input>' [--try | --send | --do]
```

Emits [`Service.capacitySet`](/business/events/Service.capacitySet).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `service` | [Service](/business/nouns/service) | Yes | The Service. |
| `capacity` | `integer` | Yes | The most work in flight, in the intake’s unit, such as listings. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `service` | [Service](/business/nouns/service) | Yes | The Service with its new capacity. |

**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. |
| `service` is missing, or is not a service | [`invalid-input`](/code/api/errors/invalid-input) | Send `service` as a service, then call it again. | None. |
| `capacity` is missing, or is not a integer | [`invalid-input`](/code/api/errors/invalid-input) | Send `capacity` as a integer, then call it again. | None. |
| The `Idempotency-Key` was sent before with another operation or other input | [`idempotency-mismatch`](/code/api/errors/idempotency-mismatch) | Send a new key for new input; reuse a key only to retry the same request. | None. |

**Example**

```bash
npx startup-builder do Service.setCapacity --data '{"service":"service_Eq1ssq4AOW","capacity":1}' \
  --idempotency-key catalogmend-service-set-capacity-1
```