v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01934981.1 MB

Examine

Examine earning rules

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Estimates earning opportunities for a customer without triggering any actual earning. The trigger selects whether all trigger events or one specific event is examined. When a specific event is selected, exactly one matching context object is required: customer_order_paid for customer.order.paid, customer_segment_entered for customer.segment.entered, and customer_custom_event for customer.custom_event (the other context objects must not be present).

post/v2/loyalties/examine/earning-rules

Request body

Response

Earning rules examination result

eventstring

Examined trigger event (e.g. customer.order.paid, customer.segment.entered, customer.custom_event).

object'earnings_examine_result'

Object type marker. Always earnings_examine_result.