Get entitlement offer value

Retrieve the effective entitlements for a reseller account, a company account, or a single user. Entitlements are defined at three levels - reseller, company and user - and this endpoint resolves them into one row per offering: the most specific rule wins, so a user-level rule overrides a company-level rule, which overrides a reseller-level rule. If no rule matches at any level, the reseller-level defaults of the nearest ancestor account are returned instead. Supply at least one of reseller_account_id, company_account_id or user_uuid to pick the level to resolve from; reseller_account_id defaults to the authenticated reseller account when omitted. Requesting another reseller's account, or a company that does not belong to the authenticated reseller, returns 403. In the response, reseller_account_id, company_account_id and user_uuid report the level the returned rule came from, and * means the rule is not scoped to that level.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Account identifier

Query Params
string

Reseller account UUID to resolve reseller-level entitlements from. Defaults to the authenticated reseller account. Only the authenticated reseller account is accepted.

string

Company account UUID to resolve company-level entitlements from. Must belong to the authenticated reseller account.

string

User UUID to resolve user-level entitlements from. The user's company is resolved automatically, so company_account_id is not needed.

integer

Filter to a single offering by identifier.

string

Filter to a single offering by name. Ignored when offering_id is supplied.

boolean

Filter by the offering's hidden flag.

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json