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

Object Index

You are viewing an old version of the API
LoyaltyProgramRewardDefinition BETA

Provides details about the loyalty program reward tier definition.

Properties

Name Description
scope
string

Required

Read only Indicates the scope of the reward tier.

discount_type
string

Required

Read only The type of discount the reward tier offers.

percentage_discount
string

Read only Present if discount_type is FIXED_PERCENTAGE. For example, a 7.25% off discount will be represented as "7.25".

catalog_object_ids
string [ ]

Read only A list of catalog object ids to which this reward can be applied. They are either all item-variation ids or category ids, depending on the type field.

fixed_discount_money
Money

Read only Present if discount_type is FIXED_AMOUNT. For example, $5 off.

max_discount_money
Money

Read only When discount_type is FIXED_PERCENTAGE, the maximum discount amount that can be applied.

Share Feedback

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