A benefit is a value granted automatically to a member when an earning rule’s conditions are met. It can serve as an alternative to earning points on a loyalty card or it can be used alongside points. Members don’t redeem benefits themselves; they simply receive one once they fulfill the conditions of the earning rule that references it. Benefits are optional and are only useful once connected to at least one earning rule.
Benefit types
A benefit must define exactly one type-specific configuration object that matches its type:
points: A fixed number of points added to a card.
points_proportional: Points calculated proportionally to a triggering value, such as order amount.
material: A physical product or SKU.
digital: A discount coupon or gift card.
Stock
Like rewards, benefits can be limited in quantity through a stock configuration. When omitted, a benefit defaults to UNLIMITED stock, meaning it can be granted as many times as its earning rule is triggered.
Referenced resources
A benefit references another resource, depending on its type. A points benefit references a card definition. A material benefit references a product or SKU. A digital benefit references a campaign, and the campaign type must match DISCOUNT_COUPONS or GIFT_VOUCHERS.
Create checks that the referenced resource exists. Creating an ACTIVE points benefit requires an ACTIVE card definition. Creating an ACTIVE digital benefit requires a campaign that is not DRAFT.
An update of a POINTS or POINTS_PROPORTIONAL benefit requires an ACTIVE card definition, whether the benefit is DRAFT or ACTIVE. An ACTIVE digital benefit cannot use a DRAFT campaign.
Activate benefit checks related resources before the status changes. A POINTS benefit requires an ACTIVE card definition. A digital benefit cannot reference a DRAFT campaign.
Lifecycle
A benefit is created as DRAFT unless status is set to ACTIVE. There is no INACTIVE status. Update does not change status. A DRAFT benefit becomes ACTIVE through Activate benefit.
While the benefit is DRAFT, name, type, the type-specific object, and stock can change. Once it is ACTIVE, an update may send only name, stock, points, points_proportional, and digital. On an ACTIVE benefit, points.card_definition_id, points_proportional.calculation_type, points_proportional.card_definition_id, digital.type, and digital.gift_vouchers.campaign_id cannot change. type and material are not accepted. digital cannot be sent for an ACTIVE discount-coupon benefit.
Delete benefit sets status to DELETED and returns that benefit. A benefit that any earning rule uses cannot be deleted until that reference is removed. List calls do not return a deleted benefit.
Last modified on November 18, 2026