Deactivate a business

POST /businesses/{bid}/deactivate

Requires the businesses scope.

Your own pause switch on a tenant. A deactivated business keeps its data and its reads, but every write (drafts, issuing, expenses, uploads) is refused until you reactivate it. Distinct from approvalStatus, which only BillOS sets. Idempotent.

Path parameters

Name	Type		Description
`bid`	string	required	Business id, from `POST /businesses`.

Response

200: { "ok": true, … }

Field	Type		Description
`ok`	boolean	required
`business`	Business	required	One Israeli dealer (עוסק), one of your end users.

Errors: 400, 401, 403, 404, 429. Every failure answers { "error": …, "reason": … }. Branch on reason.

On this page

Path parameters Response

POST /businesses/{bid}/deactivate

curl -X POST "$BASE/businesses/$BID/deactivate" \
  -H "X-Api-Key: $KEY"

const res = await fetch(`${BASE}/businesses/${BID}/deactivate`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)

import requests
res = requests.post(
    f"{BASE}/businesses/{BID}/deactivate",
    headers={"X-Api-Key": KEY},
)
data = res.json()

Set BASE to https://api.billos.co.il/v1 and KEY to your bk_live_… key, or a bk_test_… key to run it against the sandbox.

Manage your businesses, keys and webhooks in the BillOS Console.