LoyaltyPgmCurrencySubtype

Represents a subtype of a fixed-model non-qualifying loyalty program currency. This object is available in API version 61.0 and later.

Supported Calls

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

Special Access Rules

This object is available only if the Loyalty Management - Advanced license is enabled in your org.

Fields

CostPerUnit

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: Monetary value of each unit of the loyalty program currency subtype.

Description

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: Description of the loyalty program currency subtype.

ExpiryModel

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: Specifies the expiration model of the subcurrency. Available in API version 68.0 and later.

Possible values are:

Activity
Fixed

ExpiryPeriod

Type: int

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The number of expiration period units after which points expire. Available in API version 68.0 and later.

ExpiryPeriodUnit

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: The unit of time for the expiration period. Available in API version 68.0 and later.

Possible values are:

Months
Years

ExtendExpiration

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: Specifies whether the expiration happens on the exact day or the last day of the month. This field is used only for redeemable currencies. Available in API version 68.0 and later.

Possible values are:

None—No Extension
TillEndOfMonth—Till End Of Month

IsActive

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Required. Indicates whether the loyalty program currency subtype is active (true) or not (false).

The default value is false.

LastReferencedDate

Type: dateTime

Properties: Filter, Nillable, Sort

Description: Most recent date on which a user referenced this record.

LastViewedDate

Type: dateTime

Properties: Filter, Nillable, Sort

Description: Most recent date on which a user viewed this record.

LoyaltyProgramCurrencyId

Type: reference

Properties: Create, Filter, Group, Sort

Description: Required. The fixed-model non-qualifying loyalty program currency associated with the loyalty program currency subtype.

This field is a relationship field.

Relationship Name: LoyaltyProgramCurrency

Relationship Type: Master-detail

Refers To: LoyaltyProgramCurrency (the master object)

Name

Type: string

Properties: Create, Filter, Group, idLookup, Sort, Update

Description: Required. The name of the loyalty program currency subtype.

UsagePriorityNumber

Type: int

Properties: Create, Filter, Group, idLookup, Sort, Update

Description: Required. The usage priority number of the loyalty program currency subtype. The usage priority number decides the order in which the points are redeemed across currency subtypes when multiple currency subtypes expire on the same date.