Options
All
  • Public
  • Public/Protected
  • All
Menu

@stigg/node-server-sdk - v1.5.0

Index

Enumerations

Classes

Interfaces

Type aliases

Type aliases

Addon

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

Type declaration

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

Address

Address: { addressLine1?: string; addressLine2?: string; city?: string; country?: string; phoneNumber?: string; postalCode?: string; state?: string }
param country

optional country of the address - in a valid ISO 3166-1 alpha-2 format

Type declaration

  • Optional addressLine1?: string
  • Optional addressLine2?: string
  • Optional city?: string
  • Optional country?: string
  • Optional phoneNumber?: string
  • Optional postalCode?: string
  • Optional state?: string

BaseEntitlement

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

Type declaration

BasePlan

BasePlan: { displayName: string; id: string }

Type declaration

  • displayName: string
  • id: string

BillingInfo

BillingInfo: { billingAddress?: Address; currency?: Currency; customerName?: string; invoiceCustomFields?: Record<string, string>; language?: string; paymentMethodId?: string; shippingAddress?: Address; taxIds?: TaxExempt[]; timezone?: string }

Type declaration

  • Optional billingAddress?: Address
  • Optional currency?: Currency
  • Optional customerName?: string
  • Optional invoiceCustomFields?: Record<string, string>
  • Optional language?: string
  • Optional paymentMethodId?: string
  • Optional shippingAddress?: Address
  • Optional taxIds?: TaxExempt[]
  • Optional timezone?: string

BooleanEntitlementFallback

BooleanEntitlementFallback: { hasAccess: boolean }

Type declaration

  • hasAccess: boolean

BooleanEntitlementOptions

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

Type declaration

CancelSubscription

CancelSubscription: { endDate?: Date; subscriptionCancellationTime?: SubscriptionCancellationTime; subscriptionId: string }

Type declaration

CancelSubscriptionScheduledUpdates

CancelSubscriptionScheduledUpdates: { subscriptionId: string }

Type declaration

  • subscriptionId: string

Checkout

Checkout: { checkoutBillingId: string; checkoutUrl: string }

Type declaration

  • checkoutBillingId: string
  • checkoutUrl: string

CheckoutAddon

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

Type declaration

  • addonId: string
  • Optional quantity?: number

CheckoutOptions

CheckoutOptions: { allowPromoCodes?: boolean; allowTaxIdCollection?: boolean; cancelUrl: string; collectBillingAddress?: boolean; referenceId?: string; successUrl: string }

Type declaration

  • Optional allowPromoCodes?: boolean
  • Optional allowTaxIdCollection?: boolean
  • cancelUrl: string
  • Optional collectBillingAddress?: boolean
  • Optional referenceId?: string
  • successUrl: string

ClientConfiguration

ClientConfiguration: { apiKey: string; baseEdgeUri?: string; baseUri?: string; enableEdge?: boolean; entitlementsFallback?: EntitlementsFallback; logConfiguration?: LogConfiguration; realtimeUpdatesEnabled?: boolean; redis?: StiggRedisOptions; wsUrl?: string }

Type declaration

  • apiKey: string
  • Optional baseEdgeUri?: string
  • Optional baseUri?: string
  • Optional enableEdge?: boolean
  • Optional entitlementsFallback?: EntitlementsFallback
  • Optional logConfiguration?: LogConfiguration
  • Optional realtimeUpdatesEnabled?: boolean
  • Optional redis?: StiggRedisOptions
  • Optional wsUrl?: string

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

CreateCustomer

CreateCustomer: { billingInfo?: BillingInfo; couponId?: string; customerId?: string; email?: string; excludeFromExperiment?: boolean; metadata?: Metadata | null; name?: string; shouldSyncFree?: boolean }

Type declaration

  • Optional billingInfo?: BillingInfo
  • Optional couponId?: string
  • Optional customerId?: string
  • Optional email?: string
  • Optional excludeFromExperiment?: boolean
  • Optional metadata?: Metadata | null
  • Optional name?: string
  • Optional shouldSyncFree?: boolean

CreateSubscription

CreateSubscription: CreateSubscriptionParams & { customerId: string }

