TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixExtensionTransaction

A bits transaction made inside an extension.

Overview

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster that runs the extension on their channel.

broadcasterId

Type: string

The ID of the broadcaster that runs the extension on their channel.

broadcasterName

Type: string

The name of the broadcaster that runs the extension on their channel.

id

Type: string

The ID of the transaction.

productCost

Type: number

The cost of the product, in bits.

productDisplayName

Type: string

The display name of the product.

productInDevelopment

Type: boolean

Whether the product is in development.

productSku

Type: string

The product SKU.

productType

Value: "BITS_IN_EXTENSION"

The product type. Currently always BITS_IN_EXTENSION.

transactionDate

Type: Date

The time when the transaction was made.

userDisplayName

Type: string

The display name of the user that made the transaction.

userId

Type: string

The ID of the user that made the transaction.

userName

Type: string

The name of the user that made the transaction.

Methods

getBroadcaster()

async

Gets information about the broadcaster that runs the extension on their channel.

Return type: HelixUser

getUser()

async

Gets information about the user that made the transaction.

Return type: HelixUser