Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
17 lines (12 loc) · 1.53 KB

LoyaltyProgramAccrualRule.md

File metadata and controls

17 lines (12 loc) · 1.53 KB

SquareConnect.LoyaltyProgramAccrualRule

Description

Note: This model is in beta.

Defines an accrual rule, which is how buyers can earn points.

Properties

Name Type Description Notes
accrual_type String The type of the accrual rule that defines how buyers can earn points. See LoyaltyProgramAccrualRuleType for possible values
points Number The number of points that buyers earn based on the `accrual_type`. [optional]
visit_minimum_amount_money Money When the accrual rule is visit-based (`accrual_type` is `VISIT`), this field indicates the minimum purchase required during the visit to quality for the reward. [optional]
spend_amount_money Money When the accrual rule is spend-based (`accrual_type` is `SPEND`), this field indicates the amount that a buyer must spend to earn the points. For example, suppose the accrual rule is "earn 1 point for every $10 you spend". Then, buyer earns a point for every $10 they spend. If buyer spends $105, the buyer earns 10 points. [optional]
catalog_object_id String The ID of the `catalog object` to purchase to earn the number of points defined by the rule. This is either an item variation or a category, depending on the type. This is defined on `ITEM_VARIATION` rules and `CATEGORY` rules. [optional]