CreateSubscriptionParams

CreateSubscriptionParams: { addons?: SubscriptionAddon[]; awaitPaymentConfirmation?: boolean; billingInformation?: SubscriptionBillingInfo; billingPeriod?: BillingPeriod; id?: string; metadata?: Metadata | null; planId: string; promotionCode?: string; resourceId?: string; skipTrial?: boolean; startDate?: Date; unitQuantity?: number }

Type declaration

  • Optional addons?: SubscriptionAddon[]
  • Optional awaitPaymentConfirmation?: boolean
  • Optional billingInformation?: SubscriptionBillingInfo
  • Optional billingPeriod?: BillingPeriod
  • Optional id?: string
  • Optional metadata?: Metadata | null
  • planId: string
  • Optional promotionCode?: string
  • Optional resourceId?: string
  • Optional skipTrial?: boolean
  • Optional startDate?: Date
  • Optional unitQuantity?: number

CreateUsageMeasurement

CreateUsageMeasurement: { customerId: string; featureId: string; resourceId?: string; value: number }

Type declaration

  • customerId: string
  • featureId: string
  • Optional resourceId?: string
  • value: number

Customer

Customer: SlimCustomer

CustomerState

CustomerState: Omit<FullCustomer, "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

Entitlement

Entitlement: BooleanEntitlement | NumericEntitlement | MeteredEntitlement

EntitlementFeature

EntitlementFeature: { featureType: FeatureType; id: string; isMetered?: boolean; meterType?: Fluctuating | Incremental | None; units?: string; unitsPlural?: string }

Type declaration

EntitlementUsageUpdatedFragment

EntitlementUsageUpdatedFragment: { __typename?: "UsageUpdated"; entitlement: { __typename?: "Entitlement" } & EntitlementFragment; usage: { __typename?: "UsageMeasurementUpdated" } & UsageUpdatedFragment }

Type declaration

  • Optional __typename?: "UsageUpdated"
  • entitlement: { __typename?: "Entitlement" } & EntitlementFragment
  • usage: { __typename?: "UsageMeasurementUpdated" } & UsageUpdatedFragment

EntitlementsFallback

EntitlementsFallback: {}

Type declaration

EntitlementsUpdatedPayloadFragment

EntitlementsUpdatedPayloadFragment: { __typename?: "EntitlementsUpdated"; customerId: string; entitlements: ({ __typename?: "Entitlement" } & EntitlementFragment)[] }

Type declaration

  • Optional __typename?: "EntitlementsUpdated"
  • customerId: string
  • entitlements: ({ __typename?: "Entitlement" } & EntitlementFragment)[]

EstimateSubscription

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

Type declaration

  • Optional addons?: SubscriptionAddon[]
  • 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?: SubscriptionAddon[]; promotionCode?: string; subscriptionId: string; unitQuantity?: number }

Type declaration

  • Optional addons?: SubscriptionAddon[]
  • Optional promotionCode?: string
  • subscriptionId: string
  • Optional unitQuantity?: number

ExperimentInfo

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

Type declaration

FullCustomer

FullCustomer: SlimCustomer & { alreadyTrialPlans: TrialedPlan[]; coupon?: Coupon; experimentInfo?: ExperimentInfo | null; hasPaymentMethod: boolean; paymentMethodDetails?: PaymentMethodDetails; promotionalEntitlements: PromotionalEntitlement[]; subscriptions: FullSubscription[]; getActivePromotionalEntitlements: any; getActiveSubscriptions: any; getActiveTrials: any }

FullEntitlementFeature

