Skip to main content
A reward is an item in a program’s catalog, priced in one asset. The same catalog contains custom rewards and managed gift cards. Participants redeem either through the catalog-item redemption endpoint. Gift-card rewards include the supported values and currencies in fulfillment, plus any available images and descriptions in display. Use these fields to build your application’s selection screen. See Gift cards for pricing and redemption examples. Create and update custom rewards under /v1/programs/{programId}/rewards. Configure managed rewards through Reward sources and their product settings. Direct updates to managed rewards return 409 auto_managed_item. 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

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