Skip to main content
POST
/
plan-tiers
/
check-feature
Check feature access
curl --request POST \
  --url https://app.usechar.ai/api/plan-tiers/check-feature \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feature": "sso",
  "current_usage": 0
}
'
{
  "allowed": true,
  "reason": "<string>",
  "current_usage": 0,
  "limit": 0
}

Authorizations

​
Authorization
string
header
required

WorkOS JWT token. Obtain via WorkOS AuthKit authentication flow. The token must include organization_id claim for organization-scoped endpoints.

Body

application/json

Input for checking if a feature is accessible

​
feature
enum<string>
required

Feature name for plan tier gating

Available options:
sso,
scim,
audit_logs,
custom_domains,
end_users,
seats
​
current_usage
integer

Current usage to check against limit

Required range: -9007199254740991 <= x <= 9007199254740991

Response

OK

Result of checking feature access for an organization

​
allowed
boolean
required

Whether access to the feature is allowed

​
reason
string

Reason if access is denied

​
current_usage
integer

Current usage count for limited features

Required range: -9007199254740991 <= x <= 9007199254740991
​
limit
integer

Maximum allowed for limited features

Required range: -9007199254740991 <= x <= 9007199254740991