Newer Version Available

This content describes an older version of this product. View Latest

UsageResource

Represents an entitlement granted to a user or party by a provider, such as data storage, computing power, bandwidth, or any other product or service. Used to represent resources consumed over time. This object is available in API version 62.0 and later.

Supported Calls

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

Fields

Field Details
Category
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies the category of the usage resource that's used to organize and understand the product grant maps.
Possible values are:
  • Usage
Code
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The unique user-defined string for the usage resource.
DefaultUnitOfMeasureId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The default unit of measure for the given resource. The default value can be overridden with an alternate default unit of measure for a given resource.
This field is a relationship field.
Relationship Name
DefaultUnitOfMeasure
Refers To
UnitOfMeasure
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the usage resource.
DoesUsagePersist
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the usage resource remains allocated or available to a user regardless of whether the resource is actively being consumed.
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the usage resource record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the usage resource.
Possible values are:
  • Active
  • Draft
  • Inactive
UnitOfMeasureClassId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unit of measure class that's used with the resource to define the units in which this resource is measured.
This field is a relationship field.
Relationship Name
UnitOfMeasureClass
Refers To
UnitOfMeasureClass
UsageDefinitionProductId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The product associated with the usage resource to retrieve tax policy, calculate rating during overages, and other invoicing actions.
This field is a relationship field.
Relationship Name
UsageDefinitionProduct
Refers To
Product2
UsageResourceBillingPolicyId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The usage resource billing policy that defines how the usage resource can be aggregated before it's sent for rating.
This field is a relationship field.
Relationship Name
UsageResourceBillingPolicy
Refers To
UsageResourceBillingPolicy