HelixCustomReward

Properties

• autoFulfill
• backgroundColor
• broadcasterDisplayName
• broadcasterId
• broadcasterName
• cooldownExpiryDate
• cost
• globalCooldown
• id
• isEnabled
• isInStock
• isPaused
• maxRedemptionsPerStream
• maxRedemptionsPerUserPerStream
• prompt
• redemptionsThisStream
• title
• userInputRequired

Methods

• getBroadcastera
• getImageUrl

Whether redemptions should automatically be marked as fulfilled.

The background color of the reward.

The display name of the broadcaster the reward belongs to.

The ID of the broadcaster the reward belongs to.

The name of the broadcaster the reward belongs to.

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

The channel points cost of the reward.

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

The ID of the reward.

Whether the reward is enabled (shown to users).

Whether the reward is currently in stock.

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

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

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

The prompt shown to users when redeeming the reward.

How often the reward was already redeemed this stream.

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

The title of the reward.

Whether the reward requires user input to be redeemed.

Gets more information about the reward's broadcaster.

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