Plugin Is Entitled
Check whether a user is entitled to a plugin.
Available to: Traders (own records); organization administrators (any user in their organization)
Environments: Live
Rate Limit: No endpoint-specific limit
Check whether a user holds an unexpired plugin for entitlementName that fits their current subscription plan. A plugin is a user’s subscription to an entitlement. To check another user, an organization administrator also passes that user’s userId; omit userId to check yourself. When the user is entitled, the response returns the plugin in entitlementSubscription.
Set withTolerance to true to treat a plugin (or the user’s subscription plan) that expires today as unexpired until 19:00 Central Time. If you omit it, a plugin or plan that expires today counts as expired.
Common Failure Scenarios
- The user has no unexpired plugin for
entitlementNamethat fits their current subscription plan. This returnsHTTP 200with"No plugins found"inerrorTextand noentitlementSubscription. A plugin withplanCategoriesfits only users whose plan category is one of them; a plugin without them fits any user with a current plan. - The request includes
userIdand the caller isn’t an organization administrator. This returnsHTTP 401even whenuserIdis the caller’s own ID, so omituserIdto check yourself. - No user matches
userId, or you can’t access that user. Both returnHTTP 404with an empty body. Most organization administrators can’t access users outside their organization. - The caller’s user type, or the API key’s permissions, don’t include full access to the
Usersresource. This returnsHTTP 401with"Access is denied". entitlementNameis empty or longer than 64 characters, oruserIdisn’t greater than 0. These returnHTTP 400.- The request is sent to Demo. This endpoint runs on Live only, so Demo returns
HTTP 501.
This endpoint returns HTTP 200 for both successful and rejected requests, so check the errorText field to confirm the result. Other failures, such as denied access or an invalid request, return their own HTTP status.
Error Messages
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed