Skip to content

Evaluate every feature for a customer now

POST
/v1/entitlements/evaluate-all
curl --request POST \
--url https://api.seal0.app/v1/entitlements/evaluate-all \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "customer_id": "example" }'
Media typeapplication/json
object
customer_id
required

Opaque customer ID from the integrating application.

string
/^[A-Za-z0-9._:-]{1,255}$/

Example generated

{
"customer_id": "example"
}

One entitlement per feature in the environment, ordered by key.

Media typeapplication/json
object
customer_id
required
string
entitlements
required
Array<object>
object
feature_key
required
string
feature_type
required
string
granted
required
boolean
override_id
required
string
nullable
reason
required

Reason code; clients must tolerate new codes.

string
source
required
string
usage
required

Usage against the limit in the current period, for metered features that resolved a value; null otherwise.

object
limit
required
One of:
boolean
over_limit
required

Used >= limit. Can be true while the feature is still granted, within the grace margin.

boolean
period_end
required
string format: date-time
period_start
required
string format: date-time
remaining
required

Max(limit - used, 0), or “unlimited”.

One of:
boolean
used
required
integer format: int64
valid_until
required
string format: date-time
nullable
value
required

Resolved value, or null when nothing resolved.

One of:
boolean
evaluated_at
required
string format: date-time
subscription
required

The customer’s current subscription, or null when there is none.

object
id
required
string
plan
required

A pinned plan version.

object
key
required

Feature or plan key.

string
/^[a-z][a-z0-9_]{0,63}$/
version
required
integer
>= 1
status
required
string

Example generated

{
"customer_id": "example",
"entitlements": [
{
"feature_key": "example",
"feature_type": "example",
"granted": true,
"override_id": "example",
"reason": "example",
"source": "example",
"usage": {
"limit": true,
"over_limit": true,
"period_end": "2026-04-15T12:00:00Z",
"period_start": "2026-04-15T12:00:00Z",
"remaining": true,
"used": 1
},
"valid_until": "2026-04-15T12:00:00Z",
"value": true
}
],
"evaluated_at": "2026-04-15T12:00:00Z",
"subscription": {
"id": "example",
"plan": {
"key": "example",
"version": 1
},
"status": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}