code-care

POST `/v1/code-care`

Buy Code Care, or move to another tier.

Authentication

Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a field in the JSON body.

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 POST https://api.zinndigital.com/v1/code-care \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "tier": <string<basic, standard, pro>> }'

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

Buys the tier through the ordinary add-on purchase (charge, tax as a human professional service, invoice). A higher tier takes effect at once and charges the pro-rata difference; a lower tier is scheduled for the renewal and charges nothing now (scheduled: true). There is a 3-month minimum term. PAYMENT_METHOD_REQUIRED carries error.payment, the order to settle on-session, exactly as the add-on checkout does. Requires billing.payment.manage.

Request body

Name	Type	Required	What it is
`tier`	`string<basic, standard, pro>`	Yes	—
`org_id`	`string`	No	—
`currency`	`string`	No	—
`gateway`	`string`	No	—

Response

Name	Type	Required	What it is
`tier`	`string`	Yes	—
`scheduled`	`boolean`	Yes	True when a downgrade was set for the renewal.
`switch`	`object`	No	—
`purchase_id`	`string`	No	—
`status`	`string`	No	—
`amount_minor`	`integer`	No	—
`currency`	`string`	No	—

Errors this endpoint can return

401 · 403 · 422