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

Object Index

You are viewing an old version of the API
LoyaltyProgramRewardDefinition

Deprecated

Provides details about the reward tier discount.

DEPRECATED at version 2020-12-16. Discount details are now defined using a catalog pricing rule and other catalog objects. For more information, see Get discount details for the reward.

Properties

Name Description
scope
string

Required

Read only Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. You can find this information in the discount_target_scope field of the PRICING_RULE catalog object and the product_set_data field of the PRODUCT_SET catalog object referenced by the pricing rule. For ORDER scopes, the target scope is WHOLE_PURCHASE and all_products is true. For ITEM_VARIATION and CATEGORY scopes, the target scope is LINE_ITEM and product_ids_any is a list of catalog object IDs of the given type.

discount_type
string

Required

Read only The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. You can find this information in the discount_data.discount_type field of the DISCOUNT catalog object referenced by the pricing rule.

percentage_discount
string

Read only The fixed percentage of the discount. Present if discount_type is FIXED_PERCENTAGE. For example, a 7.25% off discount will be represented as "7.25". DEPRECATED at version 2020-12-16. You can find this information in the discount_data.percentage field of the DISCOUNT catalog object referenced by the pricing rule.

catalog_object_ids
string [ ]

Read only The list of catalog objects to which this reward can be applied. They are either all item-variation ids or category ids, depending on the type field. DEPRECATED at version 2020-12-16. You can find this information in the product_set_data.product_ids_any field of the PRODUCT_SET catalog object referenced by the pricing rule.

fixed_discount_money
Money

Read only The amount of the discount. Present if discount_type is FIXED_AMOUNT. For example, $5 off. DEPRECATED at version 2020-12-16. You can find this information in the discount_data.amount_money field of the DISCOUNT catalog object referenced by the pricing rule.

max_discount_money
Money

Read only When discount_type is FIXED_PERCENTAGE, the maximum discount amount that can be applied. DEPRECATED at version 2020-12-16. You can find this information in the discount_data.maximum_amount_money field of the DISCOUNT catalog object referenced by the the pricing rule.

Share feedback

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