helix/io.github.captnblubber.twitchkt.helix.model/CharityAmount

CharityAmount

@Serializable

data class CharityAmount(val value: Int, val decimalPlaces: Int, val currency: String)

Represents a monetary amount in a charity context.

Constructors

CharityAmount

constructor(value: Int, decimalPlaces: Int, currency: String)

Properties

currency

val currency: String

the ISO-4217 three-letter currency code that identifies the type of currency in value.

decimalPlaces

@SerialName(value = "decimal_places")

val decimalPlaces: Int

the number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula: value / 10^decimalPlaces.

value

val value: Int

the monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550.