Skip to main content

CompanyEntitlementGroup

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.

type CompanyEntitlementGroup {
  billedAmount: MonetaryValue
  bundleName: String
  endsAt: ISO8601DateTime
  entitlements: [CompanyEntitlement!]!
  feature: EntitlementFeatureEnum
  grantedAt: ISO8601DateTime!
  grantedBy: String
  id: ID!
  label: String!
  note: String
  quantity: Int!
  revokedAt: ISO8601DateTime
  revokedBy: String
  sourceType: String
  status: EntitlementGrantStatusEnum!
  unlimited: Boolean!
}

Fields​

CompanyEntitlementGroup.billedAmount ● MonetaryValue object common​

What the provider bills for this line each period, with quantity applied, so two units at $199 read $398. Null when no billing line backs it, which is how a comped or hand-issued entitlement reads.

CompanyEntitlementGroup.bundleName ● String scalar common​

Stable name of the entitlement bundle this line grants, e.g. enterprise. Null when the line grants a single feature. Two active lines with the same bundle name double that bundle's limits.

CompanyEntitlementGroup.endsAt ● ISO8601DateTime scalar common​

When a one-off grant ends. It stops entitling at this time. Null when it does not end.

CompanyEntitlementGroup.entitlements ● [CompanyEntitlement!]! non-null object entitlements​

What this line entitles the company to, with quantity already applied.

CompanyEntitlementGroup.feature ● EntitlementFeatureEnum enum entitlements​

The single feature this line grants. Null when it grants a bundle.

CompanyEntitlementGroup.grantedAt ● ISO8601DateTime! non-null scalar common​

When this line was granted.

CompanyEntitlementGroup.grantedBy ● String scalar common​

Name of who issued the line. Null unless the viewer is a system admin, support admin, or support viewer.

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

Unique identifier for the grant behind this line.

CompanyEntitlementGroup.label ● String! non-null scalar common​

Customer-facing name for the line, e.g. Grow or EndlessEDI Connect.

CompanyEntitlementGroup.note ● String scalar common​

The admin's reason for a one-off grant. Null unless the viewer is a system admin, support admin, or support viewer.

CompanyEntitlementGroup.quantity ● Int! non-null scalar common​

How many units of the product this line carries.

CompanyEntitlementGroup.revokedAt ● ISO8601DateTime scalar common​

When this line was revoked. Null unless its status is revoked.

CompanyEntitlementGroup.revokedBy ● String scalar common​

Name of who revoked the line: the admin, or the system when a subscription sync or an expired end date revoked it. Visible to system admins and support staff.

CompanyEntitlementGroup.sourceType ● String scalar common​

What issued this line: subscription_item for a subscription line, manual for a one-off grant an admin issued. Null for an older comp with no source.

CompanyEntitlementGroup.status ● EntitlementGrantStatusEnum! non-null enum entitlements​

Whether this line currently entitles the company.

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

Whether a single-feature limit line is uncapped. Always false for a bundle.

Returned By​

companyEntitlementGroups query