Adjust Loyalty Points Request

Represents an AdjustLoyaltyPoints request.

Structure

AdjustLoyaltyPointsRequest

Name	Type	Tags	Description
`idempotencyKey`	`string`	Required	A unique string that identifies this `AdjustLoyaltyPoints` request. Keys can be any valid string, but must be unique for every request. Constraints: Minimum Length: `1`, Maximum Length: `128`
`adjustPoints`	`LoyaltyEventAdjustPoints`	Required	Provides metadata when the event `type` is `ADJUST_POINTS`.
`allowNegativeBalance`	`boolean \| undefined`	Optional	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`.

{
  "adjust_points": {
    "points": 10,
    "reason": "Complimentary points"
  },
  "idempotency_key": "bc29a517-3dc9-450e-aa76-fae39ee849d1"
}