GET /v1/extras/{code}/tier-change

Authentication

Send an API key as a bearer token. The endpoint checks billing.payment.manage; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

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/extras/{code}/tier-change \
  -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

Q321 (V1 parity, zinnseo/pricing.py). tier_change is null when the organisation holds no other tier of the same SEO tool — buying is an ordinary purchase. Otherwise kind says which change it is. An upgrade: charge_now_minor is charged at purchase (the share of the current period left × (new period price − the held tier's renewal), each share half-up; a difference under 1.00 is waived and reported in waived_minor), the held tier stops, and the new tier renews at renewal_minor on renews_on — the held tier's own day, term and currency; POST /v1/extras/{code}/purchase charges exactly this. A downgrade is never bought now: it is chosen for the renewal with POST /v1/extras/{code}/tier-change (nothing is charged; charge_now_minor is 0), and on renews_on it replaces the held tier and bills renewal_minor in its place. scheduled says whether this tier is already chosen; scheduled_code names whichever tier is.

Parameters

Response

Errors this endpoint can return

401 · 403 · 404 · 422