UsageEntitlementBucket

Represents a usage entitlement that's granted with the sellable product. This object is available in API version 63.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
BucketBalance
Type
double
Properties
Create, Filter, Sort, Update
Description
The balance of the usage entitlement bucket after each transaction.
BucketBalanceUomId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The unit that's used to measure the usage entitlement bucket balance.
This field is a relationship field.
Relationship Name
BucketBalanceUom
Refers To
UnitOfMeasure
CompletedRollovers
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of rollovers that were completed for the entitlements.
ConsumedEntitlement
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The entitlements that have been consumed from this bucket.
EffectiveEndDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the usage entitlement bucket period ends.
EffectiveStartDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time when the usage entitlement bucket becomes effective.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date when this record was last referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Autogenerated identifier for the usage entitlement bucket record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of the usage entitlement bucket.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
ParentId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The parent record that's associated with the usage entitlement bucket.
This field is a polymorphic relationship field.
Relationship Name
Parent
Refers To
UsageEntitlementAccount, UsageEntitlementBucket
TotalAsOfBalance
Type
double
Properties
Filter, Nillable, Sort
Description
The balance of the entitlements granted with the usage resource for a Usage entitlement account.
TotalConsumedEntitlement
Type
double
Properties
Filter, Nillable, Sort
Description
The entitlements that have been consumed from this bucket.
TransactionUsageEntitlementId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The transaction usage entitlement associated with this usage entitlement bucket.
This field is a relationship field.
Relationship Name
TransactionUsageEntitlement
Refers To
TransactionUsageEntitlement
UsageResourceId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The usage resource that's associated with the usage entitlement bucket.
This field is a relationship field.
Relationship Name
UsageResource
Refers To
UsageResource

Associated Objects

This object has these 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.

UsageEntitlementBucketFeed
Feed tracking is available for the object.
UsageEntitlementBucketHistory
History is available for tracked fields of the object.
UsageEntitlementBucketShare
Sharing is available for the object.