Skip to main content
A reward is a catalog item priced in a specific asset. Rewards can be UNIT_BASED (fixed cost per unit with optional inventory caps via max_total and max_per_participant) or AMOUNT_BASED (variable amount without unit inventory limits). Participants redeem rewards through the redemptions endpoints. Rewards are scoped to a program. All endpoints are under /v1/programs/{programId}/rewards. Rewards use four statuses: DRAFT, ACTIVE, OUT_OF_STOCK, and ARCHIVED. The available_from and available_until fields bound when an ACTIVE reward can be redeemed. OUT_OF_STOCK is a live state. Inventory caps move an ACTIVE reward there when committed inventory reaches max_total, and releasing or reversing that inventory returns it to ACTIVE.

​
Endpoints

  • Create, list, get, and update rewards within a program
  • Set unit_cost, inventory caps, and availability windows (available_from, available_until)
  • Change reward status between DRAFT, ACTIVE, OUT_OF_STOCK, and ARCHIVED
For usage patterns and examples, see the Rewards Catalog guide.