Calculate loyalty points
Calculates the number of points a buyer can earn from a purchase.
Applications might call this endpoint to display the points to the buyer.
If you are using the Orders API to manage orders, provide the
order_id
and (optional)loyalty_account_id
. Square reads the order to compute the points earned from the base loyalty program and an associated loyalty promotion.If you are not using the Orders API to manage orders, provide
transaction_amount_money
with the purchase amount. Square uses this amount to calculate the points earned from the base loyalty program, but not points earned from a loyalty promotion. For spend-based and visit-based programs, thetax_mode
setting of the accrual rule indicates how taxes should be treated for loyalty points accrual. If the purchase qualifies for program points, call ListLoyaltyPromotions and perform a client-side computation to calculate whether the purchase also qualifies for promotion points. For more information, see Calculating promotion points.
Name | Description |
---|---|
program_
Required
|
The ID of the loyalty program, which defines the rules for accruing points. |
Name | Description |
---|---|
order_
|
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_
|
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 |
loyalty_
|
The ID of the target loyalty account. Optionally specify this field if your application uses the Orders API to process orders. If specified, the |
Response Fields
Name | Description |
---|---|
errors
|
Any errors that occurred during the request. |
points
|
The number of points that the buyer can earn from the base loyalty program. |
promotion_
|
The number of points that the buyer can earn from a loyalty promotion. To be eligible
to earn promotion points, the purchase must first qualify for program points. When |
Examples
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/loyalty/programs/d619f755-2d17-41f3-990d-c04ecedd64dd/calculate \
-X POST \
-H 'Square-Version: 2023-01-19' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY",
"loyalty_account_id": "79b807d2-d786-46a9-933b-918028d7a8c5"
}'
{
"points": 6,
"promotion_points": 12
}