Get Entitlement Eligibility Info
Retrieve eligibility details for an entitlement.
Available to: Traders (own entitlement eligibility)
Environments: Live
Rate Limit: No endpoint-specific limit
Return the caller’s eligibility record for a given entitlementId, with the fields firstStartDate, lastStartDate, nextEligibleDate, lastExpirationDate, and usageCount.
Common Failure Scenarios
- No entitlement matches
entitlementId, or the caller can’t access it. Both returnHTTP 404with an empty body. The caller can’t access an entitlement that’s discontinued, not yet active, limited to organization administrators (when the caller isn’t one), or restricted by use conditions the caller doesn’t meet. - 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". entitlementIdisn’t greater than 0. This returnsHTTP 400.- The request is sent to Demo. This endpoint runs on Live only, so Demo returns
HTTP 501. - The eligibility lookup finds no record for the caller and this entitlement. The call still succeeds (
HTTP 200with noerrorText), but the response has none of the date fields orusageCount. - The eligibility lookup fails or times out. This returns
HTTP 200with the reason inerrorText.
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
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
entitlementId
Response
EligibilityInfoResponse
errorText
Non-empty if the request failed
lastStartDate
nextEligibleDate
lastExpirationDate
usageCount
firstStartDate