Documentation/detritus-client/Structures

Subscriptionclass

Subscription Structure

On this page

Overview
Constructor1
Properties11
Accessors9
Methods13

Subscription Structure

import { Structures } from 'detritus-client';

Structures.Subscription;

Hierarchy

StructureBaseStructureSubscription

17 properties1 method15 inheritedsrc/structures/subscription.ts:35

Constructor

new Subscription

src/structures/subscription.ts:50

new Subscription(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

canceledAtUnix

number

Default 0

client

ShardClient

readonly

Inherited from BaseStructure.client

country?

string

optional

currentPeriodEndUnix

number

Default 0

currentPeriodStartUnix

number

Default 0

entitlementIds

string[]

Default []

string

Default ''

renewalSkuIds

string[] | null

Default null

skuIds

string[]

Default []

status

SubscriptionStatusTypes

Default SubscriptionStatusTypes.ACTIVE

userId

string

Default ''

Accessors

canceledAt

Date | null

get

createdAt

Date

get

createdAtUnix

number

get

currentPeriodEnd

Date

get

currentPeriodStart

Date

get

isActive

boolean

get

isClone

boolean

get

Inherited from BaseStructure.isClone

shardId

number

get

Inherited from BaseStructure.shardId

user

User | null

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/subscription.ts:86

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON