extras

POST `/v1/extras/{code}/tier-change`

Choose this smaller SEO tool tier for the next renewal.

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/extras/{code}/tier-change \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Q321 (V1 parity: "lowering is chosen for the renewal and costs nothing now"). Records that the tier of the same tool the organisation holds renews as this SMALLER tier. Nothing is charged and nothing changes today: the held tier keeps working until renews_on, when a purchase of this tier replaces it and its period price is billed in place of the old renewal — same day, term and currency, with the SEO bundle and yearly savings applied as for any renewal. Idempotent; choosing another smaller tier replaces the choice. 422 refusal.extras.tierSwitchIsUpgrade when this tier is bigger (buy it instead), refusal.extras.tierSwitchNothingHeld when no other tier of the tool is held. Requires billing.payment.manage.

Parameters

Name	Type	Required	What it is
`code (path)`	`string`	Yes	The extra's code (e.g. `db_maintenance`).

Request body

Name	Type	Required	What it is
`org_id`	`string`	No	The organisation, when the caller can act for several.

Response

Name	Type	Required	What it is
`tier_change`	`null \| ExtraTierChange`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 422