admin

Retire a tier or bring it back (admin)

Retiring a tier stops it being offered for checkout or for a manual tier change. The organisations already on it keep their tier, quotas and gated tools. The reserved codes 'free' and 'internal' cannot be retired. Requires the Keycloak 'admins' group.

patch/admin/tiers/{code}/status

Request

  • Base URL: https://api.qualityclouds.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.qualityclouds.ai/admin/tiers/{code}/status
  • Auth: one of:
    • HTTP bearer
    • OpenID Connect (https://account.qualityclouds.com//realms/ai-production/.well-known/openid-configuration)

Path parameters

codestring required

Request body

is_activeboolean required

False retires the tier: it is offered for nothing new, and the organisations already on it keep it untouched.

Response

Successful Response

codestring required
namestring required
descriptionstring required
rankinteger required
is_billableboolean required
is_activeboolean required
price_amountinteger nullable required
currencystring nullable required
max_usersinteger nullable required
stripe_price_idstring nullable required
stripe_product_idstring nullable required
organisations_countinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.