Options
All
  • Public
  • Public/Protected
  • All
Menu

@stigg/js-client-sdk - v2.24.3

Index

Enumerations

Classes

Interfaces

Type aliases

Type aliases

Addon

Addon: { billingId?: string | null; description: string; displayName: string; entitlements: PackageEntitlement[]; id: string; metadata?: Metadata | null; pricePoints: Price[]; pricingType?: PricingType | null }

Type declaration

  • Optional billingId?: string | null
  • description: string
  • displayName: string
  • entitlements: PackageEntitlement[]
  • id: string
  • Optional metadata?: Metadata | null
  • pricePoints: Price[]
  • Optional pricingType?: PricingType | null

ApplySubscription

ApplySubscription: { addons?: CheckoutAddon[]; billableFeatures?: BillableFeature[]; billingCountryCode?: string; billingId?: string; billingInformation?: Omit<SubscriptionBillingInfo, "taxPercentage">; billingPeriod?: BillingPeriod; metadata?: Metadata | null; paymentMethodId?: string; planId: string; promotionCode?: string; resourceId?: string; skipTrial?: boolean; startDate?: Date; unitQuantity?: number }

Type declaration

  • Optional addons?: CheckoutAddon[]
  • Optional billableFeatures?: BillableFeature[]
  • Optional billingCountryCode?: string
  • Optional billingId?: string
  • Optional billingInformation?: Omit<SubscriptionBillingInfo, "taxPercentage">
  • Optional billingPeriod?: BillingPeriod
  • Optional metadata?: Metadata | null
  • Optional paymentMethodId?: string
  • planId: string
  • Optional promotionCode?: string
  • Optional resourceId?: string
  • Optional skipTrial?: boolean
  • Optional startDate?: Date
  • Optional unitQuantity?: number

ApplySubscriptionResults

ApplySubscriptionResults: { subscription?: Subscription }

Type declaration

BaseEntitlement

BaseEntitlement: { accessDeniedReason?: AccessDeniedReason; feature?: EntitlementFeature; hasAccess: boolean; isFallback: boolean }

Type declaration

BasePlan

BasePlan: { displayName: string; id: string }

Type declaration

  • displayName: string
  • id: string

BillableFeature

BillableFeature: { featureId: string; quantity: number }

Type declaration

  • featureId: string
  • quantity: number

BillingAddress

BillingAddress: { city?: InputMaybe<Scalars["String"]>; country?: InputMaybe<Scalars["String"]>; line1?: InputMaybe<Scalars["String"]>; line2?: InputMaybe<Scalars["String"]>; postalCode?: InputMaybe<Scalars["String"]>; state?: InputMaybe<Scalars["String"]> }

Type declaration

  • Optional city?: InputMaybe<Scalars["String"]>
  • Optional country?: InputMaybe<Scalars["String"]>
  • Optional line1?: InputMaybe<Scalars["String"]>
  • Optional line2?: InputMaybe<Scalars["String"]>
  • Optional postalCode?: InputMaybe<Scalars["String"]>
  • Optional state?: InputMaybe<Scalars["String"]>

BooleanEntitlementFallback

BooleanEntitlementFallback: { hasAccess: boolean }

Type declaration

  • hasAccess: boolean

BooleanEntitlementOptions

BooleanEntitlementOptions: { fallback?: BooleanEntitlementFallback; shouldTrack?: boolean }

Type declaration

CheckoutAddon

CheckoutAddon: { addonId: string; quantity?: number }

Type declaration

  • addonId: string
  • Optional quantity?: number

CheckoutBillingIntegration

CheckoutBillingIntegration: { billingIdentifier: BillingVendorIdentifier; credentials: { accountId: string; publicKey: string } }

Type declaration

  • billingIdentifier: BillingVendorIdentifier
  • credentials: { accountId: string; publicKey: string }
    • accountId: string
    • publicKey: string

CheckoutConfiguration

CheckoutConfiguration: Omit<CheckoutConfigurationFragment, "__typename">

CheckoutStatePlan

CheckoutStatePlan: Plan & Pick<PlanFragment, "prices">

ClientConfiguration

