Get Points to be Expired

Gets all points that will expire within a year starting at 30 days, 60 days, and up to one year.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

profileId

integer

Profile ID. It is generated in the response of the Enroll Member endpoint - POST /v1/members.

Response

200 - application/json

data

object[]

Show child attributes

data.expiryDate

string | null

Timestamp of points expiration (UTC format)

data.expiryDuration

integer

Expiry duration bracket, in number of days.

data.pointValue

number

Total monetary value of all points

data.restrictedPoints

object[]

Show child attributes

data.restrictedPoints.points

number

Number of restricted points

data.restrictedPoints.restrictedLocation

string

Store or entity where the restricted points can be used

data.restrictedTotalPoints

number

Total number of restricted points

data.totalPoints

number

Total number of points

data.unRestrictedTotalPoints

number

Total number of unrestricted points (base + promotional + bonus).

errors

object

Error details, if any

message

string | null

Message corresponding to the call.

Maximum length: 200

status

integer

Status of the call