Class APIPremium

Index

Constructors

Methods

adjustCustomerBalance cancelSubscription changePaymentMethods changePremiumData changeSubscriptionAddons changeSubscriptionTier createCheckoutSession getAllUserSubscriptions getPremiumPlan getPremiumPlans getPremumData getSupportPremiumGuild getSupportPremiumGuilds syncStripeSubscriptions syncSupportRoles syncSupportRolesFor

Constructors

constructor

new APIPremium(web): APIPremium
Parameters
- web: WebDataManager
Returns APIPremium
- Defined in src/classes/premium.ts:8

Methods

adjustCustomerBalance

adjustCustomerBalance(__namedParameters): Promise<WebResponse<AdjustCustomerBalanceResponse>>
Parameters
- __namedParameters: {
  auth: string;
  body: AdjustCustomerBalanceBody;
  }
  - auth: string
  - body: AdjustCustomerBalanceBody
Returns Promise<WebResponse<AdjustCustomerBalanceResponse>>
- Defined in src/classes/premium.ts:97

cancelSubscription

cancelSubscription(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
      auth: string;
      immediately?: boolean;
      subscriptionId: string;
  }
  - auth: string
  - Optionalimmediately?: boolean
  - subscriptionId: string
Returns Promise<WebResponse<string>>
- Defined in src/classes/premium.ts:81

changePaymentMethods

