Get Points Expiry Schedule

Retrieves the history of points expired schedules of a customer.

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/565039505/pointsExpirySchedule' \
--header 'Authorization: Basic c2FudC5wXzEyMzpiMmVhMGFhYWI1ZThmO5ZTAzNGE2NjA5NTIwM2FlNw==' \
--header 'Cookie: _cfuvid=uEUwrBAfGGgkRhH8C6wGyc6ShByhFRsEdpQj1e8WSGU-1750831646379-0.0.1.1-604800000'

Resource information

URIv2/customers/565039505/pointsExpirySchedule
HTTP methodGET
AuthenticationBasic
Pagination supportNo
Rate limitYes
Batch SupportNo

Response Parameter

FieldTypeDescription
idintegerThe unique identifier of the customer.
profilesarrayAn array of customer profiles (empty in the example).
loyaltyInfoobjectContains details about the customer's loyalty status.
loyaltyInfo.loyaltyTypestringThe type of loyalty program (e.g., "loyalty").
segmentsobjectCustomer segments (empty in the example).
extendedFieldsobjectAdditional custom fields (empty in the example).
expirySchedulesarrayAn array of objects describing the points expiry schedule.
expirySchedules[].pointsfloatThe number of points expiring.
expirySchedules[].expiryDatestringThe date when the points expire (format: YYYY-MM-DD).
expirySchedules[].programIdintegerThe ID of the loyalty program associated with the points.
expirySchedules[].pointsTypestringThe type of points (e.g., "customer_promotions").
expirySchedules[].expiryTypestringThe type of expiry (e.g., "fixed").
warningsarrayAny warnings related to the request (empty in the example).
{
    "id": 565039505,
    "profiles": [],
    "loyaltyInfo": {
        "loyaltyType": "loyalty"
    },
    "segments": {},
    "extendedFields": {},
    "expirySchedules": [
        {
            "points": 5140.0,
            "expiryDate": "2125-05-05",
            "programId": 973,
            "pointsType": "customer_promotions",
            "expiryType": "fixed"
        }
    ],
    "warnings": []
}

API specific Response

Error codeDescriptionReason
1218Customer not enrolled in loyalty program : customer not enrolled or no cps entryInvalid customer ID passed
8069Merged customer foundAPI request is made for a customer who has been merged
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!