Get Points to expire

Description

This service retrieves information about upcoming points expirations for the logged-in user's account within a specific mileage activity.

---

Request

Restrictions

This service requires an authenticated user and can only be called after a successful login.

Endpoint

GET https://<server-url>/api/v4/mileage/{activity_code}/account/pointsexpiration

Path Parameters

Parameter	Type	Description
activity_code	String	The unique code for the mileage activity (e.g., "activityMileagePoints").

Parameters

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.
token	Query / Header	The authentication token for the API session. Use Thalamus-Token for the header.
date	Query	Required. The reference date for calculating expirations, in yyyy-mm-dd format.

Full URL Example

https://<server-url>/api/v4/mileage/activityMileagePoints/account/pointsexpiration?date=2021-12-12&touchpoint=test&token=...

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

A JSON object is returned containing an array of pointsToExpireElements. Each element represents a batch of points and its corresponding expiration date.

Field	Type	Description
pointsToExpire	Number	The number of points that will expire.
expirationDate	Timestamp	The date on which the points will expire.

In addition, there are two extra fields associated with expiration using an annual cut-off date.

Field	Type	Desctiption
annualCutoffDate	Timestamp	The annual cut-off date
pointsToExpireAtCutoffDate	Number	The number of points that will expire at cut-off date.

JSON

{
    "pointsToExpireElements": [
        {
            "pointsToExpire": 15.0,
            "expirationDate": 1765594800000
        },
        {
            "pointsToExpire": 24.0,
            "expirationDate": 1765854000000
        },
        {
            "pointsToExpire": 438.0,
            "expirationDate": 1766199600000
        },
        {
            "pointsToExpire": 300.0,
            "expirationDate": 1766286000000
        },
        {
            "pointsToExpire": 750.0,
            "expirationDate": 1766372400000
        },
        {
            "pointsToExpire": 210.0,
            "expirationDate": 1766458800000
        },
        {
            "pointsToExpire": 342.0,
            "expirationDate": 1766804400000
        },
        {
            "pointsToExpire": 120.0,
            "expirationDate": 1766890800000
        },
        {
            "pointsToExpire": 90.0,
            "expirationDate": 1766977200000
        }
    ],
    "annualCutoffDate": 1767150000000,
    "pointsToExpireAtCutoffDate": 2289.0
}

❌ Unsuccessful Response: 404 Not Found

Returned if the specified activity_code does not exist.

JSON

{
  "errors": {
    "error.message": "NOT_FOUND"
  }
}