Documentation/detritus-client/Structures

SubscriptionPlanclass

Subscription Plan, used in [[Gift]]

On this page

Overview
Constructor1
Properties9
Accessors2
Methods13

Subscription Plan, used in [[Gift]]

import { Structures } from 'detritus-client';

Structures.SubscriptionPlan;

Hierarchy

StructureBaseStructureSubscriptionPlan

8 properties1 method15 inheritedsrc/structures/gift.ts:154

Constructor

new SubscriptionPlan

src/structures/gift.ts:166

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

Properties

client

ShardClient

readonly

Inherited from BaseStructure.client

currency

string

Default 'usd'

string

Default ''

interval

number

Default 0

intervalCount

number

Default 0

name

string

Default ''

price

number

Default 0

skuId

string

Default ''

taxInclusive

boolean

Default false

Accessors

isClone

boolean

get

Inherited from BaseStructure.isClone

shardId

number

get

Inherited from BaseStructure.shardId

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/gift.ts:171

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