TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixSubscription

A (paid) subscription of a user to a broadcaster.

Overview

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The user ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

gifterDisplayName

Type: string | null

The display name of the gifter.

gifterId

Type: string | null

The user ID of the gifter.

gifterName

Type: string | null

The name of the gifter.

isGift

Type: boolean

Whether the subscription has been gifted by another user.

tier

Type: string

The tier of the subscription.

userDisplayName

Type: string

The display name of the subscribed user.

userId

Type: string

The user ID of the subscribed user.

userName

Type: string

The name of the subscribed user.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getGifter()

async

Gets more information about the gifter.

Return type: HelixUser | null

getUser()

async

Gets more information about the subscribed user.

Return type: HelixUser