Prerequisites

Basic or OAuth credentials
Read access to Points access group resource

API endpoint example

https://eu.api.capillarytech.com/v2/customers/565039505/pointsExpirySchedule

curl --location 'https://eu.api.capillarytech.com/v2/customers/lookup/pointsExpirySchedule?source=INSTORE&identifierName=email&identifierValue=testgr10%40gmail.com&programId=983' \
--header 'Authorization: Basic bU2YQ==' \
--header 'Cookie: _cfuvid=6YGS7PapTDGsKc7JD9w_pnV5CKUsdzslUmxwoX0R9pY-1757168968223-0.0.1.1-604800000; _cfuvid=zYS0gwmsMVAj9DUolHoCbzD_Ta014xaIOdd9xXQS4h0-1758706722158-0.0.1.1-604800000'

Resource information

URI	v2/customers/565039505/pointsExpirySchedule
HTTP method	GET
Authentication	Basic
Pagination support	No
Rate limit	Yes
Batch Support	No

Example respons

{
    "id": 565039505,
    "profiles": [],
    "loyaltyInfo": {
        "loyaltyType": "loyalty"
    },
    "segments": {},
    "extendedFields": {},
    "expirySchedules": [
        {
            "points": 5140.0,
            "expiryDate": "2125-05-05",
            "expiryDateISO": "2125-05-05T00:00:00Z",
            "programId": 973,
            "pointsType": "customer_promotions",
            "expiryType": "fixed"
        }
    ],
    "warnings": []
}

Response Parameter

Field	Type	Description
id	integer	The unique identifier of the customer.
profiles	array	An array of customer profiles (empty in the example).
loyaltyInfo	object	Contains details about the customer's loyalty status.
loyaltyInfo.loyaltyType	string	The type of loyalty program (e.g., "loyalty").
segments	object	Customer segments (empty in the example).
extendedFields	object	Additional custom fields (empty in the example).
expirySchedules	array	An array of objects describing the points expiry schedule.
expirySchedules[].points	float	The number of points expiring.
expirySchedules[].expiryDate	string	The date when the points expire (format: YYYY-MM-DD).
expirySchedules[].programId	integer	The ID of the loyalty program associated with the points.
expirySchedules[].pointsType	string	The type of points (e.g., "customer_promotions").
expirySchedules[].expiryType	string	The type of expiry (e.g., "fixed").
warnings	array	Any warnings related to the request (empty in the example).

API specific Response

Error code	Description	Reason
1218	Customer not enrolled in loyalty program : customer not enrolled or no cps entry	Invalid customer ID passed
8069	Merged customer found	API request is made for a customer who has been merged