v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Points Expiry Schedule

Retrieves the history of points expired schedules of a customer.

get/customers/{userId}/pointsExpirySchedule

Path parameters

userIdinteger required

Unique ID of the customer to fetch points expiry schedule history.

Headers

X-CAP-API-OAUTH-TOKENstring

Response

200

idinteger

segmentsobject

extendedFieldsobject

Example response

{
  "id": 28780933,
  "loyaltyInfo": {
    "loyaltyType": "loyalty"
  },
  "expirySchedules": [
    {
      "points": 400,
      "expiryDate": "2117-07-18",
      "programId": 1009,
      "pointsType": "bill_regular",
      "expiryType": "fixed"
    }
  ]
}