Check Feature Access

POST

api

public

can-access

curl -X POST "https://app.crovver.com/api/public/can-access" \
  -H "x-public-key: pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "requestingEntityId": "workspace_123",
    "featureKey": "advanced_analytics"
  }'

curl -X POST "https://app.crovver.com/api/public/can-access" \
  -H "x-public-key: pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "requestingEntityId": "workspace_123",
    "featureKey": "advanced_analytics",
    "productSlug": "product-a"
  }'

curl -X POST "https://app.crovver.com/api/public/can-access" \
  -H "x-public-key: pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "requestingEntityId": "workspace_123",
    "productSlug": "product-a"
  }'

{
  "success": true,
  "data": {
    "canAccess": true,
    "featureKey": "advanced_analytics",
    "requestingEntityId": "workspace_123"
  }
}

{
  "success": true,
  "data": {
    "canAccess": true,
    "featureKey": "advanced_analytics",
    "productSlug": "product-a",
    "requestingEntityId": "workspace_123"
  }
}

{
  "success": true,
  "data": {
    "canAccess": true,
    "productSlug": "product-a",
    "requestingEntityId": "workspace_123"
  }
}

{
  "success": true,
  "data": {
    "canAccess": false,
    "featureKey": "advanced_analytics",
    "requestingEntityId": "workspace_123"
  }
}

Returns whether the tenant’s active plan includes the requested feature. For multi-product orgs, pass productSlug to scope the check to a specific product’s subscription. If the feature is backed by a credit pool, also returns the available credit balance.

Request Body

string

required

The external tenant ID from your application

string

The feature key to check (must match a key in plan.features). Optional when productSlug is provided — omitting it performs a subscription-existence check (returns true if the tenant has any active/trial subscription for that product).

string

Scope the check to a specific product (e.g. product-a). Required for multi-product orgs. At least one of featureKey or productSlug must be provided.

integer

For credit-backed features: number of credits needed. Defaults to 0 (balance check only).

Authentication

Requires a public key (x-public-key: pk_live_...) or secret key (Authorization: Bearer sk_live_...).

Response

boolean

Whether the tenant can access the feature or has an active subscription for the product

string

Echoed feature key (absent when only productSlug was provided)

string

Echoed product slug (when provided)

string

The tenant ID that was checked

object

Only present when the feature maps to a credit pool.

Show child attributes

integer

Credits remaining in the pool

boolean

Whether available credits meet the requested amount

curl -X POST "https://app.crovver.com/api/public/can-access" \
  -H "x-public-key: pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "requestingEntityId": "workspace_123",
    "featureKey": "advanced_analytics"
  }'

curl -X POST "https://app.crovver.com/api/public/can-access" \
  -H "x-public-key: pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "requestingEntityId": "workspace_123",
    "featureKey": "advanced_analytics",
    "productSlug": "product-a"
  }'

curl -X POST "https://app.crovver.com/api/public/can-access" \
  -H "x-public-key: pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "requestingEntityId": "workspace_123",
    "productSlug": "product-a"
  }'

{
  "success": true,
  "data": {
    "canAccess": true,
    "featureKey": "advanced_analytics",
    "requestingEntityId": "workspace_123"
  }
}

{
  "success": true,
  "data": {
    "canAccess": true,
    "featureKey": "advanced_analytics",
    "productSlug": "product-a",
    "requestingEntityId": "workspace_123"
  }
}

{
  "success": true,
  "data": {
    "canAccess": true,
    "productSlug": "product-a",
    "requestingEntityId": "workspace_123"
  }
}

{
  "success": true,
  "data": {
    "canAccess": false,
    "featureKey": "advanced_analytics",
    "requestingEntityId": "workspace_123"
  }
}

Check Usage Limit (Deprecated)Deprecated. Use credits/balance + credits/consume instead.

curl -X POST "https://app.crovver.com/api/public/can-access" \
  -H "x-public-key: pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "requestingEntityId": "workspace_123",
    "featureKey": "advanced_analytics"
  }'

curl -X POST "https://app.crovver.com/api/public/can-access" \
  -H "x-public-key: pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "requestingEntityId": "workspace_123",
    "featureKey": "advanced_analytics",
    "productSlug": "product-a"
  }'

curl -X POST "https://app.crovver.com/api/public/can-access" \
  -H "x-public-key: pk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "requestingEntityId": "workspace_123",
    "productSlug": "product-a"
  }'

{
  "success": true,
  "data": {
    "canAccess": true,
    "featureKey": "advanced_analytics",
    "requestingEntityId": "workspace_123"
  }
}

{
  "success": true,
  "data": {
    "canAccess": true,
    "featureKey": "advanced_analytics",
    "productSlug": "product-a",
    "requestingEntityId": "workspace_123"
  }
}

{
  "success": true,
  "data": {
    "canAccess": true,
    "productSlug": "product-a",
    "requestingEntityId": "workspace_123"
  }
}

{
  "success": true,
  "data": {
    "canAccess": false,
    "featureKey": "advanced_analytics",
    "requestingEntityId": "workspace_123"
  }
}

Overview

Subscriptions

Checkout

Credits

Add-ons

Capacity (Seats)

Features & Usage

Plans

Tenants

Deprecated

Check Feature Access

Request Body

Authentication

Response

​Request Body

​Authentication

​Response

Request Body

Authentication

Response