ClientConfiguration: { apiKey: string; baseEdgeUri?: string; baseUri?: string; customerId?: string | null; customerToken?: string | null; enableEdge?: boolean; entitlementPollingInterval?: number; entitlementsFallback?: EntitlementsFallback; lazyLoad?: boolean; logConfiguration?: LogConfiguration; resourceId?: string | null; useEntitlementPolling?: boolean }

Type declaration

  • apiKey: string
  • Optional baseEdgeUri?: string
  • Optional baseUri?: string
  • Optional customerId?: string | null
  • Optional customerToken?: string | null
  • Optional enableEdge?: boolean
  • Optional entitlementPollingInterval?: number
  • Optional entitlementsFallback?: EntitlementsFallback
  • Optional lazyLoad?: boolean
  • Optional logConfiguration?: LogConfiguration
  • Optional resourceId?: string | null
  • Optional useEntitlementPolling?: boolean

Coupon

Coupon: { description?: string | null; discountValue: number; id: string; metadata?: Metadata | null; name: string }

Type declaration

  • Optional description?: string | null
  • discountValue: number
  • id: string
  • Optional metadata?: Metadata | null
  • name: string

Customer

Customer: { createdAt: Date; eligibleForTrial?: EligibleForTrial[] | null; email?: string; experimentInfo?: ExperimentInfo | null; hasPaymentMethod: boolean; id: string; metadata?: Metadata | null; name?: string; paymentMethodDetails?: PaymentMethodDetails; promotionalEntitlements: PromotionalEntitlement[]; subscriptions: Subscription[]; trialedPlans?: TrialedPlan[] | null; updatedAt: Date; getActivePromotionalEntitlements: any; getActiveSubscriptions: any; getActiveTrials: any }

Type declaration

CustomerPortal

CustomerPortal: { billingInformation: CustomerPortalBillingInformation; billingPortalUrl?: string | null; canUpgradeSubscription: boolean; configuration?: CustomerPortalConfiguration | null; entitlements: CustomerPortalEntitlement[]; promotionalEntitlements: CustomerPortalPromotionalEntitlement[]; resource: CustomerResource | null; showWatermark: boolean; subscriptions: CustomerPortalSubscription[] }

Type declaration

CustomerPortalBillingInformation

CustomerPortalBillingInformation: Omit<CustomerPortalBillingInformationFragment, "__typename">

CustomerPortalConfiguration

CustomerPortalConfiguration: Omit<CustomerPortalConfigurationFragment, "__typename">

CustomerPortalEntitlement

CustomerPortalEntitlement: Omit<CustomerPortalEntitlementFragment, "__typename">

CustomerPortalPromotionalEntitlement

CustomerPortalPromotionalEntitlement: Omit<CustomerPortalPromotionalEntitlementFragment, "__typename">

CustomerPortalSubscription

CustomerPortalSubscription: Omit<CustomerPortalSubscriptionFragment, "__typename">

CustomerPortalSubscriptionAddon

CustomerPortalSubscriptionAddon: Omit<CustomerPortalSubscriptionAddonFragment, "__typename">

CustomerPortalSubscriptionScheduledUpdateDataFragment

CustomerPortalSubscriptionScheduledUpdateDataFragment: { __typename?: "SubscriptionScheduledUpdate"; scheduleStatus: SubscriptionScheduleStatus; scheduleVariables?: { __typename?: "AddonChangeVariables"; addonRefId: string; newQuantity: number } | { __typename?: "BillingPeriodChangeVariables"; billingPeriod?: BillingPeriod | null } | { __typename?: "DowngradeChangeVariables"; addonRefIds?: string | null; billingPeriod?: BillingPeriod | null; downgradePlanRefId: string } | { __typename?: "UnitAmountChangeVariables"; featureId?: string | null; newUnitAmount?: number | null } | null; scheduledExecutionTime: any; subscriptionScheduleType: SubscriptionScheduleType; targetPackage?: { __typename?: "PackageDTO"; displayName: string; id: string; pricingType?: PricingType | null; refId: string } | null }

