Triggers
An earning rule reacts to one of three triggers:- Order paid: Triggered after an order is successfully paid and can calculate points proportionally to the order or item amounts.
- Custom event: Triggered when a selected custom event is sent to Voucherify.
- Segment entered: Triggered when a member enters a selected customer segment.
Conditions and earnings
Beyond the trigger itself, a rule can require that the member belongs to a specific loyalty tier, or that the triggering event meets additional criteria (for example, a minimum order amount). Each earning inside the rule then defines its effect, typically adding points to a point wallet, but an earning can also grant a benefit instead of points. A single rule can hold multiple earnings, evaluated in order, with the first matching one applied. Additionally, you can override the general point expiration settings set for a card definition by setting a custom expiration rules for the points earned by an earning rule.Trigger limits
Trigger limits control how often a rule is allowed to fire for the same member: A cooldown period between triggers, and/or a frequency cap over a time window. When omitted, a rule defaults to no cooldown and no frequency limit, meaning it can fire every time its trigger occurs.Lifecycle
An earning rule is created inDRAFT status unless status is specified explicitly. From there:
DRAFTorINACTIVE>ACTIVEwith the activate endpoint.ACTIVE>INACTIVEwith the deactivate endpoint.ACTIVE>DRAFTwith the draft endpoint.
DRAFT, only a some of its properties can still be changed, like name, earnings, error handling, validity hours, start/end dates, trigger limits, and metadata. However, trigger and condition definitions can’t be edited. Deleting a rule performs a soft delete and keeps its last state for reference. You can delete only an earning rule that’s not currently assigned to a program.
Assigning earning rules to a program
Earning rules are created independently of any program and connected through the Programs batch assignment endpoint. Unlike card definitions, earning rules can be assigned or unassigned while the program isACTIVE, as long as the program keeps at least one active earning rule.
Related resources
- Loyalty v2 API: Overview for the full Loyalty v2 API map.
- Programs overview for overall program management.
- Benefits overview for the benefit effect an earning can grant.
- Examine overview to simulate what an earning rule would grant before it fires.
- Reports overview for program and member earning-rule usage statistics.
- Create earning rules for the dashboard perspective on earning rules.