v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB

Tarif

Update a tarif plan

Update an existing tarif plan.

patch/tarifs/{tarif_id}

Path parameters

tarif_idinteger required

ID of the tarif to update.

Query parameters

cookie_namestring nullable

tenant_idinteger

Request body

namestring required

Name for the tarif to be created. Max 100 characters.

pricenumber required

The price of the tarif. This field is required.

hard_limitnumber required

The hard limit to restrict the user.

licensesinteger nullable

Seats sold; sizes the tenant monthly pool.

monthly_limit_per_licensenumber nullable

Per-seat monthly allowance.

soft_limit_fractionnumber nullable

Warn user when monthly spend reaches this fraction of monthly_limit_per_license.

status'ACTIVE' | 'RETIRED'

Enum for Tarif status in Tarif

expires_atstring date nullable

When the tarif expires; None = never.

descriptionstring nullable

Description of the tarif.

is_unlimitedboolean nullable

Whether the tarif has unlimited usage.

Example request

{
  "name": "Pro plan",
  "price": 99,
  "hard_limit": 500,
  "licenses": 25,
  "monthly_limit_per_license": 20,
  "soft_limit_fraction": 0.8,
  "expires_at": "2026-12-31",
  "description": "Standard professional plan with monthly pool."
}

Response

Successful Response

idinteger

Primary key for the tarif record.

namestring required

Name for the tarif to be created. Max 100 characters.

pricenumber required

The price of the tarif. This field is required.

hard_limitnumber nullable

Max allowed usage; None = unlimited if is_unlimited.

licensesinteger nullable

Seats sold; sizes the tenant monthly pool.

monthly_limit_per_licensenumber nullable

Per-seat monthly allowance.

soft_limit_fractionnumber nullable

Warn user when monthly spend reaches this fraction of monthly_limit_per_license.

is_unlimitedboolean

Bypass usage checks if True.

descriptionstring nullable

Description of the tarif.

status'ACTIVE' | 'RETIRED'

Enum for Tarif status in Tarif

is_defaultboolean

Whether this tarif is the default plan for new tenants.

creator_user_idinteger nullable required

ID of the user who created the tarif.

created_atstring date-time

Timestamp when the tarif was created.

updated_atstring date-time

Timestamp when the tarif was last updated.