hosting

POST `/v1/sites/{siteId}/database-slots/{purchaseId}/stop`

Stop a bought extra-database slot renewing.

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/database-slots/{purchaseId}/stop \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Stops the monthly renewal of one extra_database add-on bought for this site. The slot keeps working until the day before its next renewal date and is not refunded. No database is touched: a site left with more databases than its ceiling keeps them all and is refused a NEW one. A slot this site is not paying for is 422. Requires sites.view and billing.payment.manage.

Parameters

Name	Type	Required	What it is
`siteId (path)`	`Uuid`	Yes	Site ID (UUIDv7).
`purchaseId (path)`	`string`	Yes	The slot's `purchase_id` from `listSiteDatabases`.

Response

Name	Type	Required	What it is
`purchase_id`	`string`	Yes	—
`ends_on`	`string`	Yes	The last day the slot works, or null when nothing was billing (a staff grant, or a slot already stopped).

Errors this endpoint can return

401 · 403 · 404 · 422 · 429

POST /v1/sites/{siteId}/database-slots/{purchaseId}/stop