Skip to main content

companyAllowanceEnabled

Whether the current company holds a flag feature, resolved through the same guard that enforces it on gated mutations. Use it to paywall a module in the UI without reimplementing the entitlement rules.

Business Rules​

  • A flag that no active grant carries resolves to false.
  • A company that is not on the entitlements_enforced flag resolves to true. Nothing is gated for it yet, so the UI must not paywall it.
  • A system admin always resolves to true.

Error Scenarios​

  • Company context is required - No company is set on the request.
  • Only flag features can be resolved - A numeric limit feature was requested. Read those from companyEntitlementGroups, which returns their caps.

Permissions Required​

Any signed-in member of the company. The answer is a single boolean about the caller's own company and exposes no billing or payment detail.

companyAllowanceEnabled(
  feature: EntitlementFeatureEnum!
): Boolean!

Arguments​

companyAllowanceEnabled.feature ● EntitlementFeatureEnum! non-null enum entitlements​

The flag feature to resolve, such as SUPPLY_CHAIN.

Type​

Boolean scalar common​

The Boolean scalar type represents true or false.