Skip to main content

ProductEntitlement

What one unit of a platform product grants for a single feature. For a limit feature a null count means unlimited.

type ProductEntitlement {
  feature: EntitlementFeatureEnum!
  grantCount: Int
  id: ID!
  title: String!
  type: EntitlementTypeEnum!
  unlimited: Boolean!
}

Fields​

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

The feature this entitlement governs.

ProductEntitlement.grantCount ● Int scalar common​

What one unit grants. For a limit, the count (null means unlimited); for a flag, a non-zero count means enabled.

ProductEntitlement.id ● ID! non-null scalar common​

Unique identifier for the entitlement.

ProductEntitlement.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.

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

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

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

Whether this feature is uncapped on the product. Always false for a flag.

Member Of​

PlatformProduct object