This event is triggered when a customer set their birthday through your storefront or if the birthday date was manually updated in Yotpo Loyalty & Referrals
{
"topic": "swell/birthday/captured",
"name": "Swell Birthday Captured",
"email": "[email protected]",
"customer": {
"total_spend_cents": 2500,
"total_purchases": 1,
"perks_redeemed": 5,
"last_purchase_at": "2016-09-23T00:55:35.000Z",
"email": "[email protected]",
"referred_by": "[email protected]",
"points_earned": 450,
"points_balance": 450,
"points_expire_at": "2027-01-31T23:59:59.000Z",
"first_name": "John",
"last_name": "Smith",
"last_seen_at": "2016-09-23T00:55:35.000Z",
"third_party_id": "4055305025",
"birthday_month": 8,
"birth_day": 12,
"birth_year": ""
}
}customer.points_expire_at
customer.points_expire_atSample payloads above use "2027-01-31T23:59:59.000Z" when an expiration date applies (Last Activity or Date Earned policies); the field is null when your policy is Never expire.
The date when the customer's points are set to expire. The value depends on your store's Points expiration policy:
- Last Activity — Returns the calculated expiration date based on the customer's last activity.
- Date Earned — Returns the next upcoming expiration date across all point batches.
- Never expire — Returns
null.
For Date Earned policies, customers may have multiple point batches with different expiration dates; this field reflects only the closest upcoming expiration.
The same semantics apply to GET /v1/customers, GET /v2/customers, and GET /api/v2/customers (Fetch Customer Details and Fetch All Recently Updated Customers).