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

Object Index

You are viewing an old version of the API
LoyaltyPromotion

Represents a promotion for a loyalty program.

Loyalty promotions enable buyers to earn extra points on top of those earned from the base program.

A loyalty program can have a maximum of 10 loyalty promotions with an ACTIVE or SCHEDULED status.

Properties

Name Description
id
string

Read only The Square-assigned ID of the promotion.

Min Length 1 Max Length 255
name
string

Required

The name of the promotion.

Min Length 1 Max Length 50
incentive
LoyaltyPromotionIncentive

Required

The points incentive for the promotion. This field defines whether promotion points are earned by multiplying base program points or by adding a specified number of points.

available_time
LoyaltyPromotionAvailableTimeData

Required

The scheduling information that defines when purchases can qualify to earn points from an ACTIVE promotion.

trigger_limit
LoyaltyPromotionTriggerLimit

The number of times a buyer can earn promotion points during a specified interval. If not specified, buyers can trigger the promotion an unlimited number of times.

status
string

Read only The current status of the promotion.

created_at
string

Read only The timestamp of when the promotion was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

canceled_at
string

Read only The timestamp of when the promotion was canceled, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

updated_at
string

Read only The timestamp when the promotion was last updated, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

loyalty_program_id
string

Read only The ID of the loyalty program associated with the promotion.

minimum_spend_amount_money
Money

The minimum purchase amount required to earn promotion points. If specified, this amount is positive.

qualifying_item_variation_ids
string [ ]

The IDs of any qualifying ITEM_VARIATION catalog objects. If specified, the purchase must include at least one of these items to qualify for the promotion.

This option is valid only if the base loyalty program uses a VISIT or SPEND accrual rule. With SPEND accrual rules, make sure that qualifying promotional items are not excluded.

You can specify qualifying_item_variation_ids or qualifying_category_ids for a given promotion, but not both.

Max Length 500
qualifying_category_ids
string [ ]

The IDs of any qualifying CATEGORY catalog objects. If specified, the purchase must include at least one item from one of these categories to qualify for the promotion.

This option is valid only if the base loyalty program uses a VISIT or SPEND accrual rule. With SPEND accrual rules, make sure that qualifying promotional items are not excluded.

You can specify qualifying_category_ids or qualifying_item_variation_ids for a promotion, but not both.

Max Length 500