--- schema_version: "1" id: 335a17144503b648edca679beb4350d3522c9f51670a284e79be8538f922371a title: TenantUsageEntitlement collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_tenantusageentitlement.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_tenantusageentitlement.htm source_site: developer.salesforce.com content_type: documentation content_hash: d8142c17c2d4529d6230d070be00ac57da1238e9079b5401ddfb3ba431c3f498 description: Represents a data structure that contains information about the features or functionalities that a Salesforce org has access to. This object is available in API version 28.0 and later. --- # TenantUsageEntitlement Represents a data structure that contains information about the features or functionalities that a Salesforce org has access to. This object is available in API version 28.0 and later. ## Supported Calls describeLayout(), describeSObjects(), query(), retrieve() ## Fields | Field | Details | | --- | --- | | AmountUsed | Type double Properties Filter, Nillable, Sort Description The quantity of an entitlement that has been used. | | CurrentAmountAllowed | Type double Properties Filter, Sort Description The amount of an entitlement that a tenant is allowed to use. | | EndDate | Type date Properties Filter, Group, Nillable, Sort Description The end date of the setting, based on license end dates that entitle the org to that setting. | | Frequency | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description How often the tenant's entitlement data is automatically reviewed to see how much of the entitlement has been used. Possible values are: - Daily - Fortnightly - Monthly - Once - Quarterly - Weekly - Yearly | | HasRollover | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that a certain amount of a customer's unused entitlements from a set time period can be added to the next set time period. This field is reserved for future use. The default value is false. | | IsPersistentResource | Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates that the data that will be saved and available for future use even after closing a session. The default value is false. | | MasterLabel | Type string Properties Group, Nillable Description The overarching name of an element in your organization. A MasterLabel is visible to customers. | | OverageGrace | Type percent Properties Filter, Nillable, Sort Description The percentage of the Allowed Amount that a customer can use without incurring an additional charge. The default value is 100% (no overage grace). This field is reserved for future use. | | ResourceGroupKey | Type string Properties Filter, Group, Sort Description Tracks resource usage across different segments for the same setting. For example, a Messages entitlement that tracks email messages and SMS messages separately could have one ResourceGroupKey of SMS and another ResourceGroupKey of Email. In most cases though, TenantUsageEntitlements are configured for the org and not by segment. | | Setting | Type string Properties Filter, Group, Sort Description A rule or attribute that can be used to configure the appearance or actions in an organization. | | StartDate | Type date Properties Filter, Group, Sort Description This date is the earliest start date of any license contributing to the provisioning aggregation output. | | UsageDate | Type dateTime Properties Filter, Nillable, Sort Description The date an event occurred that deducted from the tenant's entitlement. | ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. [TenantUsageEntitlementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [TenantUsageEntitlementFeed](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [TenantUsageEntitlementHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [TenantUsageEntitlementOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [TenantUsageEntitlementShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.