hosting
POST /v1/sites/{siteId}/cleaner/stop
Stop the account's Site Cleaner 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}/cleaner/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 renewal of the site_cleaner / site_cleaner_yearly add-on on the site's account (one subscription covers every website, so this stops it for all of them). The Site Cleaner keeps working until the day before the next renewal date (ends_on) and is not refunded, like every other add-on a customer stops themselves; backups already taken are kept their usual 7 days. An account without the add-on is 422. Requires sites.view and billing.payment.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
offered | boolean | Yes | Whether the add-on is on sale to this organisation. |
active | boolean | Yes | Whether the account holds it and may clean now. |
supported | boolean | Yes | — |
unsupported_reason | string | No | — |
can_buy | boolean | Yes | — |
refusal | string | No | — |
prices | object[] | Yes | — |
purchase_id | string | No | — |
renews_on | string | No | — |
ends_on | string | No | — |
schedule | string<off, daily, weekly, monthly> | Yes | — |
next_run_at | string | No | — |
skip | string[] | Yes | — |
last_scan | SiteCleanerJob | No | — |
in_flight | SiteCleanerJob | No | — |
jobs | SiteCleanerJob[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429