Business Loyalty Plans Model
A business loyalty plan records how one business participates in a loyalty plan. It can override the plan's accumulation, redemption, maximum, and expiration settings for that business.
Approved related operations
| Action | Method | Resource |
|---|---|---|
| List business settings | GET | /loyalty_plans/{loyalty_plan_id}/businesses |
| Find business settings | GET | /loyalty_plans/{loyalty_plan_id}/businesses/{business_id} |
Both list and find operations require administrator authentication. See List business loyalty plans and Find a business loyalty plan.
Older documentation also describes create, update, and delete operations under singular /business paths. Those paths do not match the plural routes listed here, and the public API reference does not list corresponding operations.
Representative fields
Identity fields include id, business_id, and loyalty_plan_id. Behavior is controlled by redeems, accumulates, redemption_rate, accumulation_rate, maximum_redemption_type, maximum_redemption_rate, maximum_accumulation, and expire_after_minutes.
Values 1 and 2 are listed for maximum_redemption_type, but their meanings are not clear. Use the operation-specific contract and product configuration to determine accepted values, requirements, and responses.
Schema properties
Schema: BusinessLoyaltyPlan
| Name | Type | Description |
|---|---|---|
accumulates | boolean | null | — |
accumulation_rate | number | null | — |
business_id | number | null | — |
expire_after_minutes | any | — |
id | integer | null | — |
loyalty_plan_id | number | null | — |
maximum_accumulation | number | null | — |
maximum_redemption_rate | number | null | — |
maximum_redemption_type | any | — |
redeems | boolean | null | — |
redemption_rate | number | null | — |