Skip to main content
GET
Get reward
Returns the reward, including current inventory. On UNIT_BASED rewards, committed_units is inventory in use, pending_units is awaiting fulfillment, and delivered_units is captured. On AMOUNT_BASED rewards, all three are null. For gift cards, fulfillment contains the supported card values, currencies, and pricing details. Optional display content provides images and descriptions. Use the returned reward to show and redeem a gift card.
For usage patterns and examples, see the Rewards Catalog guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

programId
string<uuid>
required

Program ID

rewardId
string<uuid>
required

Reward ID

Response

Reward details

A reward with its pricing, inventory, availability, and metadata

asset_id
string<uuid>

Asset used to price this reward

Example:

"550e8400-e29b-41d4-a716-446655440002"

auto_managed
boolean

Whether the catalog sync manages this item's lifecycle automatically

Example:

false

available_from
string<date-time>

Start of the availability window (RFC 3339, null if always available)

Example:

"2024-01-01T00:00:00Z"

available_until
string<date-time>

End of the availability window (RFC 3339, null if no end date)

Example:

"2024-12-31T23:59:59Z"

category
string

Grouping label for organizing rewards in the catalog

Example:

"Gift Cards"

committed_units
integer | null

UNIT_BASED units currently consuming inventory. Includes delivered and pending units. Null for AMOUNT_BASED rewards.

Example:

42

created_at
string<date-time>

When this reward was created (RFC 3339)

Example:

"2024-01-15T10:30:00Z"

delivered_units
integer | null

UNIT_BASED units whose redemption has been captured. Null for AMOUNT_BASED rewards.

Example:

39

description
string

Details about the reward

Example:

"Redeemable for a $10 gift card"

display
object

Product content for displaying a managed reward

face_currency
string

ISO 4217 currency of the face value (PROVIDER items only)

Example:

"USD"

face_value_minor
integer

Pinned face value in minor units (fixed-denomination PROVIDER items only)

Example:

1000

fulfillment
object

Supported values, currencies, delivery, and pricing for managed rewards

fulfillment_product_id
string<uuid>

Product ordered when this reward is redeemed. Present for managed rewards (kind PROVIDER).

Example:

"550e8400-e29b-41d4-a716-446655440004"

id
string<uuid>

Unique identifier for this reward

Example:

"550e8400-e29b-41d4-a716-446655440000"

kind
string

Whether you created the reward directly (CUSTOM) or Scrip manages it through a reward source (PROVIDER)

Example:

"CUSTOM"

max_per_participant
integer | null

Per-participant redemption limit (UNIT_BASED only, null = unlimited)

Example:

2

max_total
integer | null

Global inventory limit (UNIT_BASED only, null = unlimited)

Example:

100

metadata
object

Custom key-value data attached to this reward

name
string

Display name for this reward

Example:

"$10 Gift Card"

pending_units
integer | null

UNIT_BASED units awaiting fulfillment. Null for AMOUNT_BASED rewards.

Example:

3

program_id
string<uuid>

Program this reward belongs to

Example:

"550e8400-e29b-41d4-a716-446655440001"

redemption_type
string

How the reward is redeemed: UNIT_BASED (discrete quantities) or AMOUNT_BASED (variable amounts)

Example:

"UNIT_BASED"

reward_source_id
string<uuid>

Reward source that supplies this managed reward

Example:

"550e8400-e29b-41d4-a716-446655440003"

status
string

Lifecycle status: DRAFT, ACTIVE, OUT_OF_STOCK, or ARCHIVED

Example:

"ACTIVE"

unit_cost
string

Fixed price per unit. For variable-value managed rewards, use fulfillment.rate to calculate the charge.

Example:

"1000.00"

updated_at
string<date-time>

When this reward was last modified (RFC 3339)

Example:

"2024-01-15T10:30:00Z"