points_redemption/createdJSON
{
"id": 1234567,
"points_amount": 500,
"credits_amount": "0.0",
"reward_id": 789012,
"applied_at": "2025-04-25T15:08:36.223Z",
"name": "$5 off coupon",
"code": "BAL-abc123def456",
"expires_at": "2025-05-25T15:08:36.223Z",
"used_at": null,
"refunded_at": null,
"source": "points",
"referred_email": null,
"reward": {
"id": 789012,
"name": "$5 off coupon",
"enabled": true,
"points_amount": 500,
"points_type": "fixed",
"reward_type": "fixed_amount",
"source": "points",
"pretty_display_rewards": "$5 off coupon (500 points required)",
"icon_url": "https://cdn.example.com/icon.png",
"pretty_points_amount": "500",
"purchase_type": "both",
"recurring_cycle_limit": 3,
"terms_of_service": {
"reward_type": "fixed_amount",
"applies_to": "entire",
"expiry_months": 1,
"show_tos": true
},
"pretty_terms_of_service": "Expires 1 month(s) after being redeemed."
},
"customer": {
"id": 9876543210987,
"email": "[email protected] ",
"first_name": "John",
"last_name": "Doe",
"dob": null,
"accepts_marketing": false,
"orders_count": 0,
"verified_email": false,
"total_spent": 0,
"shopify_tags": [],
"loyalty_status": "member",
"points_tally": 27,
"credits_tally": "0.0",
"event_type": "points_redemption/created"
}
}
Field Type Description idInteger Unique ID of the redemption event points_amountInteger Points used for this reward credits_amountFloat Credit value used, if applicable reward_idInteger ID of the redeemed reward applied_atISO 8601 string When the reward was redeemed nameString Name of the reward codeString Reward code provided to the customer expires_atISO 8601 string Expiry date of the reward code used_atISO 8601 string or null Timestamp if the reward was used refunded_atISO 8601 string or null Timestamp if the reward was refunded sourceString Source of the redemption (points or credits) referred_emailString or null Email of referred user, if applicable rewardObject See Reward Object customerObject See Customer Object
Field Type Description idInteger Reward ID nameString Reward name enabledBoolean Whether the reward is currently enabled points_amountInteger Points required to redeem points_typeString Type of points requirement (e.g. fixed, multiplier) reward_typeString Type of reward (e.g. fixed_amount, free_product, percentage) sourceString Source of redemption (e.g. points) pretty_display_rewardsString Human-readable reward description icon_urlString (URL) URL of the reward icon (if applicable) pretty_points_amountString Human-readable points amount purchase_typeString Where the reward can be used (one-time, subscription, both) recurring_cycle_limitInteger or null Number of times it can be redeemed in a subscription cycle product_idString or null Shopify product ID (for free_product rewards) variant_idsString or null Comma-separated Shopify variant IDs (for free_product rewards) increment_points_valueInteger or null Step amount of points (for multiplier-type rewards) customer_points_getInteger or null Customer reward return per increment (for multiplier-type rewards) min_points_to_redeem_valueInteger or null Minimum points required to redeem (multiplier-type) max_points_to_spend_valueInteger or null Max points that can be used at once (multiplier-type) terms_of_serviceObject Terms of use (see Terms of Service) pretty_terms_of_serviceString Human-readable summary of the reward’s terms
Field Type Description reward_typeString Type of reward (e.g. fixed_amount, free_product, free_shipping) applies_toString or null Scope of discount application (e.g. entire, collection) expiry_monthsInteger or null Number of months before the discount expires product_idString or null Shopify product ID, for product-specific rewards show_tosBoolean Whether to show terms to the customer
Field Type Description idInteger Customer ID emailString Customer email address first_nameString Customer’s first name last_nameString Customer’s last name dobDate or null Customer’s date of birth, if provided accepts_marketingBoolean Shopify email subscriber status (true if opted in). orders_countInteger Total number of orders placed verified_emailBoolean Whether the customer’s email address is verified total_spentFloat Total amount the customer has spent shopify_tagsArray of strings List of Shopify tags associated with the customer loyalty_statusString Current loyalty program status (e.g. member) points_tallyInteger Current points balance credits_tallyFloat Current credit balance event_typeString Always points_redemption/created for this webhook
