code-care
GET /v1/code-care
The account's Code Care plan, this month's hours, and the fix rate.
Authentication
Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/code-care \
-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
Code Care (docs/1327): a monthly add-on of included developer time (Basic 1 h, Standard 2.5 h, Pro 6 h) plus a discount on extra time. tier is null when the account has none. plans are priced in the caller's currency (EUR exact, others converted). allowance is the month the account is in now: included, used, reserved by approved jobs and left, in minutes; frozen is true while a fix invoice is unpaid. rate is the pay-as-you-go rate (15-minute blocks, 30-minute minimum per job). The organization is org_id or X-Zinn-Org. Requires billing.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
tier | string<basic, standard, pro> | Yes | — |
plans | CodeCarePlan[] | Yes | — |
allowance | CodeCareAllowance | Yes | — |
min_term_ends_on | string | No | — |
renews_on | string | No | — |
ends_on | string | No | — |
rate | object | Yes | — |
may_request | boolean | Yes | — |
Errors this endpoint can return
401 · 403 · 422