Skip to main content
POST
Get Expiry Schedule
Returns the points expiry schedule for a member broken down by period (e.g. quarterly), showing how many points will expire at each upcoming date. Use this to surface expiry warnings in your loyalty portal — “X points expire on Dec 31” — which is one of the most effective nudges for driving redemption activity. The Year parameter lets you fetch future schedules for proactive campaign planning.

Responses

Authorizations

Authorization
string
header
required

JWT obtained from Generate Auth Token. Pass as Authorization: bearer {token}.

Body

application/json
RelationReference
string
required
Example:

"jane.doe@example.com"

RelationType
integer
required
Example:

4

ProgramId
integer
required
Example:

19

TransactionCurrency
string
required
Example:

"DEFAULT"

Year
integer
required

Year for the expiry schedule

Example:

2026

Response

200 - application/json

Expiry schedule

results
object