Type declaration

  • Optional __typename?: "SubscriptionScheduledUpdate"
  • scheduleStatus: SubscriptionScheduleStatus
  • Optional scheduleVariables?: { __typename?: "AddonChangeVariables"; addonRefId: string; newQuantity: number } | { __typename?: "BillingPeriodChangeVariables"; billingPeriod?: BillingPeriod | null } | { __typename?: "DowngradeChangeVariables"; addonRefIds?: string | null; billingPeriod?: BillingPeriod | null; downgradePlanRefId: string } | { __typename?: "UnitAmountChangeVariables"; featureId?: string | null; newUnitAmount?: number | null } | null
  • scheduledExecutionTime: any
  • subscriptionScheduleType: SubscriptionScheduleType
  • Optional targetPackage?: { __typename?: "PackageDTO"; displayName: string; id: string; pricingType?: PricingType | null; refId: string } | null

CustomerResource

CustomerResource: { id: string }

Type declaration

  • id: string

CustomerState

CustomerState: Omit<Customer, "getActiveSubscriptions" | "getActivePromotionalEntitlements" | "getActiveTrials">

DateRange

DateRange: { end?: Date; start?: Date }

Type declaration

  • Optional end?: Date
  • Optional start?: Date

DefaultTrialConfig

DefaultTrialConfig: { duration: number; units: TrialPeriodUnits }

Type declaration

EligibleForTrial

EligibleForTrial: { eligible: boolean; productId?: string | null }

Type declaration

  • eligible: boolean
  • Optional productId?: string | null

Entitlement

Entitlement: BooleanEntitlement | NumericEntitlement | MeteredEntitlement

EntitlementFeature

EntitlementFeature: { description?: string; displayName: string; featureType: FeatureType; id: string; isMetered?: boolean; metadata?: Record<string, string>; meterType?: Fluctuating | Incremental | None; units?: string; unitsPlural?: string }

Type declaration

  • Optional description?: string
  • displayName: string
  • featureType: FeatureType
  • id: string
  • Optional isMetered?: boolean
  • Optional metadata?: Record<string, string>
  • Optional meterType?: Fluctuating | Incremental | None
  • Optional units?: string
  • Optional unitsPlural?: string

EntitlementsFallback

EntitlementsFallback: {}

Type declaration

EstimateSubscription

EstimateSubscription: { addons?: SubscriptionEstimationAddon[]; billableFeatures?: BillableFeature[]; billingCountryCode?: string; billingInformation?: SubscriptionBillingInfo; billingPeriod?: BillingPeriod; customerId: string; planId: string; promotionCode?: string; resourceId?: string; skipTrial?: boolean; startDate?: Date; unitQuantity?: number }

Type declaration

  • Optional addons?: SubscriptionEstimationAddon[]
  • Optional billableFeatures?: BillableFeature[]
  • Optional billingCountryCode?: string
  • Optional billingInformation?: SubscriptionBillingInfo
  • Optional billingPeriod?: BillingPeriod
  • customerId: string
  • planId: string
  • Optional promotionCode?: string
  • Optional resourceId?: string
  • Optional skipTrial?: boolean
  • Optional startDate?: Date
  • Optional unitQuantity?: number

EstimateSubscriptionUpdate

EstimateSubscriptionUpdate: { addons?: SubscriptionEstimationAddon[]; billableFeatures?: BillableFeature[]; promotionCode?: string; subscriptionId: string; unitQuantity?: number }

Type declaration

ExperimentInfo

ExperimentInfo: { groupName: string; groupType?: ExperimentGroupType | null; id: string; name: string }

Type declaration

FetchUsageHistory

FetchUsageHistory: { customerId: string; endDate?: Date; featureId: string; resourceId?: string; startDate: Date }

Type declaration

  • customerId: string
  • Optional endDate?: Date
  • featureId: string
  • Optional resourceId?: string
  • startDate: Date

GetActiveSubscriptions

GetActiveSubscriptions: { resourceId?: string | string[] }

Type declaration

  • Optional resourceId?: string | string[]

GetBooleanEntitlement

GetBooleanEntitlement: { featureId: string; options?: BooleanEntitlementOptions; resourceId?: string }

Type declaration

GetCheckoutState

GetCheckoutState: { billingCountryCode?: string; planId: string; resourceId?: string | null }

Type declaration

  • Optional billingCountryCode?: string
  • planId: string
  • Optional resourceId?: string | null

GetCheckoutStateResults

GetCheckoutStateResults: { activeSubscription?: Subscription | null; billingIntegration: CheckoutBillingIntegration; configuration?: CheckoutConfiguration | null; customer: Customer; plan: CheckoutStatePlan; resource: CustomerResource | null; setupSecret: string }

