AssetStatePeriod
Represents a time span when an asset has the same quantity, amount, and monthly recurring revenue (MRR). An asset has as many asset state periods as there are changes to it (asset actions) during its lifecycle. The dashboard and related pages show the current asset state period. The fields can’t be edited.
Introduced in API version 50.0.
createable(), deletable(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), updateable()
- Customer Asset Lifecycle Management APIs require the Access Customer Asset Lifecycle Management APIs permission and read access to the Asset, Asset Action, Asset Action Source, and Asset State Period objects.
- Type: currency
- Properties: Create, Filter, Sort, Update
- Description: An asset’s total amount during an asset state period. Revenue Management doesn’t set or use this field’s value currently.
- Type: percent
- Properties: Create, Filter, Nillable, Sort, Update
- Introduced: API version 68.0
- Description: The unit price uplift percent that’s applied to the asset state period, used for ramp pricing.
-
Type: reference
-
Properties: Create, Filter, Group, Sort
-
Description:
The asset related to an asset state period. Label is Asset.
This field is a relationship field.
-
Relationship name: Asset
-
Relationship type: masterdetail
-
Refers to: Asset
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: The ID of the asset state period. Label is Name.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 65.0
- Description: The time period that indicates how often the line item is billed.
- Possible values:
- Annual — Annual
- Monthly — Monthly
- Quarterly — Quarterly
- Semi-Annual — Semi-Annual
- Type: percent
- Properties: Create, Filter, Nillable, Sort, Update
- Introduced: API version 65.0
- Description: Editable number from 0 to 100.
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Introduced: API version 65.0
- Description: The fixed amount discount to apply to the line item.
- Type: datetime
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The end date and time of an asset state period. On an asset that is an evergreen subscription, the last asset state period has no end date.
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 65.0
-
Description:
The ID of the related legal entity.
This field is a relationship field.
-
Relationship name: LegalEntity
-
Relationship type: relationship
-
Refers to: LegalEntity
- Type: currency
- Properties: Create, Filter, Sort, Update
- Description: An asset’s monthly recurring revenue during an asset state period.
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 65.0
-
Description:
Specifies the price uplift policy associated with this asset state period.
This field is a relationship field.
-
Relationship name: PriceRevisionPolicy
-
Relationship type: relationship
-
Refers to: PriceRevisionPolicy
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 68.0
-
Relationship name: PricingContract
-
Relationship type: relationship
-
Refers to: Contract
- Type: double
- Properties: Create, Filter, Sort, Update
- Description: The total quantity of an asset during an asset state period.
-
Type: string
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 62.0
-
Description:
The ramp record used to group order item segments for this asset state period.
This field is available in orgs that have Revenue Management with the Ramp Deals setting enabled.
The maximum supported length is 255 characters from API version 67.0 and later.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 68.0
- Description: The pricing uplift calculation type for ramp segments.
- Possible values:
- Compound — Compound
- Standard — Standard
-
Type: string
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 62.0
-
Description:
The order item segment for this asset state period.
This field is available in orgs that have Revenue Management with the Ramp Deals setting enabled.
The maximum supported length is 255 characters from API version 67.0 and later.
-
Type: string
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 62.0
-
Description:
The name of the order item segment for this asset state period.
This field is available in orgs that have Revenue Management with the Ramp Deals setting enabled.
The maximum supported length is 255 characters from API version 67.0 and later.
-
Type: picklist
-
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
-
Introduced: API version 62.0
-
Description:
The period for the order item segment for this asset state period.
The default value is
Yearly.This field is available in orgs that have Revenue Management with the Ramp Deals setting enabled.
-
Possible values:
- Custom — Custom
- Free Trial — Free Trial
- Yearly — Yearly (default)
-
Default value: Yearly
- Type: datetime
- Properties: Create, Filter, Sort, Update
- Description: The start date and time of an asset state period.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 68.0
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Introduced: API version 65.0
- Description: The price per unit for the line item. Revenue Management won’t populate this field in API version 66.0 and later.
- Type: percent
- Properties: Create, Filter, Nillable, Sort, Update
- Introduced: API version 65.0
- Description: Indicates the percentage increase of a line item’s unit price.