Loyalty Earning Rule Object


A loyalty earning rule defines how customers earn points in a loyalty program. You can create rules for different activities, such as making purchases.

Properties
idstringRead-onlyformat GUID

Loyalty earning rule ID.


sourceAppIdstringformat GUID

ID of the app managing the earning rule. Can be a loyalty app ID or a Wix automations app ID.


triggerAppIdstringminLength 1maxLength 80

ID of the app that triggers point assignment. Examples: Wix Stores, Wix Bookings, Wix Events.


triggerActivityTypestringminLength 1maxLength 80

Type of activity that triggers point assignment. For example, wix-restaurants/orderSubmitted or birthday.


titlestringminLength 1maxLength 50

Name of the earning rule.


statusstring

Current status of the earning rule.

  • UNKNOWN: Status is unknown or not specified.
  • ACTIVE: Earning rule is active and can assign points.
  • PAUSED: Earning rule is paused and cannot assign points.

revisionintegerformat uint64

Revision number, incremented by 1 each time the earning rule is updated. Pass the latest revision when updating to prevent conflicting changes.


createdDatestringRead-onlyformat date-time

Date and time the earning rule was created.


updatedDatestringRead-onlyformat date-time

Date and time the earning rule was last updated.


metadataMetadataRead-only

Additional metadata about the earning rule.


ONE OF:

fixedAmountFixedAmount

Fixed amount of points awarded for each qualifying activity.


conversionRateConversionRate

Points awarded based on a conversion rate formula: (amount spent) / (money_amount * points).

Did this help?