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

OK

message

string | null

Message corresponding to the call.

Maximum length: 200

Example:

"Success"

data

object[]

Show child attributes

data.expiryDuration

integer

Expiry duration bracket, in number of days.

Example:

30

data.unRestrictedTotalPoints

number

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

Example:

100

data.restrictedTotalPoints

number

Total number of restricted points

Example:

12

data.totalPoints

number

Total number of points

Example:

112

data.pointValue

number

Total monetary value of all points

Example:

112

data.restrictedPoints

object[]

Show child attributes

data.restrictedPoints.points

number

Number of restricted points

Example:

12

data.restrictedPoints.restrictedLocation

string

Store or entity where the restricted points can be used

Example:

"demo_store"

data.expiryDate

string | null

Timestamp of points expiration (UTC format)

Example:

"2020-03-20T01:30:08.180856"

status

integer

Status of the call

Example:

200

errors

object

Error details, if any