kord-core/dev.kord.core.entity.monetization/Subscription

Subscription

class Subscription(val data: SubscriptionData, val kord: Kord) : KordEntity(source)

An instance of a Subscription.

Subscriptions represent a User making recurring payments for at least one Sku over an ongoing period. Successful payments grant the User access to Entitlements associated with the Sku.

Constructors

Subscription

constructor(data: SubscriptionData, kord: Kord)

Properties

canceledAt

val canceledAt: Instant?

When this subscription was canceled.

country

val country: String?

The ISO3166-1 alpha-2 country code of the payment source used to purchase this subscription.

currentPeriodEnd

val currentPeriodEnd: Instant

The end date of the current subscription period.

currentPeriodStart

val currentPeriodStart: Instant

The start date of the current subscription period.

data

val data: SubscriptionData

entitlementIds

val entitlementIds: List<Snowflake>

The list of IDs of the Entitlements granted for this subscription.

open override val id: Snowflake

The unique identifier of this entity.

kord

open override val kord: Kord

The kord instance that created this object.

skuIds

val skuIds: List<Snowflake>

The list of IDs of the Skus subscribed to.

skus

val skus: List<SkuBehavior>

The list of behaviors of the Skus subscribed to.

startsAt

val startsAt: Instant

The start date of this subscription.

status

val status: SubscriptionStatus

The current status of this subscription.

user

val user: UserBehavior

The behavior of the User who is subscribed.

userId

val userId: Snowflake

The ID of the User who is subscribed.

Functions

compareTo

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String