FullEntitlementFeature: { 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

FullPromotionalEntitlement

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

Type declaration

FullSubscription

FullSubscription: { addons: FullSubscriptionAddon[]; billingId?: string; billingLinkUrl?: string; cancellationDate?: Date; crmId?: string; currentBillingPeriodEnd?: Date; effectiveEndDate?: Date; endDate?: Date; experimentInfo?: ExperimentInfo | null; id: string; metadata?: Metadata | null; plan: Plan; price: SubscriptionPrice | null; pricingType: PricingType; resourceId?: string; startDate: Date; status: SubscriptionStatus; trialEndDate?: Date }

Type declaration

  • addons: FullSubscriptionAddon[]
  • Optional billingId?: string
  • Optional billingLinkUrl?: 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
  • id: string
  • Optional metadata?: Metadata | null
  • plan: Plan
  • price: SubscriptionPrice | null
  • pricingType: PricingType
  • Optional resourceId?: string
  • startDate: Date
  • status: SubscriptionStatus
  • Optional trialEndDate?: Date

FullSubscriptionAddon

FullSubscriptionAddon: { addon: Addon; quantity: number }

Type declaration

  • addon: Addon
  • quantity: number

GetBooleanEntitlement

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

Type declaration

GetMeteredEntitlement

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

Type declaration

GetNumericEntitlement

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

Type declaration

GetPaywall

GetPaywall: { billingCountryCode?: string; customerId?: string; fetchAllCountriesPrices?: boolean; productId?: string }

Type declaration

  • Optional billingCountryCode?: string
  • Optional customerId?: string
  • Optional fetchAllCountriesPrices?: boolean
  • Optional productId?: string

ImportCustomer

ImportCustomer: { billingId: string; customerId?: string; email?: string; metadata?: Metadata | null; name?: string }

Type declaration

  • billingId: string
  • Optional customerId?: string
  • Optional email?: string
  • Optional metadata?: Metadata | null
  • Optional name?: string

InitiateCheckout

InitiateCheckout: { addons?: CheckoutAddon[]; allowPromoCodes?: boolean; billingPeriod: BillingPeriod; cancelUrl: string; collectBillingAddress?: boolean; customerId: string; planId: string; successUrl: string; unitQuantity?: number }

Type declaration

  • Optional addons?: CheckoutAddon[]
  • Optional allowPromoCodes?: boolean
  • billingPeriod: BillingPeriod
  • cancelUrl: string
  • Optional collectBillingAddress?: boolean
  • customerId: string
  • planId: string
  • successUrl: string
  • Optional unitQuantity?: number

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: FullEntitlementFeature; hasUnlimitedUsage?: boolean | null; hiddenFromWidgets?: PackageEntitlementFragment["hiddenFromWidgets"]; resetPeriod?: EntitlementResetPeriod | null; usageLimit: number }

Type declaration

  • Optional displayNameOverride?: PackageEntitlementFragment["displayNameOverride"]
  • feature: FullEntitlementFeature
  • Optional hasUnlimitedUsage?: boolean | null
  • Optional hiddenFromWidgets?: PackageEntitlementFragment["hiddenFromWidgets"]
  • 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: { configuration?: PaywallConfiguration | null; currency: PaywallCurrency; customer: Customer | null; plans: Plan[] }

Type declaration

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[]; product: Product }

Type declaration

Price

Price: { amount: number; billingCountryCode?: string | null; billingId?: string | null; billingPeriod: BillingPeriod; currency: Currency; feature?: { description?: string | null; displayName: string; unitQuantity?: number | null; units?: string | null; unitsPlural?: string | null } | null; maxUnitQuantity?: number | null; minUnitQuantity?: number | null; pricingModel: BillingModel }

Type declaration

  • amount: number
  • Optional billingCountryCode?: string | null
  • Optional billingId?: string | null
  • billingPeriod: BillingPeriod
  • currency: Currency
  • Optional feature?: { description?: string | null; displayName: string; unitQuantity?: number | null; units?: string | null; unitsPlural?: string | null } | null
  • Optional maxUnitQuantity?: number | null
  • Optional minUnitQuantity?: number | null
  • pricingModel: BillingModel

Product

Product: { description?: string | null; displayName?: string | null; downgradePlan?: Pick<Plan, "id" | "displayName">; id: string; metadata?: Metadata | null }

Type declaration

  • Optional description?: string | null
  • Optional displayName?: string | null
  • Optional downgradePlan?: Pick<Plan, "id" | "displayName">
  • id: string
  • Optional metadata?: Metadata | null

PromotionalEntitlement

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

Type declaration

ProvisionCustomer

ProvisionCustomer: CreateCustomer & { subscriptionParams: CreateSubscriptionParams | null }

ProvisionSubscription

