hosting

POST /v1/sites/{siteId}/storage/packs/{purchaseId}/stop

Remove one extra storage pack at the end of its paid month.

All hosting endpoints

All developer docs →

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}/storage/packs/{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 storage pack on this site. Refused (422) unless the site's measured disk and files fit the ceiling without the pack, or when usage has not been measured recently enough to tell. The pack keeps counting until the day before its next renewal date and is not refunded; after that the site's ceiling is lowered on its server. A pack that is not on this site is 404. Requires sites.view and billing.payment.manage.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).
purchaseId (path)stringYesThe storage pack's add-on purchase id (packs[].purchase_id).

Response

NameTypeRequiredWhat it is
site_idstringYes—
offeredbooleanYesWhether extra storage is on sale to this organisation.
diskSiteStorageUsageYesOne resource of a site (disk in MB, or files), in stored units. limit is base + packs (plus any staff grant); -1 is unlimited and null is not provisioned.
inodesSiteStorageUsageYesOne resource of a site (disk in MB, or files), in stored units. limit is base + packs (plus any staff grant); -1 is unlimited and null is not provisioned.
packsSiteStoragePack[]Yes—
offersSiteStorageOffer[]Yes—
lapseobjectYesSet while a pack that ended is still in use: the site keeps its space until deadline, after which only new growth stops. Files are never deleted.
moveobjectYesThe latest "move and add" request for this site.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429