TwurpleAuthenticationGetting dataExamplesFAQMigration

GiftPaidUpgradeEvent

An event representing a gifted subscription being replaced by a paid one.

Overview

Properties

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

gifterDisplayName

Type: string

The display name of the user who sent the original gift.

gifterName

Type: string

The name of the user who sent the original gift.

messageObject

Type: UserNotice

The full object that contains all the message information.

userDisplayName

Type: string

The display name of the user who paid for their subscription.

userId

Type: string

The ID of the user who paid for their subscription.

userName

Type: string

The name of the user who paid for their subscription.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getGifter()

async

Gets more information about the user who sent the original gift.

Return type: HelixUser

getUser()

async

Gets more information about the user who paid for their subscription.

Return type: HelixUser