---
title: "Retire a tier or bring it back (admin)"
method: PATCH
path: "/admin/tiers/{code}/status"
tags: ["admin"]
---

# Retire a tier or bring it back (admin)

`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`)

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.

## Path parameters

- `code` string, required

## Request body

- AdminTierStatusRequest: PATCH /admin/tiers/{code}/status — retire a tier or bring it back.
  - `is_active` boolean, required: False retires the tier: it is offered for nothing new, and the organisations already on it keep it untouched.

## Response `200`

Successful Response

- AdminTierResponse: One tier as an administrator sees it. Unlike the public ``TierResponse`` on GET /api/v1/tiers, this carries the Stripe identifiers and the organisation count. It is served only behind the system-admin guard.
  - `code` string, required
  - `name` string, required
  - `description` string, required
  - `rank` integer, required
  - `is_billable` boolean, required
  - `is_active` boolean, required
  - `price_amount` integer, nullable, required
  - `currency` string, nullable, required
  - `max_users` integer, nullable, required
  - `stripe_price_id` string, nullable, required
  - `stripe_product_id` string, nullable, required
  - `organisations_count` integer, required
  - `quotas` AdminTierQuotaResponse[], required
    - `quota_key` string, required
    - `max_allowed` integer, required
    - `reset_period` string, nullable, required
  - `tools` AdminTierToolResponse[], required
    - `tool_id` string, required
    - `included` boolean, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Validation Error

---

[API](https://skmtc.dev/qualityclouds/apis/qai-orchestrator-api.md) · [All operations](https://skmtc.dev/qualityclouds/apis/qai-orchestrator-api/llms.txt) · [OpenAPI document](https://skmtc.dev/qualityclouds/apis/qai-orchestrator-api/revisions/250c849925af?raw)