Skip to main content

companyEntitlements

The current company's entitlements, merged across every grant it holds. Use it to show what a company can do and how much of a limit it has left. Use companyEntitlementGroups instead to show which line granted what, or what each line costs.

Business Rules​

  • One entry per feature the company is entitled to. A feature nothing grants is absent, which reads the same as a limit of zero or a flag that is off.
  • Limits sum across grants and unlimited wins over any cap, so this is the same set the server enforces against when it blocks a connect.
  • Only active grants count. A suspended or revoked grant contributes nothing.
  • Entries come back in the order the feature registry lists them.

Error Scenarios​

  • Company context is required - No company is set on the request.
  • Not authorized - The caller has no role on the company.

Permissions Required​

The company's own members and system admins.

companyEntitlements: [CompanyEntitlement!]!

Type​

CompanyEntitlement object entitlements​

A company's resolved entitlement for a single feature, merged across every grant it holds.