ProvisionSubscription: { addons?: SubscriptionAddon[]; awaitPaymentConfirmation?: boolean; billingCountryCode?: string; billingInformation?: SubscriptionBillingInfo; billingPeriod?: BillingPeriod; checkoutOptions?: CheckoutOptions; customerId: string; id?: string; metadata?: Metadata | null; planId: string; promotionCode?: string; resourceId?: string; skipTrial?: boolean; startDate?: Date; unitQuantity?: number }

Type declaration

  • Optional addons?: SubscriptionAddon[]
  • Optional awaitPaymentConfirmation?: boolean
  • Optional billingCountryCode?: string
  • Optional billingInformation?: SubscriptionBillingInfo
  • Optional billingPeriod?: BillingPeriod
  • Optional checkoutOptions?: CheckoutOptions
  • customerId: string
  • Optional id?: string
  • Optional metadata?: Metadata | null
  • planId: string
  • Optional promotionCode?: string
  • Optional resourceId?: string
  • Optional skipTrial?: boolean
  • Optional startDate?: Date
  • Optional unitQuantity?: number

ProvisionSubscriptionResult

ProvisionSubscriptionResult: { checkoutUrl?: string | null; provisionStatus: ProvisionSubscriptionStatus; subscription?: Subscription }

Type declaration

ProvisionedCustomer

ProvisionedCustomer: { customer: Customer; subscription?: Subscription; subscriptionDecisionStrategy: SubscriptionDecisionStrategy }

Type declaration

ReportUsage

ReportUsage: { customerId: string; featureId: string; resourceId?: string; value: number }

Type declaration

  • customerId: string
  • featureId: string
  • Optional resourceId?: string
  • value: number

ReportUsageAck

ReportUsageAck: { measurementId: string }

Type declaration

  • measurementId: string

SlimCustomer

SlimCustomer: { billingId?: string; createdAt: Date; email?: string; id: string; metadata?: Metadata | null; name?: string; updatedAt: Date }

Type declaration

  • Optional billingId?: string
  • createdAt: Date
  • Optional email?: string
  • id: string
  • Optional metadata?: Metadata | null
  • Optional name?: string
  • updatedAt: Date

Subscription

Subscription: { addonIds: string[]; addons: SubscriptionAddon[]; billingId?: string; billingLinkUrl?: string; customerId: string; effectiveEndDate?: Date; experimentInfo?: ExperimentInfo | null; id: string; metadata?: Metadata | null; planId: string; price: SubscriptionPrice | null; pricingType: PricingType; resourceId?: string; status: SubscriptionStatus }

Type declaration

SubscriptionAddon

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

Type declaration

  • addonId: string
  • Optional quantity?: number

SubscriptionBillingInfo

SubscriptionBillingInfo: { taxRateIds?: string[] }

Type declaration

  • Optional taxRateIds?: string[]

SubscriptionPreviewDiscount

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

Type declaration

SubscriptionPreviewProration

SubscriptionPreviewProration: { credit: Money; debit: Money; netAmount: Money; prorationDate: Date }

Type declaration

SubscriptionPrice

SubscriptionPrice: Price & { grossAmount: number }

SubscriptionPricePreview

SubscriptionPricePreview: { subTotal: Money; total: Money }

Type declaration

TaxExempt

TaxExempt: { type: string; value: string }

Type declaration

  • type: string
  • value: string

TrialedPlan

TrialedPlan: { planId: string; productId: string }

Type declaration

  • planId: string
  • productId: string

UpdateCustomer

UpdateCustomer: { billingInfo?: Omit<BillingInfo, "taxIds">; couponId?: string | null; customerId: string; email?: string; metadata?: Metadata | null; name?: string }

Type declaration

  • Optional billingInfo?: Omit<BillingInfo, "taxIds">
  • Optional couponId?: string | null
  • customerId: string
  • Optional email?: string
  • Optional metadata?: Metadata | null
  • Optional name?: string

UpdateSubscription

UpdateSubscription: { addons?: SubscriptionAddon[]; billingPeriod?: BillingPeriod; metadata?: Metadata | null; subscriptionId: string; unitQuantity?: number }

Type declaration

Generated using TypeDoc