Preview environment

class Subscription

extends

Base
export class Subscription extends Base

Represents a Subscription

readonly
canceledAt : Date | null

The time the subscription was canceled

canceledTimestamp : number | null

The timestamp of when the subscription was canceled

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

country : string | null

ISO 3166-1 alpha-2 country code of the payment source used to purchase the subscription. Missing unless queried with a private OAuth scope.

readonly
currentPeriodEndAt : Date

The time the current subscription period will end at

currentPeriodEndTimestamp : number

The timestamp the current subscription period will end at

readonly
currentPeriodStartAt : Date

The time the current subscription period will start at

currentPeriodStartTimestamp : number

The timestamp the current subscription period will start at

entitlementIds : Snowflake[]

The entitlement ids granted for this subscription

id : Snowflake

The id of the subscription

renewalSkuIds : Snowflake[] | null

The SKU ids that this user will be subscribed to at renewal

skuIds : Snowflake[]

The SKU ids subscribed to

status : SubscriptionStatus

The current status of the subscription

userId : Snowflake

The id of the user who subscribed

toJSON(
...props: Record<string, boolean | string>[]
) : unknown

Inherited from: Base

valueOf() : string

Inherited from: Base