Type declaration

GetCustomerPortal

GetCustomerPortal: { productId?: string; resourceId?: string }

Type declaration

  • Optional productId?: string
  • Optional resourceId?: string

GetMeteredEntitlement

GetMeteredEntitlement: { featureId: string; options?: MeteredEntitlementOptions; resourceId?: string }

Type declaration

GetNumericEntitlement

GetNumericEntitlement: { featureId: string; options?: NumericEntitlementOptions; resourceId?: string }

Type declaration

GetPaywall

GetPaywall: { billingCountryCode?: string; context?: WidgetType; productId?: string; resourceId?: string }

Type declaration

  • Optional billingCountryCode?: string
  • Optional context?: WidgetType
  • Optional productId?: string
  • Optional resourceId?: string

ImmediateSubscriptionPreviewInvoice

ImmediateSubscriptionPreviewInvoice: SubscriptionPreviewInvoice & { credits?: SubscriptionPreviewCredits; proration?: SubscriptionPreviewProration }

MeteredEntitlementFallback

MeteredEntitlementFallback: { hasAccess: boolean; isUnlimited?: boolean; usageLimit?: number }

Type declaration

  • hasAccess: boolean
  • Optional isUnlimited?: boolean
  • Optional usageLimit?: number

MeteredEntitlementOptions

MeteredEntitlementOptions: { fallback?: MeteredEntitlementFallback; requestedUsage?: number; shouldTrack?: boolean }

Type declaration

Money

Money: { amount: number; currency: string }

Type declaration

  • amount: number
  • currency: string

NumericEntitlementFallback

NumericEntitlementFallback: { hasAccess: boolean; isUnlimited?: boolean; value?: number }

Type declaration

  • hasAccess: boolean
  • Optional isUnlimited?: boolean
  • Optional value?: number

NumericEntitlementOptions

NumericEntitlementOptions: { fallback?: NumericEntitlementFallback; shouldTrack?: boolean }

Type declaration

PackageEntitlement

PackageEntitlement: { displayNameOverride?: PackageEntitlementFragment["displayNameOverride"]; feature?: EntitlementFeature; hasUnlimitedUsage?: boolean | null; hiddenFromWidgets?: PackageEntitlementFragment["hiddenFromWidgets"]; isCustom?: boolean; resetPeriod?: EntitlementResetPeriod | null; usageLimit: number }

Type declaration

  • Optional displayNameOverride?: PackageEntitlementFragment["displayNameOverride"]
  • Optional feature?: EntitlementFeature
  • Optional hasUnlimitedUsage?: boolean | null
  • Optional hiddenFromWidgets?: PackageEntitlementFragment["hiddenFromWidgets"]
  • Optional isCustom?: boolean
  • Optional resetPeriod?: EntitlementResetPeriod | null
  • usageLimit: number

PaymentMethodDetails

PaymentMethodDetails: { expirationMonth?: number | null; expirationYear?: number | null; last4Digits?: string | null }

Type declaration

  • Optional expirationMonth?: number | null
  • Optional expirationYear?: number | null
  • Optional last4Digits?: string | null

Paywall

Paywall: { activeSubscriptions: Subscription[] | null; configuration?: PaywallConfiguration | null; currency: PaywallCurrency; customer: Customer | null; paywallCalculatedPricePoints?: PaywallCalculatedPricePoint[] | null; plans: Plan[]; resource: CustomerResource | null }

Type declaration

PaywallCalculatedPricePoint

PaywallCalculatedPricePoint: Omit<PaywallCalculatedPricePointsFragment, "__typename">

PaywallConfiguration

PaywallConfiguration: Omit<PaywallConfigurationFragment, "__typename">

PaywallCurrency

PaywallCurrency: Omit<PaywallCurrencyFragment, "__typename">

Plan

Plan: { basePlan?: BasePlan; billingId?: string | null; compatibleAddons: Addon[]; defaultTrialConfig?: DefaultTrialConfig | null; description?: string | null; displayName: string; entitlements: PackageEntitlement[]; id: string; inheritedEntitlements: PackageEntitlement[]; metadata?: Metadata | null; order: number; pricePoints: Price[]; pricingType?: PricingType | null; product: Product }