changePaymentMethods(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<string>>
- Defined in src/classes/premium.ts:60

changePremiumData

changePremiumData<T>(__namedParameters): Promise<WebResponse<true>>
Type Parameters
- T extends "user" | "guild" = never
Parameters
- __namedParameters: {
      auth: string;
      body: UpdatePremiumData<T>;
      id: string;
      type: T;
  }
  - auth: string
  - body: UpdatePremiumData<T>
  - id: string
  - type: T
Returns Promise<WebResponse<true>>
- Defined in src/classes/premium.ts:18

changeSubscriptionAddons

changeSubscriptionAddons(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
  auth: string;
  body: ChangeSubscriptionAddonsBody;
  }
  - auth: string
  - body: ChangeSubscriptionAddonsBody
Returns Promise<WebResponse<string>>
- Defined in src/classes/premium.ts:74

changeSubscriptionTier

changeSubscriptionTier(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
  auth: string;
  body: ChangeSubscriptionTierBody;
  }
  - auth: string
  - body: ChangeSubscriptionTierBody
Returns Promise<WebResponse<string>>
- Defined in src/classes/premium.ts:67

createCheckoutSession

createCheckoutSession<T>(__namedParameters): Promise<WebResponse<string>>
Type Parameters
- T extends "user" | "guild"
Parameters
- __namedParameters: {
      auth: string;
      body: CreateCheckoutSessionBody<T>;
      type: T;
  }
  - auth: string
  - body: CreateCheckoutSessionBody<T>
  - type: T
Returns Promise<WebResponse<string>>
- Defined in src/classes/premium.ts:44

getAllUserSubscriptions

getAllUserSubscriptions(__namedParameters): Promise<WebResponse<AllSubscriptions>>
Parameters
- __namedParameters: {
  auth: string;
  force?: boolean;
  }
  - auth: string
  - Optionalforce?: boolean
Returns Promise<WebResponse<AllSubscriptions>>
- Defined in src/classes/premium.ts:51

getPremiumPlan

getPremiumPlan<T>(__namedParameters): Promise<WebResponse<PremiumPlan<T>>>
Type Parameters
- T extends boolean
Parameters
- __namedParameters: {
  includeFreeAmountOfAddons?: T;
  planId: string;
  }
  - OptionalincludeFreeAmountOfAddons?: T
  - planId: string
Returns Promise<WebResponse<PremiumPlan<T>>>
- Defined in src/classes/premium.ts:35

getPremiumPlans

getPremiumPlans(__namedParameters): Promise<WebResponse<PremiumPlans>>
Parameters
- __namedParameters: {
  includeUnreleased?: boolean;
  refreshCache?: boolean;
  }
  - OptionalincludeUnreleased?: boolean
    Include everything, not just what a customer should see: disabled tiers, inactive addons, features still launch-gated to 'off'/'beta', and rows flagged showOnPricing: false. For admin views; leave unset for the public pricing page.
  - OptionalrefreshCache?: boolean
    Deprecated
    Misnomer kept for compatibility - it maps to the API's all flag and refreshes no cache. Use includeUnreleased.
Returns Promise<WebResponse<PremiumPlans>>
- Defined in src/classes/premium.ts:25

getPremumData

getPremumData<T>(__namedParameters): Promise<WebResponse<PremiumData<T>>>
Type Parameters
- T extends "user" | "guild" = never
Parameters
- __namedParameters: {
      auth: string;
      id: string;
      type: T;
  }
  - auth: string
  - id: string
  - type: T
Returns Promise<WebResponse<PremiumData<T>>>
- Defined in src/classes/premium.ts:11

getSupportPremiumGuild

getSupportPremiumGuild(__namedParameters): Promise<WebResponse<SupportPremiumGuild>>
Parameters
- __namedParameters: {
  auth: string;
  guildId: string;
  }
  - auth: string
  - guildId: string
Returns Promise<WebResponse<SupportPremiumGuild>>
- Defined in src/classes/premium.ts:133

getSupportPremiumGuilds

getSupportPremiumGuilds(__namedParameters): Promise<WebResponse<SupportPremiumGuilds>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<SupportPremiumGuilds>>
- Defined in src/classes/premium.ts:126

syncStripeSubscriptions

syncStripeSubscriptions(__namedParameters): Promise<WebResponse<SyncSubscriptionsResponse>>
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<SyncSubscriptionsResponse>>
- Defined in src/classes/premium.ts:90

syncSupportRoles

syncSupportRoles(__namedParameters): Promise<WebResponse<SyncSupportRolesData>>
Reconcile the logged-in user's premium roles in the support server to match their entitlements (user premium + active guild subscriptions). Session-authenticated: auth is the session token.
Parameters
- __namedParameters: {
  auth: string;
  }
  - auth: string
Returns Promise<WebResponse<SyncSupportRolesData>>
- Defined in src/classes/premium.ts:108

syncSupportRolesFor

syncSupportRolesFor(__namedParameters): Promise<WebResponse<SyncSupportRolesResult>>
Backend/support-bot variant: sync an arbitrary user's premium roles in the support server. Authenticated with the shared backend secret — pass auth as 'Bearer ' + NOTI_BACKEND_SECRET.
Parameters
- __namedParameters: {
  auth: string;
  discordId: string;
  }
  - auth: string
  - discordId: string
Returns Promise<WebResponse<SyncSupportRolesResult>>
- Defined in src/classes/premium.ts:119

Class APIPremium

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns APIPremium

Methods

adjustCustomerBalance

Parameters

auth: string

body: AdjustCustomerBalanceBody

Returns Promise<WebResponse<AdjustCustomerBalanceResponse>>

cancelSubscription

Parameters

auth: string

Optionalimmediately?: boolean

subscriptionId: string

Returns Promise<WebResponse<string>>

changePaymentMethods

Parameters

auth: string

Returns Promise<WebResponse<string>>

changePremiumData

Type Parameters

Parameters

auth: string

body: UpdatePremiumData<T>

id: string

type: T

Returns Promise<WebResponse<true>>

changeSubscriptionAddons

Parameters

auth: string

body: ChangeSubscriptionAddonsBody

Returns Promise<WebResponse<string>>

changeSubscriptionTier

Parameters

auth: string

body: ChangeSubscriptionTierBody

Returns Promise<WebResponse<string>>

createCheckoutSession

Type Parameters

Parameters

auth: string

body: CreateCheckoutSessionBody<T>

type: T

Returns Promise<WebResponse<string>>

getAllUserSubscriptions

Parameters

auth: string

Optionalforce?: boolean

Returns Promise<WebResponse<AllSubscriptions>>

getPremiumPlan

Type Parameters

Parameters

OptionalincludeFreeAmountOfAddons?: T

planId: string

Returns Promise<WebResponse<PremiumPlan<T>>>

getPremiumPlans

Parameters

OptionalincludeUnreleased?: boolean

OptionalrefreshCache?: boolean

Deprecated

Returns Promise<WebResponse<PremiumPlans>>

getPremumData

Type Parameters

Parameters

auth: string

id: string

type: T

Returns Promise<WebResponse<PremiumData<T>>>

getSupportPremiumGuild

Parameters

auth: string

guildId: string

Returns Promise<WebResponse<SupportPremiumGuild>>

getSupportPremiumGuilds

Parameters

`Optional`immediately?: boolean

`Optional`force?: boolean

`Optional`includeFreeAmountOfAddons?: T

`Optional`includeUnreleased?: boolean

`Optional`refreshCache?: boolean