HelixCustomReward

autoApproved

Type: boolean

Whether redemptions should be automatically approved.

backgroundColor

Type: string

The background color of the reward.

broadcasterDisplayName

Type: string

The display name of the broadcaster the reward belongs to.

broadcasterId

Type: string

The ID of the broadcaster the reward belongs to.

broadcasterName

Type: string

The name of the broadcaster the reward belongs to.

cooldownExpiryDate

Type: Date | null

Them time when the cooldown ends. null means there is currently no cooldown.

cost

Type: number

The channel points cost of the reward.

globalCooldown

Type: number | null

The cooldown between two redemptions of the reward, in seconds. null means no cooldown.

id

Type: string

The ID of the reward.

isEnabled

Type: boolean

Whether the reward is enabled (shown to users).

isInStock

Type: boolean

Whether the reward is currently in stock.

isPaused

Type: boolean

Whether the reward is paused. If true, users can't redeem it.

maxRedemptionsPerStream

Type: number | null

The maximum number of redemptions of the reward per stream. null means no limit.

maxRedemptionsPerUserPerStream

Type: number | null

The maximum number of redemptions of the reward per stream for each user. null means no limit.

prompt

Type: string

The prompt shown to users when redeeming the reward.

redemptionsThisStream

Type: number | null

How often the reward was already redeemed this stream.

Only available when the stream is live and maxRedemptionsPerStream is set. Otherwise, this is null.

title

Type: string

The title of the reward.

userInputRequired

Type: boolean

Whether the reward requires user input to be redeemed.

getBroadcaster()

Retrieves more information about the reward's broadcaster.

getImageUrl(scale)

Gets the URL of the image of the reward in the given scale.