Type declaration

PreviewSubscription

PreviewSubscription: { addons?: SubscriptionEstimationAddon[]; billableFeatures?: BillableFeature[]; billingCountryCode?: string; billingInformation?: SubscriptionBillingInfo; billingPeriod?: BillingPeriod; customerId: string; planId: string; promotionCode?: string; resourceId?: string; startDate?: Date; unitQuantity?: number }

Type declaration

Price

Price: { amount?: number | null; billingCountryCode?: string | null; billingId?: string | null; billingPeriod: BillingPeriod; currency: Currency; feature?: { displayName: string; featureId: string; unitQuantity?: number | null; units?: string | null; unitsPlural?: string | null } | null; isTieredPrice: boolean; maxUnitQuantity?: number | null; minUnitQuantity?: number | null; pricingModel: BillingModel; tiers?: PriceTierFragment[] | null; tiersMode: TiersMode | null | undefined }

Type declaration

  • Optional amount?: number | null
  • Optional billingCountryCode?: string | null
  • Optional billingId?: string | null
  • billingPeriod: BillingPeriod
  • currency: Currency
  • Optional feature?: { displayName: string; featureId: string; unitQuantity?: number | null; units?: string | null; unitsPlural?: string | null } | null
  • isTieredPrice: boolean
  • Optional maxUnitQuantity?: number | null
  • Optional minUnitQuantity?: number | null
  • pricingModel: BillingModel
  • Optional tiers?: PriceTierFragment[] | null
  • tiersMode: TiersMode | null | undefined

PriceTierFragment

PriceTierFragment: { __typename?: "PriceTier"; unitPrice: { __typename?: "Money"; amount: number; currency: Currency }; upTo: number }

Type declaration

  • Optional __typename?: "PriceTier"
  • unitPrice: { __typename?: "Money"; amount: number; currency: Currency }
    • Optional __typename?: "Money"
    • amount: number
    • currency: Currency
  • upTo: number

Product

Product: { description?: string | null; displayName?: string | null; id: string; metadata?: Metadata | null }

Type declaration

  • Optional description?: string | null
  • Optional displayName?: string | null
  • id: string
  • Optional metadata?: Metadata | null

PromotionalEntitlement

PromotionalEntitlement: { expiresAt?: Date; feature: EntitlementFeature; hasExpirationDate: boolean; hasUnlimitedUsage?: boolean | null; isVisible: boolean; status: PromotionalEntitlementStatus; usageLimit: number }

Type declaration

ResetSettings

ResetSettings: { nextResetDate: Date; resetPeriod: EntitlementResetPeriod }

Type declaration

Subscription

Subscription: { addons: SubscriptionAddon[]; billingId?: string; cancellationDate?: Date; crmId?: string; currentBillingPeriodEnd?: Date; effectiveEndDate?: Date; endDate?: Date; experimentInfo?: ExperimentInfo | null; futureUpdates: SubscriptionFutureUpdateDataFragment[]; id: string; latestInvoice?: SubscriptionInvoiceFragment; metadata?: Metadata | null; paymentCollection: PaymentCollection; plan: Plan; price: SubscriptionPrice | null; prices: Price[]; pricingType: PricingType; resourceId?: string; scheduledUpdates?: CustomerPortalSubscriptionScheduledUpdateDataFragment[]; startDate: Date; status: SubscriptionStatus; totalPrice: TotalPriceFragment | null | undefined; trialEndDate?: Date }

Type declaration

  • addons: SubscriptionAddon[]
  • Optional billingId?: string
  • Optional cancellationDate?: Date
  • Optional crmId?: string
  • Optional currentBillingPeriodEnd?: Date
  • Optional effectiveEndDate?: Date

    The calculated end date after which the subscription will be canceled, which takes trial expiration and scheduled cancellations into consideration

  • Optional endDate?: Date
  • Optional experimentInfo?: ExperimentInfo | null
  • futureUpdates: SubscriptionFutureUpdateDataFragment[]

    Future updates can be of 2 types {@link SubscriptionScheduleStatus.Scheduled} or {@link SubscriptionScheduleStatus.PendingPayment}

  • id: string
  • Optional latestInvoice?: SubscriptionInvoiceFragment
  • Optional metadata?: Metadata | null
  • paymentCollection: PaymentCollection
  • plan: Plan
  • price: SubscriptionPrice | null
    deprecated

    use prices instead with totalPrice

  • prices: Price[]
  • pricingType: PricingType
  • Optional resourceId?: string
  • Optional scheduledUpdates?: CustomerPortalSubscriptionScheduledUpdateDataFragment[]
    deprecated

    use futureUpdates instead with filter for {@link SubscriptionScheduleStatus.Scheduled}

  • startDate: Date
  • status: SubscriptionStatus
  • totalPrice: TotalPriceFragment | null | undefined
  • Optional trialEndDate?: Date

