Business Loyalty Plans Model

ActionMethodResourceDescription
Get allGET/loyalty_plans/loyalty_plan_id/businessesGet all business loyalty plans.
GetGET/loyalty_plans/loyalty_plan_id/businesses/business_idGet business loyalty plans by id.
UpdatePOST/loyalty_plans/loyalty_plan_id/businesses/business_idUpdate business loyalty plans.
Only admins
CreatePOST/loyalty_plans/loyalty_plan_id/businessesCreate business loyalty plans.
DeleteDELETE/loyalty_plans/loyalty_plan_id/businesses/business_idDelete business loyalty plans by id.

The loyalty plan model is composed of the following attributes:

AttributeTypeRequiredDescriptionwhereable
idIntegerNoIdentifier of the Business loyalty plans
business_idIntegerYesIdentifier of the business
loyalty_plan_idIntegerYesIdentifier of the loyalty plan
redeemsBooleanYesAllow redeems
accumulatesBoleanYesAllow accumulates
redemption_rateFloatNoRedemption rate of the loyalty plan
accumulation_rateFloatNoAccumulation rate of the loyalty plan
maximum_redemption_typeIntegerNoMaximum redemption type of the loyalty plan:
1, 2
maximum_redemption_rateFloatNoMaximum redemption rate of the loyalty plan
maximum_accumulationFloatNoMaximum accumulation of the loyalty plan
expire_after_minutesIntegerNoExpire after minutes of the loyalty plan
created_atTimestampNoDate when the business loyalty plan was created
updated_atTimestampNoDate when the business loyalty plan was updated