Entitlements
Check an entitlement
Answers whether a platform identity currently holds access, and returns the entitlements that back it. Pass `tier_id` to check a specific tier; omit it to check for any access.
Authorization
apiKey AuthorizationBearer <token>
Community-scoped API key. Send it as Authorization: Bearer arclt_live_.... Keys carry scopes; endpoints that need a specific scope answer 403 missing_scope when the key lacks it.
In: header
Query Parameters
platform*string
The community platform (for example discord).
platform_uid*string
The identity's stable id on that platform.
tier_id?string
Restrict the check to a specific plan tier.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/entitlements/check?platform=string&platform_uid=string"{
"entitled": true,
"entitlements": [
{
"tier_id": "tier_01JMZX2A9F",
"plan_id": "plan_01JMZX3B2K",
"source_type": "subscription",
"source_id": "sub_01JMZX47H8Q2C9R4T1",
"status": "active",
"access_expires_at": "2026-08-01T00:00:00Z",
"grants": [
{
"platform": "discord",
"platform_config_id": "pcfg_01JMZX8C4M",
"grant_type": "role",
"grant_value": "998877665544332211"
}
]
}
]
}{
"type": "https://docs.arcalotl.com/api/errors#not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"code": "not_found"
}{
"type": "https://docs.arcalotl.com/api/errors#not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"code": "not_found"
}{
"type": "https://docs.arcalotl.com/api/errors#not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"code": "not_found"
}