Calculates the number of points a buyer can earn from a purchase.
Open in API Reference
The ID of the loyalty program, which defines the rules for accruing points.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The ID of the target loyalty account. Optionally specify this field if your application uses the Orders API to process orders.
If specified, the promotion_points field in the response shows the number of points the buyer would earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's trigger_limit (the maximum number of times that a buyer can trigger the promotion) has been reached. If not specified, the promotion_points field shows the number of points the purchase qualifies for regardless of the trigger limit.
promotion_points
trigger_limit
The order ID for which to calculate the points. Specify this field if your application uses the Orders API to process orders. Otherwise, specify the transaction_amount_money.
transaction_amount_money
The purchase amount for which to calculate the points. Specify this field if your application does not use the Orders API to process orders. Otherwise, specify the order_id.
order_id
// No response received yet.