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

You are viewing an old version of the API
Adjust loyalty points

POST /v2/loyalty/accounts/{account_id}/adjust

Adds points to or subtracts points from a buyer's account.

Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow, you call AccumulateLoyaltyPoints to add points when a buyer pays for the purchase.

Permissions
LOYALTY_WRITE
Guide
Adjust loyalty points Try in API Explorer

Path Parameters

Example code
Name Description
account_id
string
Required

The ID of the target loyalty account.

Request Body
Name Description
idempotency_key
string
Required

A unique string that identifies this AdjustLoyaltyPoints request. Keys can be any valid string, but must be unique for every request.

Min Length 1 Max Length 128
adjust_points
LoyaltyEventAdjustPoints
Required

The points to add or subtract and the reason for the adjustment. To add points, specify a positive integer. To subtract points, specify a negative integer.
allow_negative_balance
boolean

Indicates whether to allow a negative adjustment to result in a negative balance. If true, a negative balance is allowed when subtracting points. If false, Square returns a BAD_REQUEST error when subtracting the specified number of points would result in a negative balance. The default value is false.

Response Fields
Name Description
errors
Error [ ]

Any errors that occurred during the request.
event
LoyaltyEvent

The resulting event data for the adjustment.

Examples

You are viewing an old version of the API
POST /v2/loyalty/accounts/{account_id}/adjust
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/loyalty/accounts/5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd/adjust \
  -X POST \
  -H 'Square-Version: 2023-01-19' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "adjust_points": {
      "points": 10,
      "reason": "Complimentary points"
    },
    "idempotency_key": "bc29a517-3dc9-450e-aa76-fae39ee849d1"
  }'
Response JSON 
{
  "event": {
    "id": "613a6fca-8d67-39d0-bad2-3b4bc45c8637",
    "type": "ADJUST_POINTS",
    "created_at": "2020-05-08T21:42:32Z",
    "adjust_points": {
      "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
      "points": 10,
      "reason": "Complimentary points"
    },
    "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
    "source": "LOYALTY_API"
  }
}