points_redemption/created

Event Type

points_redemption/created

Webhook Payload

{
  "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"
  }
}

Payload Fields

Field	Type	Description
`id`	Integer	Unique ID of the redemption event
`points_amount`	Integer	Points used for this reward
`credits_amount`	Float	Credit value used, if applicable
`reward_id`	Integer	ID of the redeemed reward
`applied_at`	ISO 8601 string	When the reward was redeemed
`name`	String	Name of the reward
`code`	String	Reward code provided to the customer
`expires_at`	ISO 8601 string	Expiry date of the reward code
`used_at`	ISO 8601 string or null	Timestamp if the reward was used
`refunded_at`	ISO 8601 string or null	Timestamp if the reward was refunded
`source`	String	Source of the redemption (`points` or `credits`)
`referred_email`	String or null	Email of referred user, if applicable
`reward`	Object	See Reward Object
`customer`	Object	See Customer Object

Reward Object

Field	Type	Description
`id`	Integer	Reward ID
`name`	String	Reward name
`enabled`	Boolean	Whether the reward is currently enabled
`points_amount`	Integer	Points required to redeem
`points_type`	String	Type of points requirement (e.g. `fixed`, `multiplier`)
`reward_type`	String	Type of reward (e.g. `fixed_amount`, `free_product`, `percentage`)
`source`	String	Source of redemption (e.g. `points`)
`pretty_display_rewards`	String	Human-readable reward description
`icon_url`	String (URL)	URL of the reward icon (if applicable)
`pretty_points_amount`	String	Human-readable points amount
`purchase_type`	String	Where the reward can be used (`one-time`, `subscription`, `both`)
`recurring_cycle_limit`	Integer or null	Number of times it can be redeemed in a subscription cycle
`product_id`	String or null	Shopify product ID (for `free_product` rewards)
`variant_ids`	String or null	Comma-separated Shopify variant IDs (for `free_product` rewards)
`increment_points_value`	Integer or null	Step amount of points (for multiplier-type rewards)
`customer_points_get`	Integer or null	Customer reward return per increment (for multiplier-type rewards)
`min_points_to_redeem_value`	Integer or null	Minimum points required to redeem (multiplier-type)
`max_points_to_spend_value`	Integer or null	Max points that can be used at once (multiplier-type)
`terms_of_service`	Object	Terms of use (see Terms of Service)
`pretty_terms_of_service`	String	Human-readable summary of the reward’s terms

Terms of Service (inside reward)

Field	Type	Description
`reward_type`	String	Type of reward (e.g. `fixed_amount`, `free_product`, `free_shipping`)
`applies_to`	String or null	Scope of discount application (e.g. `entire`, `collection`)
`expiry_months`	Integer or null	Number of months before the discount expires
`product_id`	String or null	Shopify product ID, for product-specific rewards
`show_tos`	Boolean	Whether to show terms to the customer

Customer Object

Field	Type	Description
`id`	Integer	Customer ID
`email`	String	Customer email address
`first_name`	String	Customer’s first name
`last_name`	String	Customer’s last name
`dob`	Date or null	Customer’s date of birth, if provided
`accepts_marketing`	Boolean	Shopify email subscriber status (`true` if opted in).
`orders_count`	Integer	Total number of orders placed
`verified_email`	Boolean	Whether the customer’s email address is verified
`total_spent`	Float	Total amount the customer has spent
`shopify_tags`	Array of strings	List of Shopify tags associated with the customer
`loyalty_status`	String	Current loyalty program status (e.g. `member`)
`points_tally`	Integer	Current points balance
`credits_tally`	Float	Current credit balance
`event_type`	String	Always `points_redemption/created` for this webhook