Skip to main content

License

Generated from apiome-rest/openapi.yaml (API version 1.204.1) — do not edit by hand. How to authenticate is on the REST API reference.

Tag: license · 1 operation

GET /v1/tenants/{tenant_slug}/license​

Get Tenant License

Read the tenant's plan, seat usage, and effective features (OLO-5.4).

Args: tenant_slug: Tenant slug from the path; membership is validated by validate_authentication. auth_data: The authenticated principal (tenant_id resolved from the slug).

Returns: The tenant's license summary. plan is null for a tenant with no license row; seats.max then falls back to the Free default so the numbers always match what the OLO-5.3 guard enforces.

Operation id: get_tenant_license_v1_tenants__tenant_slug__license_get

Parameters

NameInTypeRequiredDescription
tenant_slugpathstringyesURL-safe tenant slug that scopes the request.
authorizationheaderstring or nullnoJWT bearer token for authenticated access (Authorization: Bearer <token>).
X-API-Keyheaderstring or nullnoTenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

StatusDescriptionBody
200Successful response for get tenant license.application/json TenantLicenseResponse
401Missing or invalid credentials.—
403Caller is not a member, or lacks billing:view.—
404Tenant not found.—
422Validation Errorapplication/json HTTPValidationError

Schemas used​

HTTPValidationError​

Validation error response emitted when request data fails schema checks.

PropertyTypeRequiredDescription
detailarray of ValidationErrornoDetail.

TenantLicenseResponse​

Payload of GET /v1/tenants/{tenant_slug}/license.

PropertyTypeRequiredDescription
planLicensePlanSchema or nullnoAttached plan; null when the tenant has no license row (pre-V183 tenant).
seatsLicenseSeatsSchemayesSeats.
quotasLicenseQuotasSchemayesQuotas.
featuresarray of LicenseFeatureSchemanoFeatures.