LoyaltyProgramPartner

Represents partners that are associated with a given loyalty program. Partners can be an accrual partner, a redemption partner, or both. This object is available in API version 51.0 and later.

Supported Calls 

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

Fields 

AccrualCostperUnit 

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The cost per point associated with the transactions of accrual partner. This field is available in API version 52.0 and later.

AlertValue 

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The value that’s used to send an alert to a partner to indicate the minimum points required when the billing type is prepaid or the maximum outstanding amount when the billing type is postpaid. This field is available in API version 55.0 and later.

BillingType 

Type: picklist

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

Description: Specifies the method in which the loyalty program partner is billed.

Possible values are:

  • Prepaid
  • Postpaid

This field is available in API version 55.0 and later.

CreditedPoints 

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The number of points credited to partners (using prepaid billing) for member redemptions, accrual cancellations, or any custom processes. This field is available in API version 55.0 and later.

DebitedPoints 

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The total number of points debited from the partner (using prepaid billing) for member accruals, redemption cancellations, or any custom processes. This field is available in API version 55.0 and later.

IsMemberLinkingAllowed 

Type: boolean

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

Description: Indicates whether a member is allowed to link with a partner (true) or not (false). When you allow linking, you must enter an effective start date.

The default value is false.

LastProcessedDateTime 

Type: dateTime

Properties: Create, Filter, Nillable, Sort, Update

Description: The last date and time when the prepaid points balance or the outstanding postpaid bill amount for a partner was calculated. This field is available in API version 55.0 and later.

LastReferencedDate 

Type: dateTime

Properties: Filter, Nillable, Sort

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

LastViewedDate 

Type: dateTime

Properties: Filter, Nillable, Sort

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

LoyaltyPartnerId 

Type: reference

Properties: Create, Filter, Group, Sort, Update

Description: Required. Account ID of the loyalty program partner.

This is a relationship field.

Relationship Name: LoyaltyPartner

Relationship Type: Lookup

Refers To: Account

LoyaltyProgramId 

Type: reference

Properties: Create, Filter, Group, Sort, Update

Description: Required. ID of the loyalty program.

This is a relationship field.

Relationship Name: LoyaltyProgram

Relationship Type: Lookup

Refers To: LoyaltyProgram

MemberLinkingEffEndDate 

Type: dateTime

Properties: Create, Filter, Nillable, Sort, Update

Description: The date after which members can’t be linked to a partner.

MemberLinkingEffStartDate 

Type: dateTime

Properties: Create, Filter, Nillable, Sort, Update

Description: The date from which members can be linked to a partner.

Name 

Type: string

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

Description: The name of the loyalty program partner.

OwnerId 

Type: reference

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

Description: The ID of the user who owns this record.

This is a polymorphic relationship field.

Relationship Name: Owner

Relationship Type: Lookup

Refers To: Group, User

PartnerCategory 

Type: picklist

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

Description: The category of the program partnership.

Possible values are:

  • Alliance
  • Bilateral

PartnerIndustry 

Type: picklist

Properties: Create, Filter, Group, Sort, Update

Description: Required. The industry type of the program partner. Picklist values aren’t provided for this field and must be added based on the requirements of the organization.

PartnerStatus 

Type: picklist

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

Description: Required. The status of the partner in the loyalty program. The default value is Active.

Possible values are:

  • Active
  • Inactive
  • Pending

PartnerType 

Type: picklist

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

Description: Required. The type of the program partnership.

Possible values are:

  • Accrual
  • Both
  • Redemption

PartnershipEndDate 

Type: date

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

Description: The date on which the partnership with the program ends.

PartnershipStartDate 

Type: date

Properties: Create, Filter, Group, Sort, Update

Description: Required. The date on which the partnership with the program starts.

PointsBalance 

Type: double

Properties: Filter, Nillable, Sort

Description: The number of points available with the loyalty program partner using prepaid billing. This field is available in API version 55.0 and later.

This is a calculated field.

PostpaidBillAmount 

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The total amount of all credits minus debits for partner transactions from the partnership start date. A positive value indicates that the partner is liable to the program. A negative value indicates the program is liable to the partner. The total amount that either the partner is liable to pay to the program or the program is liable to pay to the partner. This field is available in API version 55.0 and later.

PurchasedPoints 

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The total number of points that the partner (using prepaid billing) has purchased across all their packs. This field is available in API version 55.0 and later.

RedemptionCostperUnit 

Type: currency

Properties: Create, Filter, Nillable, Sort, Update

Description: The cost per point associated with the transactions of redemption partner. This field is available in API version 52.0 and later.

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.

LoyaltyProgramPartnerChangeEvent (API Version 62.0): Change events are available for the object.

LoyaltyProgramPartnerHistory (API version 52.0): History is available for tracked fields of the object.

LoyaltyProgramPartnerOwnerSharingRule: Sharing rules are available for the object.

LoyaltyProgramPartnerShare (API version 52.0): Sharing is available for the object.