Skip to main content

CompanyEntitlement

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

type CompanyEntitlement {
  enabled: Boolean!
  feature: EntitlementFeatureEnum!
  limit: Int
  title: String!
  type: EntitlementTypeEnum!
  unlimited: Boolean!
  used: Int
}

Fields​

CompanyEntitlement.enabled ● Boolean! non-null scalar common​

For a flag, whether it is unlocked. For a limit, whether any capacity is granted (either unlimited or a positive cap).

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

The feature this entitlement governs.

CompanyEntitlement.limit ● Int scalar common​

For a limit, the merged cap; null means unlimited. Always null for a flag.

CompanyEntitlement.title ● String! non-null scalar common​

Customer-facing name for the feature, e.g. Warehouses for FULFILLMENT_INTEGRATIONS. Render this rather than mapping the enum.

CompanyEntitlement.type ● EntitlementTypeEnum! non-null enum entitlements​

Whether this entitlement is a boolean flag or a numeric limit.

CompanyEntitlement.unlimited ● Boolean! non-null scalar common​

For a limit, whether the merged cap is unlimited. Always false for a flag.

CompanyEntitlement.used ● Int scalar common​

How many of this feature the company holds right now, counted the way the guard counts it when it blocks a connect. Company-wide, so it is the same number on every group. Null for a flag, and for a limit whose call site is not enforced yet.

Returned By​

companyEntitlements query

Member Of​

CompanyEntitlementGroup object