ArcalotlArcalotl
Entitlements

List a member's entitlements

Returns the member's active entitlements, each resolved to its tier, plan, status, and the platform grants it confers.

Serverhttps://api.arcalotl.com
GET
/v1/members/{id}/entitlements
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

Path Parameters

id*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/members/string/entitlements"
{
  "data": [
    {
      "id": "ment_01JMZX7Q2R",
      "entitlement_id": "ent_01JMZX7P4C",
      "key": "vip-access",
      "name": "VIP access",
      "revision": 4,
      "status": "active",
      "granted_at": "2019-08-24T14:15:22Z",
      "revoked_at": "2019-08-24T14:15:22Z",
      "sources": [
        {
          "type": "subscription",
          "id": "string",
          "status": "active",
          "tier_id": "string",
          "plan_id": "string",
          "client_reference_id": "string",
          "valid_until": "2019-08-24T14:15:22Z"
        }
      ],
      "benefits": [
        {
          "platform": "discord",
          "platform_config_id": "pcfg_01JMZX8C4M",
          "type": "role",
          "value": "998877665544332211"
        }
      ]
    }
  ]
}
{
  "type": "https://docs.arcalotl.com/api/errors#unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid API key is required. Provide it as 'Authorization: Bearer arclt_live_...'.",
  "code": "unauthorized"
}
{
  "type": "https://docs.arcalotl.com/api/errors#missing_scope",
  "title": "Forbidden",
  "status": 403,
  "detail": "This API key is missing the required scope: subscriptions:read.",
  "code": "missing_scope"
}
{
  "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#rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "Rate limit exceeded. Retry after the interval in the Retry-After header.",
  "code": "rate_limited"
}