Loyalty API

CustomerRollingPointExpiration3

Information about the next batch of customer points scheduled to expire.

Properties

  • timetimerequired

    The date and time when the points will expire.

    This is the exact timestamp at which the points will expire. If points are about to expire, the loyalty UI can display a countdown or other notice to encourage customers to use their points before they're lost.

  • daydaterequired

    The date (without time) when the points will expire.

    This represents the calendar day when points will expire (or, rather, the last day when the points can still be used), without the time component. It's useful for date-based displays and calendar integrations where the specific time isn't needed, such as "Your points will expire on May 15th".

    This field is synchronized with the time field but provides a simpler date-only representation.

  • amountintegerrequired

    The number of points that will expire at the given time.

    This represents the total quantity of loyalty points that will expire at the specified time. This is useful for displaying messages like "Use your 500 points before they expire next week!"

Previous
CustomerReferralStats3