Skip to content

by startups.studio

by Startups.Studio

Product What you sell Product Service

Service.pause

POST /{namespace}/services/{service}/pause

Pause stops a Service taking new Orders until a stated time, while every placed Order runs to its end.

Noun: Service
Mode: do
Event: Service.paused

You, to your agent

Pause the service “Catalog audit”.

curl -X POST https://api.sb/catalogmend.com/services/service_Eq1ssq4AOW/pause \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'

npx startup-builder do Service.pause --data '{"service":"service_Eq1ssq4AOW","reason":"Example reason"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Service.pause({ service: 'service_Eq1ssq4AOW', reason: 'Example reason' })"
  }
}

import { $ } from 'startup-builder'

const service = await $.Service.pause({ service: 'service_Eq1ssq4AOW', reason: 'Example reason' })

Inputs

Input	Type	Required	Description
`service`	Service	required	The Service to pause.
`reason`	`text`	required	Why it pauses, shown to buyers.
`until`	`datetime`		When it reopens on its own.

Outputs

Output	Type	Required	Description
`service`	Service	required	The paused Service.

Effects

Fact	Value
Action class	None: no approval rule names it, so it runs within its seat's Permissions and Limits
Stakes	The Startup's own records only
Door	Two-way: it runs at once
Modes	`try` previews it and stores nothing; `send` returns a pending Action; `do` (default) waits for the result
Idempotent	Only with a key: a repeat with the same `Idempotency-Key` and input returns the first Action, the same key with other input is refused with `409`, and a repeat without a key runs again
Undo	Action.undo reverses it
Emits	`Service.paused`
Performed by	The Delivery Manager

Placed Orders keep running; a new Order is refused with the reason and the reopening time.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation	`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`	Send `service` as a service, then call it again.	None.
`reason` is missing, or is not a text	`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`	Send a new key for new input; reuse a key only to retry the same request.	None.

When it waits

Gate	Default
Decision class	Low: two-way, no delay window
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval, which a Human answers: the owner of record, or a Human they named to approve for the Founder seat. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

To retry, send the same Idempotency-Key: the retry returns the first Action and runs nothing twice. A new key runs the call again.

Service.open

Previous

Service.setCapacity

Next