admin

Create a tier (admin)

Adds a tier to the catalogue. The tier is created retired: configure its quotas, then activate it. Requires the Keycloak 'admins' group.

post/admin/tiers

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
  • Auth: one of:
    • HTTP bearer
    • OpenID Connect (https://account.qualityclouds.com//realms/ai-production/.well-known/openid-configuration)

Request body

codestring required

Immutable catalogue key, lower snake case, up to 20 characters (for example 'solo_developer').

namestring required

Display name shown to customers.

descriptionstring

Customer-facing description.

rankinteger required

Commercial order, unique across tiers. Leave gaps so a tier can be inserted later (the seeded ranks are 0, 10, 20, 30, 100).

price_amountinteger nullable

Price in the currency's minor unit (pence, cents).

currencystring nullable

ISO currency code, for example 'GBP'.

max_usersinteger nullable

Seat cap. Null means unlimited.

is_billableboolean

Whether the tier can be bought through self-service checkout. Requires both Stripe identifiers.

stripe_price_idstring nullable

Stripe price id, created in the Stripe dashboard beforehand.

stripe_product_idstring nullable

Stripe product id, created in the Stripe dashboard beforehand.

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.