Read a recurring plan

GET /businesses/{bid}/recurring/{id}

Requires the documents scope.

Path parameters

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

Response

200: { "ok": true, … }

Field	Type		Description
`ok`	boolean	required
`plan`	RecurringPlan	required	A template the scheduler turns into a draft (or an issued document, with `autoIssue`) every interval. Not a document: freely editable and deletable.

Errors: 400, 401, 403, 404, 429. Every failure answers { "error", "reason", "hint", "param", "doc_url", "retryable", "request_id" }: branch on reason, and read hint for what to change (https://docs.billos.co.il/errors.md).

On this page

Path parameters Response

GET /businesses/{bid}/recurring/{id}

curl -X GET "$BASE/businesses/$BID/recurring/$DOC_ID" \
  -H "X-Api-Key: $KEY"

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

import requests
res = requests.get(
    f"{BASE}/businesses/{BID}/recurring/{DOC_ID}",
    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.