• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
LoyaltyProgramAccrualRule BETA

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

Properties

Name Description
accrual_type
string

Required

Read only The type of the accrual rule that defines how buyers can earn points.

points
integer (32-bit)

Read only The number of points that buyers earn based on the accrual_type.

Min 1
visit_minimum_amount_money
Money

Read only 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.

spend_amount_money
Money

Read only 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.

catalog_object_id
string

Read only 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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?