SubEvent

Properties

• broadcasterId
• broadcasterName
• giftRedeemedMonth
• isPrime
• message
• messageObject
• months
• originalGiftDuration
• originalGifterDisplayName
• originalGifterId
• originalGifterName
• plan
• planName
• streak
• userDisplayName
• userId
• userName
• wasAnonymousGift
• wasGift

Methods

• getBroadcastera
• getOriginalGiftera
• getUsera

The ID of the broadcaster.

The name of the broadcaster.

The number of the month out of the total gift duration that was just redeemed, or null if the subscription is not a continuation of a multi-month subscription.

Whether the subscription was "paid" for using Prime Gaming.

The message sent with the subscription, or null if there is none.

The full object that contains all the message information.

The number of total months of subscriptions for the channel.

The total duration of the current multi-month subscription, or null if the subscription is not a continuation of a multi-month subscription.

The display name of the user who originally gifted the current multi-month subscription, or null if they were anonymous or the subscription is not a continuation of a multi-month subscription.

The ID of the user who originally gifted the current multi-month subscription, or null if they were anonymous or the subscription is not a continuation of a multi-month subscription.

The name of the user who originally gifted the current multi-month subscription, or null if they were anonymous or the subscription is not a continuation of a multi-month subscription.

The plan of the subscription.

The display name of the plan of the subscription.

The number of consecutive months of subscriptions for the channel, or null if the user resubscribing does not choose to share that information.

The display name of the user subscribing to the channel.

The ID of the user subscribing to the channel.

The name of the user subscribing to the channel.

Whether the announced subscription is a continuation of a previously anonymously gifter multi-month subscription.

Whether the announced subscription is a continuation of a previously gifted multi-month subscription.

Gets more information about the broadcaster.

Gets more information about the user who originally gifted the current multi-month subscription, or null if they were anonymous or the subscription is not a continuation of a multi-month subscription.

Gets more information about the user subscribing to the channel.