Skip to main content

companyEntitlementGroups

The current company's entitlements, grouped by the line that granted them. Use it to show what a company holds and what it pays for each line, rather than one merged total.

Business Rules​

  • One group per active grant. A suspended or revoked grant is absent.
  • Entitlements are resolved per line, so a limit already accounts for quantity: two units of an add-on granting one connection each report two connections.
  • billedAmount is null when no billing line backs the group, which is how a comped or hand-issued entitlement reads.
  • Groups are returned oldest first, so the plan a company started on leads the list.

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.

companyEntitlementGroups: [CompanyEntitlementGroup!]!

Type​

CompanyEntitlementGroup object entitlements​

One line of a company's entitlements: a platform product it holds, or a single feature granted on its own. The entitlements are resolved for this line alone, so a limit already accounts for the quantity held.