SubscriptionAddon

SubscriptionAddon: { addon: Addon; quantity: number }

Type declaration

  • addon: Addon
  • quantity: number

SubscriptionBillingInfo

SubscriptionBillingInfo: { billingAddress?: BillingAddress; taxPercentage?: number; taxRateIds?: string[] }

Type declaration

  • Optional billingAddress?: BillingAddress
  • Optional taxPercentage?: number
  • Optional taxRateIds?: string[]

SubscriptionEstimationAddon

SubscriptionEstimationAddon: { addonId: string; quantity?: number }

Type declaration

  • addonId: string
  • Optional quantity?: number

SubscriptionInvoiceFragment

SubscriptionInvoiceFragment: { __typename?: "SubscriptionInvoice"; billingId: string; createdAt: any; errorMessage?: string | null; paymentSecret?: string | null; paymentUrl?: string | null; requiresAction: boolean; status: SubscriptionInvoiceStatus; updatedAt: any }

Type declaration

  • Optional __typename?: "SubscriptionInvoice"
  • billingId: string
  • createdAt: any
  • Optional errorMessage?: string | null
  • Optional paymentSecret?: string | null
  • Optional paymentUrl?: string | null
  • requiresAction: boolean
  • status: SubscriptionInvoiceStatus
  • updatedAt: any

SubscriptionPreviewCredits

SubscriptionPreviewCredits: { initial: Money; remaining: Money; used: Money }

Type declaration

SubscriptionPreviewDiscount

SubscriptionPreviewDiscount: { durationInMonths?: number; durationType: DiscountDurationType; type: DiscountType; value: number }

Type declaration

SubscriptionPreviewInvoice

SubscriptionPreviewInvoice: { discount?: Money; discountDetails?: SubscriptionPreviewDiscount; subTotal: Money; tax?: Money; taxDetails?: SubscriptionPreviewTaxDetails; total: Money; totalExcludingTax: Money }

Type declaration

SubscriptionPreviewProration

SubscriptionPreviewProration: { credit: Money; debit: Money; hasProrations?: boolean; netAmount: Money; prorationDate: Date }

Type declaration

  • credit: Money
  • debit: Money
  • Optional hasProrations?: boolean
  • netAmount: Money
  • prorationDate: Date

SubscriptionPreviewTaxDetails

SubscriptionPreviewTaxDetails: { displayName: string; inclusive: boolean; percentage: number }

Type declaration

  • displayName: string
  • inclusive: boolean
  • percentage: number

SubscriptionPrice

SubscriptionPrice: Price & { grossAmount: number }

SubscriptionPricePreview

SubscriptionPricePreview: { discount?: SubscriptionPreviewDiscount; discountAmount?: Money; subTotal: Money; tax?: Money; taxDetails?: SubscriptionPreviewTaxDetails; total: Money; totalExcludingTax: Money }

Type declaration

TrialedPlan

TrialedPlan: { planId?: string | null; productId?: string | null }

Type declaration

  • Optional planId?: string | null
  • Optional productId?: string | null

TypographyConfiguration

TypographyConfiguration: Omit<TypographyConfigurationFragment, "__typename">

UsageHistoryPoint

UsageHistoryPoint: { date: Date; isResetPoint: boolean; value: number }

Type declaration

  • date: Date
  • isResetPoint: boolean
  • value: number

WaitForCheckoutCompleted

WaitForCheckoutCompleted: { refreshOnComplete?: boolean; timeoutMs?: number }

Type declaration

  • Optional refreshOnComplete?: boolean
  • Optional timeoutMs?: number

Generated using TypeDoc