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
id: string
Optional metadata?: Metadata | null
pricePoints: Price[]
Optional pricingType?: PricingType | null
ApplySubscription
Apply
Subscription
: { 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 billingCountryCode?: string
Optional billingId?: string
Optional billingInformation?: Omit<SubscriptionBillingInfo, "taxPercentage">
Optional metadata?: Metadata | null
Optional paymentMethodId?: string
planId: string
Optional promotionCode?: string
Optional resourceId?: string
Optional skipTrial?: boolean
Optional startDate?: Date
Optional unitQuantity?: number
BaseEntitlement
Type declaration
hasAccess: boolean
isFallback: boolean
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 }
BooleanEntitlementOptions
Type declaration
Optional shouldTrack?: boolean
CheckoutAddon
CheckoutAddon: { addonId: string; quantity?: number }
Type declaration
addonId: string
Optional quantity?: number
CheckoutBillingIntegration
Checkout
Billing
Integration
: { billingIdentifier
: BillingVendorIdentifier; credentials
: { accountId
: string; publicKey
: string } }Type declaration
credentials: { accountId: string; publicKey: string }
accountId: string
publicKey: string
CheckoutConfiguration
CheckoutConfiguration: Omit<CheckoutConfigurationFragment, "__typename">
CheckoutStatePlan
Checkout
State
Plan
: Plan & Pick<PlanFragment, "prices">ClientConfiguration
Client
Configuration
: { 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 lazyLoad?: boolean
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
createdAt: Date
Optional eligibleForTrial?: EligibleForTrial[] | null
Optional email?: string
Optional experimentInfo?: ExperimentInfo | null
hasPaymentMethod: boolean
id: string
Optional metadata?: Metadata | null
Optional name?: string
Optional trialedPlans?: TrialedPlan[] | null
updatedAt: Date
getActivePromotionalEntitlements:function
getActiveSubscriptions:function
getActiveTrials:function
CustomerPortal
Type declaration
Optional billingPortalUrl?: string | null
canUpgradeSubscription: boolean
showWatermark: boolean
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
Customer
Portal
Subscription
Scheduled
Update
Data
Fragment
: { __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
Optional targetPackage?: { __typename?: "PackageDTO"; displayName: string; id: string; pricingType?: PricingType | null; refId: string } | null
CustomerResource
CustomerResource: { id: string }
CustomerState
Customer
State
: Omit<Customer, "getActiveSubscriptions" | "getActivePromotionalEntitlements" | "getActiveTrials">DateRange
DateRange: { end?: Date; start?: Date }
Type declaration
Optional end?: Date
Optional start?: Date
EligibleForTrial
EligibleForTrial: { eligible: boolean; productId?: string | null }
Type declaration
eligible: boolean
Optional productId?: string | null
EntitlementFeature
Entitlement
Feature
: { 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
id: string
Optional isMetered?: boolean
Optional metadata?: Record<string, string>
Optional units?: string
Optional unitsPlural?: string
EntitlementsFallback
EntitlementsFallback: {}
EstimateSubscription
Type declaration
Optional billingCountryCode?: string
customerId: string
planId: string
Optional promotionCode?: string
Optional resourceId?: string
Optional skipTrial?: boolean
Optional startDate?: Date
Optional unitQuantity?: number
EstimateSubscriptionUpdate
Type declaration
Optional promotionCode?: string
subscriptionId: string
Optional unitQuantity?: number
ExperimentInfo
Experiment
Info
: { groupName
: string; groupType
?: ExperimentGroupType | null; id
: string; name
: string }Type declaration
groupName: string
id: string
name: string
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
Type declaration
featureId: string
Optional resourceId?: string
GetCheckoutState
GetCheckoutState: { billingCountryCode?: string; planId: string; resourceId?: string | null }
Type declaration
Optional billingCountryCode?: string
planId: string
Optional resourceId?: string | null
GetCheckoutStateResults
Type declaration
Optional activeSubscription?: Subscription | null
setupSecret: string
GetCustomerPortal
GetCustomerPortal: { productId?: string; resourceId?: string }
Type declaration
Optional productId?: string
Optional resourceId?: string
GetMeteredEntitlement
Type declaration
featureId: string
Optional resourceId?: string
GetNumericEntitlement
Type declaration
featureId: string
Optional resourceId?: string
GetPaywall
Get
Paywall
: { billingCountryCode
?: string; context
?: WidgetType; productId
?: string; resourceId
?: string }Type declaration
Optional billingCountryCode?: string
Optional productId?: string
Optional resourceId?: string
ImmediateSubscriptionPreviewInvoice
MeteredEntitlementFallback
MeteredEntitlementFallback: { hasAccess: boolean; isUnlimited?: boolean; usageLimit?: number }
Type declaration
hasAccess: boolean
Optional isUnlimited?: boolean
Optional usageLimit?: number
MeteredEntitlementOptions
Type declaration
Optional requestedUsage?: number
Optional shouldTrack?: boolean
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
Type declaration
Optional shouldTrack?: boolean
PackageEntitlement
Package
Entitlement
: { 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 hasUnlimitedUsage?: boolean | null
Optional hiddenFromWidgets?: PackageEntitlementFragment["hiddenFromWidgets"]
Optional isCustom?: boolean
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
PaywallCalculatedPricePoint
PaywallCalculatedPricePoint: Omit<PaywallCalculatedPricePointsFragment, "__typename">
PaywallConfiguration
PaywallConfiguration: Omit<PaywallConfigurationFragment, "__typename">
PaywallCurrency
PaywallCurrency: Omit<PaywallCurrencyFragment, "__typename">
Plan
Type declaration
Optional basePlan?: BasePlan
Optional billingId?: string | null
compatibleAddons: Addon[]
Optional defaultTrialConfig?: DefaultTrialConfig | null
Optional description?: string | null
displayName: string
id: string
Optional metadata?: Metadata | null
order: number
pricePoints: Price[]
Optional pricingType?: PricingType | null
PreviewSubscription
Type declaration
Optional billingCountryCode?: string
customerId: string
planId: string
Optional promotionCode?: string
Optional resourceId?: string
Optional startDate?: Date
Optional unitQuantity?: number
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
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
tiersMode: TiersMode | null | undefined
PriceTierFragment
Price
Tier
Fragment
: { __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
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
Type declaration
Optional expiresAt?: Date
hasExpirationDate: boolean
Optional hasUnlimitedUsage?: boolean | null
isVisible: boolean
usageLimit: number
Subscription
Type declaration
Optional billingId?: string
Optional cancellationDate?: Date
Optional crmId?: string
Optional currentBillingPeriodEnd?: Date
Optional effectiveEndDate?: Date
Optional endDate?: Date
Optional experimentInfo?: ExperimentInfo | null
futureUpdates: SubscriptionFutureUpdateDataFragment[]
id: string
Optional metadata?: Metadata | null
Optional resourceId?: string
startDate: Date
totalPrice: TotalPriceFragment | null | undefined
Optional trialEndDate?: Date
SubscriptionAddon
Subscription
Addon
: { addon
: Addon; quantity
: number }SubscriptionBillingInfo
Subscription
Billing
Info
: { billingAddress
?: BillingAddress; taxPercentage
?: number; taxRateIds
?: string[] }Type declaration
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
Subscription
Preview
Credits
: { initial
: Money; remaining
: Money; used
: Money }SubscriptionPreviewDiscount
Type declaration
Optional durationInMonths?: number
value: number
SubscriptionPreviewInvoice
SubscriptionPreviewProration
Subscription
Preview
Proration
: { credit
: Money; debit
: Money; hasProrations
?: boolean; netAmount
: Money; prorationDate
: Date }Type declaration
Optional hasProrations?: boolean
netAmount: Money
prorationDate: Date
SubscriptionPreviewTaxDetails
SubscriptionPreviewTaxDetails: { displayName: string; inclusive: boolean; percentage: number }
Type declaration
displayName: string
inclusive: boolean
percentage: number
SubscriptionPrice
Subscription
Price
: Price & { grossAmount
: number }SubscriptionPricePreview
Type declaration
Optional discountAmount?: Money
Optional tax?: Money
totalExcludingTax: Money
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
use StiggClient.getActiveSubscriptions instead with filter for SubscriptionStatus.Active