Benefit types
A benefit must define exactly one type-specific configuration object that matches itstype:
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 astock 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
Depending on its type, a benefit references other resources: A card definition for points-based benefits, or a product/SKU/campaign for material and digital benefits. These references are validated on create and update; for example, a points-based benefit can only be activated if its connected card definition is itselfACTIVE.
Lifecycle
A benefit is created inDRAFT status by default, and only moves between DRAFT and ACTIVE through the activate and draft endpoints. There is no INACTIVE state. While in DRAFT, every property can be updated; once ACTIVE, only name and stock can still be changed.
Two safeguards protect benefits that are already wired into your program:
- A benefit that’s referenced by any earning rule can’t be deleted until that reference is removed.
- A benefit connected to an active earning rule can’t be moved back to
DRAFT.
Related resources
- Loyalty v2 API: Overview for the full Loyalty v2 API map.
- Earning Rules overview for how benefits are triggered.
- Rewards overview for the point-redeemable counterpart to benefits.
- Create benefits for the dashboard perspective on configuring benefits.

