Store Types

• PurchasableItemReference

  Defines an interface that represents a reference to a store item.

  Members

  • address string

    The address of the item.

  • cost number

    The expected cost of the item in the currency's smallest unit (cents, etc.).

  • currency string

    The currency that the item is priced in.

• StoreItem

  Defines an interface that represents a store item. That is, an item that can be purchased by a user to grant them a role.

  Members

  • cost number

    The cost of the item in the currency's smallest unit. (e.g. cents, pence, etc.) Must be an interger.

  • currency string

    The 3-letter ISO currency code that the item is priced in.

    See https://www.iso.org/iso-4217-currency-codes.html

  • description string

    The description of the item.

  • imageUrls string[]

    The list of image URLs that represent the item.

  • markers string[]

    The markers that are associated with the item.

  • name string

    The name of the item.

  • roleGrantTimeMs number

    The amount of time in miliseconds that the role is granted for after purchase. If null, then the role is granted forever.

  • roleName string

    The name of the role that the item grants.

  • taxCode? string

    The tax code for the item. Currently only stripe tax codes are supported.

    See https://docs.stripe.com/tax/tax-codes