Type aliases Add Compatible Addons To Plan Input Add
Compatible
Addons
To
Plan
Input
: { id
: Scalars [ "String" ] ; relationIds
: Scalars [ "String" ] [] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:46 Addon Type declaration Optional billing Id?: string | null description: string display Name: string id: string Optional metadata?: Metadata | null price Points: Price [] Optional pricing Type?: PricingType | null Addon Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:52 Addon Dependency Fragment Addon Dependency Fragment: { __typename?: "Addon" ; description?: string | null ; displayName: string ; id: string ; refId: string }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4068 Type declaration Optional __typename?: "Addon" Optional description?: string | null display Name: string id: string ref Id: string Addon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:69 Addon Fragment Addon
Fragment
: { __typename
?: "Addon" ; additionalMetaData
?: any | null ; billingId
?: string | null ; dependencies
?: ( { __typename
?: "Addon" } & AddonDependencyFragment ) [] | null ; description
?: string | null ; displayName
: string ; entitlements
?: ( { __typename
?: "PackageEntitlement" } & PackageEntitlementFragment ) [] | null ; id
: string ; maxQuantity
?: number | null ; overagePrices
?: ( { __typename
?: "Price" } & OveragePriceFragment ) [] | null ; prices
?: ( { __typename
?: "Price" } & PriceFragment ) [] | null ; pricingType
?: PricingType | null ; refId
: string } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4045 Type declaration Optional __typename?: "Addon" Optional additional Meta Data?: any | null Optional billing Id?: string | null Optional dependencies?: ( { __typename?: "Addon" } & AddonDependencyFragment ) [] | null Optional description?: string | null display Name: string Optional entitlements?: ( { __typename?: "PackageEntitlement" } & PackageEntitlementFragment ) [] | null id: string Optional max Quantity?: number | null Optional overage Prices?: ( { __typename?: "Price" } & OveragePriceFragment ) [] | null Optional prices?: ( { __typename?: "Price" } & PriceFragment ) [] | null Optional pricing Type?: PricingType | null ref Id: string Addon Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:86 Addon Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:106 Address Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:119 Aggregated Events By Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:128 Api Key Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:149 Api Key Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:154 Apply Subscription 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 ; scheduleStrategy
?: ScheduleStrategy ; skipTrial
?: boolean ; startDate
?: Date ; unitQuantity
?: number } Type declaration Optional billing Country Code?: string Optional billing Id?: string Optional billing Information?: Omit < SubscriptionBillingInfo , "taxPercentage" > Optional metadata?: Metadata | null Optional payment Method Id?: string plan Id: string Optional promotion Code?: string Optional resource Id?: string Optional skip Trial?: boolean Optional start Date?: Date Optional unit Quantity?: number Apply Subscription Fragment Apply
Subscription
Fragment
: { __typename
?: "ApplySubscription" ; entitlements
?: ( { __typename
?: "Entitlement" } & EntitlementFragment ) [] | null ; subscription
?: ( { __typename
?: "CustomerSubscription" } & SubscriptionFragment ) | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5244 Type declaration Optional __typename?: "ApplySubscription" Optional entitlements?: ( { __typename?: "Entitlement" } & EntitlementFragment ) [] | null Optional subscription?: ( { __typename?: "CustomerSubscription" } & SubscriptionFragment ) | null Apply Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:167 Apply Subscription Mutation Apply
Subscription
Mutation
: { __typename
?: "Mutation" ; applySubscription
: { __typename
?: "ApplySubscription" } & ApplySubscriptionFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5395 Apply Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5392 Archive Coupon Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:197 Archive Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:201 Archive Customer Mutation Archive Customer Mutation: { __typename?: "Mutation" ; archiveCustomer: { __typename?: "Customer" ; customerId: string } }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5514 Type declaration Optional __typename?: "Mutation" archive Customer: { __typename?: "Customer" ; customerId: string } Optional __typename?: "Customer" customer Id: string Archive Customer Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5511 Archive Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:205 Archive Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:209 Archive Package Group Archive
Package
Group
: { environmentId
: Scalars [ "String" ] ; packageGroupId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:214 Archive Plan Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:220 Attach Customer Payment Method Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:224 Aws Marketplace Credentials Input Aws
Marketplace
Credentials
Input
: { awsRoleArn
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:231 Base Entitlement Type declaration has Access: boolean is Fallback: boolean Base Plan Base Plan: { displayName: string ; id: string }
Type declaration display Name: string id: string Billable Feature Billable Feature: { featureId: string ; quantity: number }
Type declaration feature Id: string quantity: number Billable Feature Input Billable
Feature
Input
: { featureId
: Scalars [ "String" ] ; quantity
: Scalars [ "Float" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:234 Billing Address Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:238 Billing Cadence Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:255 Billing Model Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:277 Billing Period Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:298 Boolean Entitlement Fallback Boolean Entitlement Fallback: { hasAccess: boolean }
Boolean Entitlement Options Type declaration Optional should Track?: boolean Boolean Field Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:318 Budget Configuration Input Budget
Configuration
Input
: { hasSoftLimit
: Scalars [ "Boolean" ] ; limit
: Scalars [ "Float" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:323 Cancel Subscription Mutation Cancel
Subscription
Mutation
: { __typename
?: "Mutation" ; cancelSubscription
: { __typename
?: "CustomerSubscription" } & SlimSubscriptionFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5420 Cancel Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5417 Cancel Subscription Updates Mutation Cancel Subscription Updates Mutation: { __typename?: "Mutation" ; cancelSchedule: string }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5456 Type declaration Optional __typename?: "Mutation" cancel Schedule: string Cancel Subscription Updates Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5453 Charge Subscription Overages Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:336 Checkout Addon Checkout Addon: { addonId: string ; quantity?: number }
Type declaration addon Id: string Optional quantity?: number Checkout Billing Integration Checkout
Billing
Integration
: { billingIdentifier
: BillingVendorIdentifier ; credentials
: { accountId
: string ; publicKey
: string } } Type declaration credentials: { accountId: string ; publicKey: string } account Id: string public Key: string Checkout Configuration Fragment Checkout
Configuration
Fragment
: { __typename
: "CheckoutConfiguration" ; content
?: { __typename
?: "CheckoutContent" ; collectPhoneNumber
?: boolean | null } | null ; customCss
?: string | null ; palette
?: { __typename
: "CheckoutColorPalette" ; backgroundColor
?: string | null ; borderColor
?: string | null ; primary
?: string | null ; summaryBackgroundColor
?: string | null ; textColor
?: string | null } | null ; typography
?: ( { __typename
: "TypographyConfiguration" } & TypographyConfigurationFragment ) | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4856 Type declaration __typename: "CheckoutConfiguration" Optional content?: { __typename?: "CheckoutContent" ; collectPhoneNumber?: boolean | null } | null Optional custom Css?: string | null Optional palette?: { __typename: "CheckoutColorPalette" ; backgroundColor?: string | null ; borderColor?: string | null ; primary?: string | null ; summaryBackgroundColor?: string | null ; textColor?: string | null } | null Optional typography?: ( { __typename: "TypographyConfiguration" } & TypographyConfigurationFragment ) | null Checkout Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:344 Checkout Content Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:350 Checkout Options Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:353 Checkout Palette Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:362 Checkout State Fragment Checkout
State
Fragment
: { __typename
?: "CheckoutState" ; activeSubscription
?: ( { __typename
?: "CustomerSubscription" } & SubscriptionFragment ) | null ; billingIntegration
: { __typename
?: "CheckoutBillingIntegration" ; billingIdentifier
: BillingVendorIdentifier ; credentials
: { __typename
?: "CheckoutCredentials" ; accountId
: string ; publicKey
: string } } ; configuration
?: ( { __typename
?: "CheckoutConfiguration" } & CheckoutConfigurationFragment ) | null ; customer
: { __typename
?: "Customer" } & CustomerFragment ; plan
: { __typename
?: "Plan" } & PlanFragment ; resource
?: ( { __typename
?: "CustomerResource" } & CustomerResourceFragment ) | null ; setupSecret
: string } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4828 Type declaration Optional __typename?: "CheckoutState" Optional active Subscription?: ( { __typename?: "CustomerSubscription" } & SubscriptionFragment ) | null billing Integration: { __typename?: "CheckoutBillingIntegration" ; billingIdentifier: BillingVendorIdentifier ; credentials: { __typename?: "CheckoutCredentials" ; accountId: string ; publicKey: string } } Optional __typename?: "CheckoutBillingIntegration" credentials: { __typename?: "CheckoutCredentials" ; accountId: string ; publicKey: string } Optional __typename?: "CheckoutCredentials" account Id: string public Key: string Optional configuration?: ( { __typename?: "CheckoutConfiguration" } & CheckoutConfigurationFragment ) | null customer: { __typename?: "Customer" } & CustomerFragment plan: { __typename?: "Plan" } & PlanFragment Optional resource?: ( { __typename?: "CustomerResource" } & CustomerResourceFragment ) | null setup Secret: string Checkout State Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:369 Clear Customer Persistent Cache Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:375 Client Configuration Client
Configuration
: { apiKey
: string ; baseEdgeUri
?: string ; baseUri
?: string ; clientName
?: string ; clientVersion
?: string ; customerId
?: string | null ; customerToken
?: string | null ; enableEdge
?: boolean ; entitlementPollingInterval
?: number ; entitlementsFallback
?: EntitlementsFallback ; lazyLoad
?: boolean ; logConfiguration
?: LogConfiguration ; resourceId
?: string | null ; useEntitlementPolling
?: boolean } Type declaration api Key: string Optional base Edge Uri?: string Optional base Uri?: string Optional client Name?: string Optional client Version?: string Optional customer Id?: string | null Optional customer Token?: string | null Optional enable Edge?: boolean Optional entitlement Polling Interval?: number Optional lazy Load?: boolean Optional resource Id?: string | null Optional use Entitlement Polling?: boolean Compatible Package Group Type declaration display Name: string package Group Id: string Compatible Package Group Options Compatible Package Group Options: { freeItems?: number ; minItems?: number }
Type declaration Optional free Items?: number Optional min Items?: number Coupon Coupon: { description?: string | null ; discountValue: number ; id: string ; metadata?: Metadata | null ; name: string }
Type declaration Optional description?: string | null discount Value: number id: string Optional metadata?: Metadata | null name: string Coupon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:391 Coupon Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:406 Coupon Fragment Coupon
Fragment
: { __typename
?: "Coupon" ; additionalMetaData
?: any | null ; billingId
?: string | null ; billingLinkUrl
?: string | null ; createdAt
: any ; customers
?: { __typename
?: "Customer" ; id
: string } [] | null ; description
?: string | null ; discountValue
: number ; id
: string ; name
: string ; refId
: string ; status
: CouponStatus ; syncStates
?: { __typename
?: "SyncState" ; status
: SyncStatus ; vendorIdentifier
: VendorIdentifier } [] | null ; type
: CouponType ; updatedAt
: any } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3920 Type declaration Optional __typename?: "Coupon" Optional additional Meta Data?: any | null Optional billing Id?: string | null Optional billing Link Url?: string | null created At: any Optional customers?: { __typename?: "Customer" ; id: string } [] | null Optional description?: string | null discount Value: number id: string name: string ref Id: string Optional sync States?: { __typename?: "SyncState" ; status: SyncStatus ; vendorIdentifier: VendorIdentifier } [] | null updated At: any Coupon Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:424 Coupon Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:446 Coupon Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:467 Create Coupon Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:483 Create Environment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:492 Create Environment Options Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:503 Create Experiment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:506 Create Hook Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:516 Create Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:526 Create Many Package Entitlements Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:536 Create Many Promotional Entitlements Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:540 Create Meter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:544 Create One Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:548 Create One Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:552 Create One Hook Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:556 Create One Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:560 Create One Product Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:564 Create Or Update Aws Marketplace Product Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:568 Create Package Group Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:581 Create Subscription Mutation Create
Subscription
Mutation
: { __typename
?: "Mutation" ; createSubscription
: { __typename
?: "CustomerSubscription" } & SlimSubscriptionFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5495 Create Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5492 Cursor Paging Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:711 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 created At: Date Optional eligible For Trial?: EligibleForTrial [] | null Optional email?: string Optional experiment Info?: ExperimentInfo | null has Payment Method: boolean id: string Optional metadata?: Metadata | null Optional name?: string Optional trialed Plans?: TrialedPlan [] | null updated At: Date get Active Promotional Entitlements: function get Active Subscriptions: function get Active Trials: function Customer Billing Info Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:721 Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:733 Customer Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:753 Customer Filter Promotional Entitlement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:779 Customer Fragment Customer
Fragment
: { __typename
?: "Customer" ; coupon
?: ( { __typename
?: "Coupon" } & CouponFragment ) | null ; defaultPaymentExpirationMonth
?: number | null ; defaultPaymentExpirationYear
?: number | null ; defaultPaymentMethodLast4Digits
?: string | null ; eligibleForTrial
?: { __typename
?: "EligibleForTrial" ; eligible
: boolean ; productId
?: string | null ; productRefId
?: string | null } [] | null ; experimentInfo
?: { __typename
?: "experimentInfo" ; groupName
: string ; groupType
: ExperimentGroupType ; id
: string ; name
: string } | null ; hasActiveSubscription
: boolean ; hasPaymentMethod
: boolean ; promotionalEntitlements
: ( { __typename
?: "PromotionalEntitlement" } & PromotionalEntitlementFragment ) [] ; trialedPlans
?: { __typename
?: "TrialedPlan" ; planId
?: string | null ; planRefId
?: string | null ; productId
?: string | null ; productRefId
?: string | null } [] | null } & SlimCustomerFragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4343 Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:788 Customer Portal Type declaration Optional billing Portal Url?: string | null can Upgrade Subscription: boolean show Watermark: boolean Customer Portal Billing Information Customer Portal Billing Information Fragment Customer Portal Billing Information Fragment: { __typename?: "CustomerPortalBillingInformation" ; defaultPaymentExpirationMonth?: number | null ; defaultPaymentExpirationYear?: number | null ; defaultPaymentMethodId?: string | null ; defaultPaymentMethodLast4Digits?: string | null ; email?: string | null ; name?: string | null }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5030 Type declaration Optional __typename?: "CustomerPortalBillingInformation" Optional default Payment Expiration Month?: number | null Optional default Payment Expiration Year?: number | null Optional default Payment Method Id?: string | null Optional default Payment Method Last4 Digits?: string | null Optional email?: string | null Optional name?: string | null Customer Portal Colors Palette Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:804 Customer Portal Configuration Customer Portal Configuration Fragment Customer
Portal
Configuration
Fragment
: { __typename
?: "CustomerPortalConfiguration" ; customCss
?: string | null ; palette
?: { __typename
?: "CustomerPortalColorsPalette" ; backgroundColor
?: string | null ; borderColor
?: string | null ; currentPlanBackground
?: string | null ; iconsColor
?: string | null ; paywallBackgroundColor
?: string | null ; primary
?: string | null ; textColor
?: string | null } | null ; typography
?: ( { __typename
?: "TypographyConfiguration" } & TypographyConfigurationFragment ) | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4875 Type declaration Optional __typename?: "CustomerPortalConfiguration" Optional custom Css?: string | null Optional palette?: { __typename?: "CustomerPortalColorsPalette" ; backgroundColor?: string | null ; borderColor?: string | null ; currentPlanBackground?: string | null ; iconsColor?: string | null ; paywallBackgroundColor?: string | null ; primary?: string | null ; textColor?: string | null } | null Optional typography?: ( { __typename?: "TypographyConfiguration" } & TypographyConfigurationFragment ) | null Customer Portal Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:813 Customer Portal Entitlement Customer Portal Entitlement Fragment Customer
Portal
Entitlement
Fragment
: { __typename
?: "Entitlement" ; currentUsage
?: number | null ; feature
?: ( { __typename
?: "EntitlementFeature" } & FeatureFragment ) | null ; hasSoftLimit
?: boolean | null ; hasUnlimitedUsage
: boolean ; isGranted
: boolean ; nextResetDate
?: any | null ; resetPeriod
?: EntitlementResetPeriod | null ; resetPeriodConfiguration
?: ( { __typename
?: "MonthlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ ) | ( { __typename
?: "WeeklyResetPeriodConfig" } & ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_ ) | ( { __typename
?: "YearlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_ ) | null ; usageLimit
?: number | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5000 Type declaration Optional __typename?: "Entitlement" Optional current Usage?: number | null Optional feature?: ( { __typename?: "EntitlementFeature" } & FeatureFragment ) | null Optional has Soft Limit?: boolean | null has Unlimited Usage: boolean is Granted: boolean Optional next Reset Date?: any | null Optional reset Period Configuration?: ( { __typename?: "MonthlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ ) | ( { __typename?: "WeeklyResetPeriodConfig" } & ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_ ) | ( { __typename?: "YearlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_ ) | null Optional usage Limit?: number | null Customer Portal Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4804 Type declaration Optional __typename?: "CustomerPortal" Optional billing Portal Url?: string | null can Upgrade Subscription: boolean Optional configuration?: ( { __typename?: "CustomerPortalConfiguration" } & CustomerPortalConfigurationFragment ) | null Optional resource?: ( { __typename?: "CustomerResource" } & CustomerResourceFragment ) | null show Watermark: boolean Customer Portal Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:818 Customer Portal Promotional Entitlement Customer Portal Promotional Entitlement Fragment Customer
Portal
Promotional
Entitlement
Fragment
: { __typename
?: "CustomerPortalPromotionalEntitlement" ; displayName
: string ; endDate
?: any | null ; hasSoftLimit
?: boolean | null ; hasUnlimitedUsage
?: boolean | null ; period
: PromotionalEntitlementPeriod ; startDate
: any ; usageLimit
?: number | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5020 Type declaration Optional __typename?: "CustomerPortalPromotionalEntitlement" display Name: string Optional end Date?: any | null Optional has Soft Limit?: boolean | null Optional has Unlimited Usage?: boolean | null start Date: any Optional usage Limit?: number | null Customer Portal Subscription Customer Portal Subscription Addon Customer Portal Subscription Addon Fragment Customer Portal Subscription Addon Fragment: { __typename?: "CustomerPortalAddon" ; addonId: string ; description?: string | null ; displayName: string ; quantity: number }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4969 Type declaration Optional __typename?: "CustomerPortalAddon" addon Id: string Optional description?: string | null display Name: string quantity: number Customer Portal Subscription Fragment Customer
Portal
Subscription
Fragment
: { __typename
?: "CustomerPortalSubscription" ; addons
: ( { __typename
?: "CustomerPortalAddon" } & CustomerPortalSubscriptionAddonFragment ) [] ; billingPeriodRange
?: { __typename
?: "DateRange" ; end
?: any | null ; start
?: any | null } | null ; planName
: string ; prices
: ( { __typename
?: "CustomerPortalSubscriptionPrice" } & CustomerPortalSubscriptionPriceFragment ) [] ; pricing
: { __typename
?: "CustomerPortalSubscriptionPricing" ; billingModel
?: BillingModel | null ; billingPeriod
?: BillingPeriod | null ; feature
?: { __typename
?: "CustomerPortalPricingFeature" ; displayName
: string ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null } | null ; price
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; pricingType
: PricingType ; unitQuantity
?: number | null ; usageBasedEstimatedBill
?: number | null } ; pricingType
: PricingType ; scheduledUpdates
?: ( { __typename
?: "SubscriptionScheduledUpdate" } & CustomerPortalSubscriptionScheduledUpdateDataFragment ) [] | null ; status
: SubscriptionStatus ; subscriptionId
: string ; totalPrice
?: { __typename
?: "CustomerSubscriptionTotalPrice" ; addonsTotal
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; subTotal
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; total
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } } | null ; trialRemainingDays
?: number | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4910 Type declaration Optional __typename?: "CustomerPortalSubscription" Optional billing Period Range?: { __typename?: "DateRange" ; end?: any | null ; start?: any | null } | null plan Name: string pricing: { __typename?: "CustomerPortalSubscriptionPricing" ; billingModel?: BillingModel | null ; billingPeriod?: BillingPeriod | null ; feature?: { __typename?: "CustomerPortalPricingFeature" ; displayName: string ; featureUnits?: string | null ; featureUnitsPlural?: string | null } | null ; price?: { __typename?: "Money" ; amount: number ; currency: Currency } | null ; pricingType: PricingType ; unitQuantity?: number | null ; usageBasedEstimatedBill?: number | null } Optional __typename?: "CustomerPortalSubscriptionPricing" Optional billing Model?: BillingModel | null Optional billing Period?: BillingPeriod | null Optional feature?: { __typename?: "CustomerPortalPricingFeature" ; displayName: string ; featureUnits?: string | null ; featureUnitsPlural?: string | null } | null Optional price?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional unit Quantity?: number | null Optional usage Based Estimated Bill?: number | null subscription Id: string Optional total Price?: { __typename?: "CustomerSubscriptionTotalPrice" ; addonsTotal: { __typename?: "Money" ; amount: number ; currency: Currency } ; subTotal: { __typename?: "Money" ; amount: number ; currency: Currency } ; total: { __typename?: "Money" ; amount: number ; currency: Currency } } | null Optional trial Remaining Days?: number | null Customer Portal Subscription Price Fragment Customer
Portal
Subscription
Price
Fragment
: { __typename
?: "CustomerPortalSubscriptionPrice" ; billingModel
?: BillingModel | null ; billingPeriod
?: BillingPeriod | null ; feature
?: { __typename
?: "CustomerPortalPricingFeature" ; displayName
: string ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; id
: string ; refId
: string } | null ; price
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4892 Type declaration Optional __typename?: "CustomerPortalSubscriptionPrice" Optional billing Model?: BillingModel | null Optional billing Period?: BillingPeriod | null Optional feature?: { __typename?: "CustomerPortalPricingFeature" ; displayName: string ; featureUnits?: string | null ; featureUnitsPlural?: string | null ; id: string ; refId: string } | null Optional price?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Customer Portal Subscription Scheduled Update Data Fragment Customer
Portal
Subscription
Scheduled
Update
Data
Fragment
: { __typename
?: "SubscriptionScheduledUpdate" ; scheduleStatus
: SubscriptionScheduleStatus ; scheduleVariables
?: ( { __typename
?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename
?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename
?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename
?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename
?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_ ) | null ; scheduledExecutionTime
: any ; subscriptionScheduleType
: SubscriptionScheduleType ; targetPackage
?: { __typename
?: "PackageDTO" ; displayName
: string ; id
: string ; pricingType
?: PricingType | null ; refId
: string } | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4976 Type declaration Optional __typename?: "SubscriptionScheduledUpdate" Optional schedule Variables?: ( { __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_ ) | null scheduled Execution Time: any Optional target Package?: { __typename?: "PackageDTO" ; displayName: string ; id: string ; pricingType?: PricingType | null ; refId: string } | null Customer Resource Customer Resource: { id: string }
Customer Resource Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:823 Customer Resource Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:832 Customer Resource Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:850 Customer Resource Fragment Customer Resource Fragment: { __typename?: "CustomerResource" ; resourceId: string }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4131 Type declaration Optional __typename?: "CustomerResource" resource Id: string Customer Resource Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:876 Customer Search Query Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:886 Customer Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:889 Customer State Customer
State
: Omit < Customer , "getActiveSubscriptions" | "getActivePromotionalEntitlements" | "getActiveTrials" > Customer Statistics Fragment Customer
Statistics
Fragment
: { __typename
?: "Customer" ; statistics
?: { __typename
?: "CustomerStatistics" ; activeSubscriptionsByPricingType
: { __typename
?: "SubscriptionPricingTypeStatistics" ; pricingType
: PricingType ; totalCount
: number } [] } | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4383 Type declaration Optional __typename?: "Customer" Optional statistics?: { __typename?: "CustomerStatistics" ; activeSubscriptionsByPricingType: { __typename?: "SubscriptionPricingTypeStatistics" ; pricingType: PricingType ; totalCount: number } [] } | null Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:910 Customer Subscription Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:942 Customer Subscription Filter Customer Resource Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:960 Customer Subscription Filter Plan Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:967 Customer Subscription Filter Subscription Addon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:984 Customer Subscription Filter Subscription Entitlement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:992 Customer Subscription Filter Subscription Price Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1001 Customer Subscription Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1012 Customer With Subscriptions Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4377 Date Field Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1041 Date Field Comparison Between Date
Field
Comparison
Between
: { lower
: Scalars [ "DateTime" ] ; upper
: Scalars [ "DateTime" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1055 Date Range Date Range: { end?: Date ; start?: Date }
Type declaration Optional end?: Date Optional start?: Date Default Trial Config Input Dto Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1059 Delete Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1065 Delete One Addon Input Delete
One
Addon
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1069 Delete One Hook Input Delete
One
Hook
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1073 Delete One Integration Input Delete
One
Integration
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1077 Delete One Package Entitlement Input Delete
One
Package
Entitlement
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1081 Delete One Price Input Delete
One
Price
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1085 Delete One Product Input Delete
One
Product
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1089 Delete One Promotional Entitlement Input Delete
One
Promotional
Entitlement
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1093 Dependency Addon Dependency Addon: { description?: string ; displayName: string ; refId: string }
Type declaration Optional description?: string display Name: string ref Id: string Detach Customer Payment Method Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1106 Detach Customer Payment Method Mutation Detach
Customer
Payment
Method
Mutation
: { __typename
?: "Mutation" ; detachCustomerPaymentMethod
: { __typename
?: "Customer" } & SlimCustomerFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5358 Type declaration Optional __typename?: "Mutation" detach Customer Payment Method: { __typename?: "Customer" } & SlimCustomerFragment Detach Customer Payment Method Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5355 Dimensions Mapping Input Dimensions
Mapping
Input
: { key
: Scalars [ "String" ] ; planName
: Scalars [ "String" ] ; planRefId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1110 Discard Package Draft Input Discard
Package
Draft
Input
: { environmentId
: Scalars [ "String" ] ; refId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1115 Does Feature Exist Does
Feature
Exist
: { environmentId
: Scalars [ "String" ] ; refId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1130 Dump Environment For For Merge Comparison Input Dump
Environment
For
For
Merge
Comparison
Input
: { destinationEnvironmentSlug
: Scalars [ "String" ] ; sourceEnvironmentSlug
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1135 Type declaration destination Environment Slug: Scalars [ "String" ] source Environment Slug: Scalars [ "String" ] Dump Environment Product Catalog Input Dump
Environment
Product
Catalog
Input
: { environmentSlug
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1142 Duplicate Product Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1146 Edit Package Group Details Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1154 Eligible For Trial Eligible For Trial: { eligible: boolean ; productId?: string | null }
Type declaration eligible: boolean Optional product Id?: string | null Entitlement Check Requested Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1164 Entitlement Check Result Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1172 Entitlement Feature 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 display Name: string id: string Optional is Metered?: boolean Optional metadata?: Record < string , string > Optional units?: string Optional units Plural?: string Entitlement Fragment Entitlement
Fragment
: { __typename
: "Entitlement" ; accessDeniedReason
?: AccessDeniedReason | null ; currentUsage
?: number | null ; customerId
?: string | null ; entitlementUpdatedAt
?: any | null ; feature
?: ( { __typename
?: "EntitlementFeature" } & FeatureFragment ) | null ; hasSoftLimit
?: boolean | null ; hasUnlimitedUsage
: boolean ; isGranted
: boolean ; nextResetDate
?: any | null ; requestedUsage
?: number | null ; resetPeriod
?: EntitlementResetPeriod | null ; resetPeriodConfiguration
?: ( { __typename
?: "MonthlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ ) | ( { __typename
?: "WeeklyResetPeriodConfig" } & ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_ ) | ( { __typename
?: "YearlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_ ) | null ; resourceId
?: string | null ; usageLimit
?: number | null ; usageUpdatedAt
?: any | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4686 Type declaration __typename: "Entitlement" Optional access Denied Reason?: AccessDeniedReason | null Optional current Usage?: number | null Optional customer Id?: string | null Optional entitlement Updated At?: any | null Optional feature?: ( { __typename?: "EntitlementFeature" } & FeatureFragment ) | null Optional has Soft Limit?: boolean | null has Unlimited Usage: boolean is Granted: boolean Optional next Reset Date?: any | null Optional requested Usage?: number | null Optional reset Period Configuration?: ( { __typename?: "MonthlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ ) | ( { __typename?: "WeeklyResetPeriodConfig" } & ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_ ) | ( { __typename?: "YearlyResetPeriodConfig" } & ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_ ) | null Optional resource Id?: string | null Optional usage Limit?: number | null Optional usage Updated At?: any | null Entitlement Options Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1186 Entitlement Usage Updated Fragment Entitlement
Usage
Updated
Fragment
: { __typename
?: "UsageUpdated" ; entitlement
: { __typename
?: "Entitlement" } & EntitlementFragment ; usage
: { __typename
?: "UsageMeasurementUpdated" } & UsageUpdatedFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4786 Entitlements Fallback Entitlements Fallback: {}
Entitlements Updated Payload Fragment Entitlements
Updated
Payload
Fragment
: { __typename
?: "EntitlementsUpdated" ; customerId
: string ; entitlements
: ( { __typename
?: "Entitlement" } & EntitlementFragment ) [] ; resourceId
?: string | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4778 Type declaration Optional __typename?: "EntitlementsUpdated" customer Id: string entitlements: ( { __typename?: "Entitlement" } & EntitlementFragment ) [] Optional resource Id?: string | null Environment Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1202 Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1211 Environment Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1225 Estimate Subscription Type declaration Optional billing Country Code?: string customer Id: string plan Id: string Optional promotion Code?: string Optional resource Id?: string Optional skip Trial?: boolean Optional start Date?: Date Optional unit Quantity?: number Estimate Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1369 Estimate Subscription Mutation Estimate
Subscription
Mutation
: { __typename
?: "Mutation" ; estimateSubscription
: { __typename
?: "SubscriptionPreview" } & SubscriptionPreviewFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5429 Estimate Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5426 Estimate Subscription Update Type declaration Optional promotion Code?: string subscription Id: string Optional unit Quantity?: number Estimate Subscription Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1385 Estimate Subscription Update Mutation Estimate
Subscription
Update
Mutation
: { __typename
?: "Mutation" ; estimateSubscriptionUpdate
: { __typename
?: "SubscriptionPreview" } & SubscriptionPreviewFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5438 Estimate Subscription Update Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5435 Events Fields Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1459 Events List Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1468 Exact Exact< T > : { [ K in keyof T ] : T [ K ] }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5 Type parameters Experiment Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1472 Experiment Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1484 Experiment Info Experiment
Info
: { groupName
: string ; groupType
?: ExperimentGroupType | null ; id
: string ; name
: string } Type declaration group Name: string id: string name: string Experiment Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1502 Experiment Stats Query Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1516 Experiment Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1526 Feature Associated Latest Packages Feature
Associated
Latest
Packages
: { environmentId
: Scalars [ "String" ] ; featureId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1542 Feature Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1546 Feature Fragment Feature
Fragment
: { __typename
: "EntitlementFeature" ; description
?: string | null ; displayName
: string ; featureType
: FeatureType ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; meterType
?: MeterType | null ; refId
: string } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4656 Type declaration __typename: "EntitlementFeature" Optional description?: string | null display Name: string Optional feature Units?: string | null Optional feature Units Plural?: string | null Optional meter Type?: MeterType | null ref Id: string Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1560 Feature Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1573 Feature Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1596 Feature Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1617 Fetch Entitlement Query Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1633 Fetch Entitlements Query Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1640 Fetch Usage History Fetch Usage History: { customerId: string ; endDate?: Date ; featureId: string ; resourceId?: string ; startDate: Date }
Type declaration customer Id: string Optional end Date?: Date feature Id: string Optional resource Id?: string start Date: Date Font Variant Fragment Font
Variant
Fragment
: { __typename
?: "FontVariant" ; fontSize
?: number | null ; fontWeight
?: FontWeight | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4728 Type declaration Optional __typename?: "FontVariant" Optional font Size?: number | null Optional font Weight?: FontWeight | null Font Variant Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1645 Get Active Subscriptions Get Active Subscriptions: { resourceId?: string | string [] }
Type declaration Optional resource Id?: string | string [] Get Active Subscriptions Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1654 Get Active Subscriptions Query Get
Active
Subscriptions
Query
: { __typename
?: "Query" ; getActiveSubscriptions
: ( { __typename
?: "CustomerSubscription" } & SubscriptionFragment ) [] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5560 Type declaration Optional __typename?: "Query" get Active Subscriptions: ( { __typename?: "CustomerSubscription" } & SubscriptionFragment ) [] Get Active Subscriptions Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5557 Get Boolean Entitlement Type declaration feature Id: string Optional resource Id?: string Get Checkout State Get Checkout State: { billingCountryCode?: string ; planId: string ; resourceId?: string | null }
Type declaration Optional billing Country Code?: string plan Id: string Optional resource Id?: string | null Get Checkout State Query Get
Checkout
State
Query
: { __typename
?: "Query" ; checkoutState
: { __typename
?: "CheckoutState" } & CheckoutStateFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5646 Get Checkout State Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5643 Get Checkout State Results Type declaration Optional active Subscription?: Subscription | null setup Secret: string Get Coupons Query Get
Coupons
Query
: { __typename
?: "Query" ; coupons
: { __typename
?: "CouponConnection" ; edges
: { __typename
?: "CouponEdge" ; node
: { __typename
?: "Coupon" } & CouponFragment } [] } } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5569 Type declaration Optional __typename?: "Query" coupons: { __typename?: "CouponConnection" ; edges: { __typename?: "CouponEdge" ; node: { __typename?: "Coupon" } & CouponFragment } [] } Optional __typename?: "CouponConnection" edges: { __typename?: "CouponEdge" ; node: { __typename?: "Coupon" } & CouponFragment } [] Get Coupons Query Variables Get
Coupons
Query
Variables
: Exact < {} > Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5566 Get Customer By Id Query Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5542 Get Customer By Id Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5539 Get Customer By Ref Id Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1660 Get Customer Portal Get Customer Portal: { productId?: string ; resourceId?: string }
Type declaration Optional product Id?: string Optional resource Id?: string Get Customer Portal By Ref Id Query Get
Customer
Portal
By
Ref
Id
Query
: { __typename
?: "Query" ; customerPortal
: { __typename
?: "CustomerPortal" } & CustomerPortalFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5637 Get Customer Portal By Ref Id Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5634 Get Customer Statistics Query Get
Customer
Statistics
Query
: { __typename
?: "Query" ; getCustomerByRefId
?: ( { __typename
?: "Customer" } & CustomerStatisticsFragment ) | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5551 Get Customer Statistics Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5548 Get Entitlement Query Get
Entitlement
Query
: { __typename
?: "Query" ; entitlement
: { __typename
?: "Entitlement" } & EntitlementFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5602 Get Entitlement Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5599 Get Entitlements Query Get
Entitlements
Query
: { __typename
?: "Query" ; entitlements
: ( { __typename
?: "Entitlement" } & EntitlementFragment ) [] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5593 Type declaration Optional __typename?: "Query" entitlements: ( { __typename?: "Entitlement" } & EntitlementFragment ) [] Get Entitlements Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5590 Get Metered Entitlement Type declaration feature Id: string Optional resource Id?: string Get Mock Paywall Query Get
Mock
Paywall
Query
: { __typename
?: "Query" ; mockPaywall
: { __typename
?: "MockPaywall" ; configuration
?: ( { __typename
?: "PaywallConfiguration" } & PaywallConfigurationFragment ) | null ; plans
: ( { __typename
?: "PaywallPlan" } & MockPaywallPlanFragment ) [] } } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5655 Get Mock Paywall Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5652 Get Numeric Entitlement Type declaration feature Id: string Optional resource Id?: string Get Package By Ref Id Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1664 Get Package Group Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1670 Get Paywall Get
Paywall
: { billingCountryCode
?: string ; context
?: WidgetType ; includeHiddenPlans
?: boolean ; productId
?: string ; resourceId
?: string } Type declaration Optional billing Country Code?: string Optional include Hidden Plans?: boolean Optional product Id?: string Optional resource Id?: string Get Paywall Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1678 Get Paywall Query Get
Paywall
Query
: { __typename
?: "Query" ; paywall
: { __typename
?: "Paywall" } & PaywallFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5584 Type declaration Optional __typename?: "Query" paywall: { __typename?: "Paywall" } & PaywallFragment Get Paywall Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5581 Get Products Query Get
Products
Query
: { __typename
?: "Query" ; products
: { __typename
?: "ProductConnection" ; edges
: { __typename
?: "ProductEdge" ; node
: { __typename
?: "Product" } & ProductFragment } [] } } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5611 Type declaration Optional __typename?: "Query" products: { __typename?: "ProductConnection" ; edges: { __typename?: "ProductEdge" ; node: { __typename?: "Product" } & ProductFragment } [] } Optional __typename?: "ProductConnection" edges: { __typename?: "ProductEdge" ; node: { __typename?: "Product" } & ProductFragment } [] Get Products Query Variables Get
Products
Query
Variables
: Exact < {} > Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5608 Get Sdk Configuration Query Get Sdk Configuration Query: { __typename?: "Query" ; sdkConfiguration?: { __typename?: "SdkConfiguration" ; isWidgetWatermarkEnabled?: boolean | null ; sentryDsn?: string | null } | null }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5626 Type declaration Optional __typename?: "Query" Optional sdk Configuration?: { __typename?: "SdkConfiguration" ; isWidgetWatermarkEnabled?: boolean | null ; sentryDsn?: string | null } | null Get Sdk Configuration Query Variables Get
Sdk
Configuration
Query
Variables
: Exact < {} > Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5623 Get Usage History Query Get
Usage
History
Query
: { __typename
?: "Query" ; usageHistory
: { __typename
?: "UsageHistory" } & UsageHistoryFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5670 Get Usage History Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5667 Get Widget Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1688 Grant Promotional Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1691 Grant Promotional Entitlements Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1704 Grant Promotional Entitlements Mutation Grant
Promotional
Entitlements
Mutation
: { __typename
?: "Mutation" ; grantPromotionalEntitlements
: ( { __typename
?: "PromotionalEntitlement" } & PromotionalEntitlementFragment ) [] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5367 Grant Promotional Entitlements Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5364 Hook Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1709 Hook Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1718 Hook Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1735 Hubspot Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1751 Immediate Subscription Preview Invoice Immediate Subscription Preview Invoice Fragment Immediate
Subscription
Preview
Invoice
Fragment
: { __typename
?: "ImmediateSubscriptionPreviewInvoice" ; credits
?: { __typename
?: "SubscriptionPreviewCredits" ; initial
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; remaining
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; used
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } } | null ; discount
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; discountDetails
?: { __typename
?: "SubscriptionPreviewDiscount" ; durationInMonths
?: number | null ; durationType
: DiscountDurationType ; type
: DiscountType ; value
: number } | null ; proration
?: { __typename
?: "SubscriptionPreviewProrations" ; credit
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; debit
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; hasProrations
?: boolean | null ; netAmount
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; prorationDate
: any } | null ; subTotal
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; tax
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; taxDetails
?: { __typename
?: "SubscriptionPreviewTaxDetails" ; displayName
: string ; inclusive
: boolean ; percentage
: number } | null ; total
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; totalExcludingTax
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4561 Type declaration Optional __typename?: "ImmediateSubscriptionPreviewInvoice" Optional credits?: { __typename?: "SubscriptionPreviewCredits" ; initial: { __typename?: "Money" ; amount: number ; currency: Currency } ; remaining: { __typename?: "Money" ; amount: number ; currency: Currency } ; used: { __typename?: "Money" ; amount: number ; currency: Currency } } | null Optional discount?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional discount Details?: { __typename?: "SubscriptionPreviewDiscount" ; durationInMonths?: number | null ; durationType: DiscountDurationType ; type: DiscountType ; value: number } | null Optional proration?: { __typename?: "SubscriptionPreviewProrations" ; credit: { __typename?: "Money" ; amount: number ; currency: Currency } ; debit: { __typename?: "Money" ; amount: number ; currency: Currency } ; hasProrations?: boolean | null ; netAmount: { __typename?: "Money" ; amount: number ; currency: Currency } ; prorationDate: any } | null sub Total: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number Optional tax?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional tax Details?: { __typename?: "SubscriptionPreviewTaxDetails" ; displayName: string ; inclusive: boolean ; percentage: number } | null total: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number total Excluding Tax: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number Import Customer Bulk Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1755 Import Customer Bulk Mutation Import Customer Bulk Mutation: { __typename?: "Mutation" ; importCustomersBulk?: string | null }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5333 Type declaration Optional __typename?: "Mutation" Optional import Customers Bulk?: string | null Import Customer Bulk Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5330 Import Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1759 Import Customer Mutation Import
Customer
Mutation
: { __typename
?: "Mutation" ; importCustomer
: { __typename
?: "Customer" } & SlimCustomerFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5340 Import Customer Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5337 Import Integration Catalog Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1771 Import Integration Customers Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1783 Import Integration Task Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1791 Import Integration Task Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1800 Import Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1812 Import Subscriptions Bulk Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1824 Import Subscriptions Bulk Mutation Import Subscriptions Bulk Mutation: { __typename?: "Mutation" ; importSubscriptionsBulk?: string | null }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5404 Type declaration Optional __typename?: "Mutation" Optional import Subscriptions Bulk?: string | null Import Subscriptions Bulk Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5401 Init Add Stripe Customer Payment Method Input Init
Add
Stripe
Customer
Payment
Method
Input
: { customerRefId
: Scalars [ "String" ] ; environmentId
?: InputMaybe < Scalars [ "String" ] > } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1828 Input Maybe Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4 Type parameters Int Field Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1832 Int Field Comparison Between Int
Field
Comparison
Between
: { lower
: Scalars [ "Int" ] ; upper
: Scalars [ "Int" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1846 Integration Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1850 Integration Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1858 Layout Configuration Fragment Layout
Configuration
Fragment
: { __typename
?: "PaywallLayoutConfiguration" ; alignment
?: Alignment | null ; planMargin
?: number | null ; planPadding
?: number | null ; planWidth
?: number | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4733 Type declaration Optional __typename?: "PaywallLayoutConfiguration" Optional alignment?: Alignment | null Optional plan Margin?: number | null Optional plan Padding?: number | null Optional plan Width?: number | null List Aws Product Dimensions Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1869 List Aws Products Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1873 Make Maybe Make
Maybe
< T , K > : Omit < T , K > & { [ SubKey in K ] : Maybe < T [ SubKey ] > } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:13 Type parameters Make Optional Make
Optional
< T , K > : Omit < T , K > & { [ SubKey in K ] ?: Maybe < T [ SubKey ] > } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:10 Type parameters Mark Invoice As Paid Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1877 Maybe Maybe< T > : T | null
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3 Type parameters Member Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1883 Member Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1889 Merge Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1904 Meter Aggregation Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1918 Meter Condition Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1922 Meter Filter Definition Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1927 Meter Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1936 Metered Entitlement Fallback Metered Entitlement Fallback: { hasAccess: boolean ; isUnlimited?: boolean ; usageLimit?: number }
Type declaration has Access: boolean Optional is Unlimited?: boolean Optional usage Limit?: number Metered Entitlement Options Type declaration Optional requested Usage?: number Optional should Track?: boolean Migrate Subscription To Latest Mutation Migrate Subscription To Latest Mutation: { __typename?: "Mutation" ; migrateSubscriptionToLatest: { __typename?: "CustomerSubscription" ; subscriptionId: string } }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5504 Type declaration Optional __typename?: "Mutation" migrate Subscription To Latest: { __typename?: "CustomerSubscription" ; subscriptionId: string } Optional __typename?: "CustomerSubscription" subscription Id: string Migrate Subscription To Latest Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5501 Minimum Spend Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1953 Mock Paywall Addon Dependency Fragment Mock Paywall Addon Dependency Fragment: { __typename?: "PaywallAddon" ; description?: string | null ; displayName: string ; refId: string }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5157 Type declaration Optional __typename?: "PaywallAddon" Optional description?: string | null display Name: string ref Id: string Mock Paywall Addon Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5163 Type declaration Optional __typename?: "PaywallAddon" Optional additional Meta Data?: any | null Optional billing Id?: string | null Optional description?: string | null display Name: string Optional max Quantity?: number | null Optional pricing Type?: PricingType | null ref Id: string Mock Paywall Package Entitlement Fragment Mock
Paywall
Package
Entitlement
Fragment
: { __typename
?: "Entitlement" ; displayNameOverride
?: string | null ; feature
?: { __typename
?: "EntitlementFeature" ; additionalMetaData
?: any | null ; description
?: string | null ; displayName
: string ; featureType
: FeatureType ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; meterType
?: MeterType | null ; refId
: string } | null ; hasSoftLimit
?: boolean | null ; hasUnlimitedUsage
: boolean ; hiddenFromWidgets
?: WidgetType [] | null ; resetPeriod
?: EntitlementResetPeriod | null ; usageLimit
?: number | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5080 Type declaration Optional __typename?: "Entitlement" Optional display Name Override?: string | null Optional feature?: { __typename?: "EntitlementFeature" ; additionalMetaData?: any | null ; description?: string | null ; displayName: string ; featureType: FeatureType ; featureUnits?: string | null ; featureUnitsPlural?: string | null ; meterType?: MeterType | null ; refId: string } | null Optional has Soft Limit?: boolean | null has Unlimited Usage: boolean Optional hidden From Widgets?: WidgetType [] | null Optional usage Limit?: number | null Mock Paywall Plan Compatible Package Groups Fragment Mock
Paywall
Plan
Compatible
Package
Groups
Fragment
: { __typename
?: "PaywallPlanCompatiblePackageGroup" ; addons
?: ( { __typename
?: "PaywallAddon" } & MockPaywallAddonFragment ) [] | null ; description
?: string | null ; displayName
: string ; options
: { __typename
?: "PaywallPlanCompatiblePackageGroupOptions" ; freeItems
?: number | null ; minItems
?: number | null } ; packageGroupId
: string } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5143 Type declaration Optional __typename?: "PaywallPlanCompatiblePackageGroup" Optional addons?: ( { __typename?: "PaywallAddon" } & MockPaywallAddonFragment ) [] | null Optional description?: string | null display Name: string options: { __typename?: "PaywallPlanCompatiblePackageGroupOptions" ; freeItems?: number | null ; minItems?: number | null } Optional __typename?: "PaywallPlanCompatiblePackageGroupOptions" Optional free Items?: number | null Optional min Items?: number | null package Group Id: string Mock Paywall Plan Fragment Mock
Paywall
Plan
Fragment
: { __typename
?: "PaywallPlan" ; additionalMetaData
?: any | null ; basePlan
?: { __typename
?: "PaywallBasePlan" ; displayName
: string ; refId
: string } | null ; billingId
?: string | null ; compatibleAddons
?: ( { __typename
?: "PaywallAddon" } & MockPaywallAddonFragment ) [] | null ; compatiblePackageGroups
?: ( { __typename
?: "PaywallPlanCompatiblePackageGroup" } & MockPaywallPlanCompatiblePackageGroupsFragment ) [] | null ; defaultTrialConfig
?: { __typename
?: "DefaultTrialConfig" ; duration
: number ; units
: TrialPeriodUnits } | null ; description
?: string | null ; displayName
: string ; entitlements
?: ( { __typename
?: "Entitlement" } & MockPaywallPackageEntitlementFragment ) [] | null ; inheritedEntitlements
?: ( { __typename
?: "Entitlement" } & MockPaywallPackageEntitlementFragment ) [] | null ; prices
: ( { __typename
?: "PaywallPrice" } & MockPaywallPriceFragment ) [] ; pricingType
?: PricingType | null ; product
: { __typename
?: "PaywallProduct" ; additionalMetaData
?: any | null ; description
?: string | null ; displayName
?: string | null ; refId
: string } ; refId
: string } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5039 Type declaration Optional __typename?: "PaywallPlan" Optional additional Meta Data?: any | null Optional base Plan?: { __typename?: "PaywallBasePlan" ; displayName: string ; refId: string } | null Optional billing Id?: string | null Optional compatible Addons?: ( { __typename?: "PaywallAddon" } & MockPaywallAddonFragment ) [] | null Optional compatible Package Groups?: ( { __typename?: "PaywallPlanCompatiblePackageGroup" } & MockPaywallPlanCompatiblePackageGroupsFragment ) [] | null Optional default Trial Config?: { __typename?: "DefaultTrialConfig" ; duration: number ; units: TrialPeriodUnits } | null Optional description?: string | null display Name: string Optional inherited Entitlements?: ( { __typename?: "Entitlement" } & MockPaywallPackageEntitlementFragment ) [] | null Optional pricing Type?: PricingType | null product: { __typename?: "PaywallProduct" ; additionalMetaData?: any | null ; description?: string | null ; displayName?: string | null ; refId: string } Optional __typename?: "PaywallProduct" Optional additional Meta Data?: any | null Optional description?: string | null Optional display Name?: string | null ref Id: string ref Id: string Mock Paywall Price Fragment Mock
Paywall
Price
Fragment
: { __typename
?: "PaywallPrice" ; billingCountryCode
?: string | null ; billingId
?: string | null ; billingModel
: BillingModel ; billingPeriod
: BillingPeriod ; blockSize
?: number | null ; feature
?: { __typename
?: "EntitlementFeature" ; displayName
: string ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; refId
: string } | null ; maxUnitQuantity
?: number | null ; minUnitQuantity
?: number | null ; price
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; tiers
?: ( { __typename
?: "PriceTier" } & PriceTierFragment ) [] | null ; tiersMode
?: TiersMode | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5100 Type declaration Optional __typename?: "PaywallPrice" Optional billing Country Code?: string | null Optional billing Id?: string | null Optional block Size?: number | null Optional feature?: { __typename?: "EntitlementFeature" ; displayName: string ; featureUnits?: string | null ; featureUnitsPlural?: string | null ; refId: string } | null Optional max Unit Quantity?: number | null Optional min Unit Quantity?: number | null Optional price?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional tiers?: ( { __typename?: "PriceTier" } & PriceTierFragment ) [] | null Optional tiers Mode?: TiersMode | null Money Money: { amount: number ; currency: string }
Type declaration amount: number currency: string Money Input Dto Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1959 Monthly Reset Period Config Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1968 Number Field Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1971 Number Field Comparison Between Number
Field
Comparison
Between
: { lower
: Scalars [ "Float" ] ; upper
: Scalars [ "Float" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1985 Numeric Entitlement Fallback Numeric Entitlement Fallback: { hasAccess: boolean ; isUnlimited?: boolean ; value?: number }
Type declaration has Access: boolean Optional is Unlimited?: boolean Optional value?: number Numeric Entitlement Options Type declaration Optional should Track?: boolean On Entitlements Updated Subscription Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5679 Type declaration Optional __typename?: "Subscription" On Entitlements Updated Subscription Variables On
Entitlements
Updated
Subscription
Variables
: Exact < {} > Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5676 On Package Published Subscription Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5697 Type declaration Optional __typename?: "Subscription" On Package Published Subscription Variables On
Package
Published
Subscription
Variables
: Exact < {} > Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5694 On Usage Updated Subscription Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5688 Type declaration Optional __typename?: "Subscription" On Usage Updated Subscription Variables On
Usage
Updated
Subscription
Variables
: Exact < {} > Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5685 Overage Entitlement Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1994 Overage Price Fragment Overage
Price
Fragment
: { __typename
?: "Price" ; billingCountryCode
?: string | null ; billingId
?: string | null ; billingModel
: BillingModel ; billingPeriod
: BillingPeriod ; feature
?: { __typename
?: "Feature" ; description
?: string | null ; displayName
: string ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; refId
: string } | null ; price
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; tiers
?: ( { __typename
?: "PriceTier" } & PriceTierFragment ) [] | null ; tiersMode
?: TiersMode | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3986 Type declaration Optional __typename?: "Price" Optional billing Country Code?: string | null Optional billing Id?: string | null Optional feature?: { __typename?: "Feature" ; description?: string | null ; displayName: string ; featureUnits?: string | null ; featureUnitsPlural?: string | null ; refId: string } | null Optional price?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional tiers?: ( { __typename?: "PriceTier" } & PriceTierFragment ) [] | null Optional tiers Mode?: TiersMode | null Overage Pricing Model Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2009 Package Dto Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2016 Package Dto Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2033 Package Entitlement Type declaration Optional display Name Override?: PackageEntitlementFragment [ "displayNameOverride" ] Optional has Unlimited Usage?: boolean | null Optional is Custom?: boolean usage Limit: number Package Entitlement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2053 Package Entitlement Filter Feature Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2064 Package Entitlement Filter Package Dto Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2078 Package Entitlement Fragment Package
Entitlement
Fragment
: { __typename
?: "PackageEntitlement" ; displayNameOverride
?: string | null ; feature
: { __typename
?: "Feature" ; additionalMetaData
?: any | null ; description
?: string | null ; displayName
: string ; featureType
: FeatureType ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; meterType
?: MeterType | null ; refId
: string } ; featureId
: string ; hasSoftLimit
?: boolean | null ; hasUnlimitedUsage
?: boolean | null ; hiddenFromWidgets
?: WidgetType [] | null ; isCustom
?: boolean | null ; resetPeriod
?: EntitlementResetPeriod | null ; usageLimit
?: number | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4023 Type declaration Optional __typename?: "PackageEntitlement" Optional display Name Override?: string | null feature: { __typename?: "Feature" ; additionalMetaData?: any | null ; description?: string | null ; displayName: string ; featureType: FeatureType ; featureUnits?: string | null ; featureUnitsPlural?: string | null ; meterType?: MeterType | null ; refId: string } Optional __typename?: "Feature" Optional additional Meta Data?: any | null Optional description?: string | null display Name: string Optional feature Units?: string | null Optional feature Units Plural?: string | null Optional meter Type?: MeterType | null ref Id: string feature Id: string Optional has Soft Limit?: boolean | null Optional has Unlimited Usage?: boolean | null Optional hidden From Widgets?: WidgetType [] | null Optional is Custom?: boolean | null Optional usage Limit?: number | null Package Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2095 Package Entitlement Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2112 Package Entitlement Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2124 Package Group Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2138 Package Group Filter Product Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2152 Package Group Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2166 Package Group Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2191 Package Pricing Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2207 Package Publish Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2218 Package Published Payload Fragment Package
Published
Payload
Fragment
: { __typename
?: "PackagePublished" ; accountId
: string ; environmentId
: string ; migrationType
: PublishMigrationType ; packageRefId
: string ; packageType
: string ; packageVersion
: number } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4795 Type declaration Optional __typename?: "PackagePublished" account Id: string environment Id: string package Ref Id: string package Type: string package Version: number Package Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2228 Payment Collection Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2251 Payment Method Details Payment Method Details: { expirationMonth?: number | null ; expirationYear?: number | null ; last4Digits?: string | null }
Type declaration Optional expiration Month?: number | null Optional expiration Year?: number | null Optional last4 Digits?: string | null Paywall Calculated Price Point Paywall Calculated Price Points Fragment Paywall
Calculated
Price
Points
Fragment
: { __typename
?: "PaywallPricePoint" ; additionalChargesMayApply
?: boolean | null ; amount
: number ; billingCountryCode
?: string | null ; billingPeriod
: BillingPeriod ; currency
: Currency ; feature
?: { __typename
?: "Feature" ; description
?: string | null ; displayName
: string ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; refId
: string } | null ; planId
: string } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5126 Type declaration Optional __typename?: "PaywallPricePoint" Optional additional Charges May Apply?: boolean | null amount: number Optional billing Country Code?: string | null Optional feature?: { __typename?: "Feature" ; description?: string | null ; displayName: string ; featureUnits?: string | null ; featureUnitsPlural?: string | null ; refId: string } | null plan Id: string Paywall Colors Palette Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2279 Paywall Configuration Fragment Paywall
Configuration
Fragment
: { __typename
?: "PaywallConfiguration" ; customCss
?: string | null ; layout
?: ( { __typename
?: "PaywallLayoutConfiguration" } & LayoutConfigurationFragment ) | null ; palette
?: { __typename
?: "PaywallColorsPalette" ; backgroundColor
?: string | null ; borderColor
?: string | null ; currentPlanBackground
?: string | null ; primary
?: string | null ; textColor
?: string | null } | null ; typography
?: ( { __typename
?: "TypographyConfiguration" } & TypographyConfigurationFragment ) | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4740 Type declaration Optional __typename?: "PaywallConfiguration" Optional custom Css?: string | null Optional layout?: ( { __typename?: "PaywallLayoutConfiguration" } & LayoutConfigurationFragment ) | null Optional palette?: { __typename?: "PaywallColorsPalette" ; backgroundColor?: string | null ; borderColor?: string | null ; currentPlanBackground?: string | null ; primary?: string | null ; textColor?: string | null } | null Optional typography?: ( { __typename?: "TypographyConfiguration" } & TypographyConfigurationFragment ) | null Paywall Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2286 Paywall Currency Fragment Paywall
Currency
Fragment
: { __typename
?: "PaywallCurrency" ; code
: Currency ; symbol
: string } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4758 Type declaration Optional __typename?: "PaywallCurrency" symbol: string Paywall Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5182 Paywall Layout Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2292 Plan Type declaration Optional base Plan?: BasePlan Optional billing Id?: string | null compatible Addons: Addon [] Optional default Trial Config?: DefaultTrialConfig | null Optional description?: string | null display Name: string id: string Optional metadata?: Metadata | null order: number price Points: Price [] Optional pricing Type?: PricingType | null Plan Compatible Package Groups Fragment Plan
Compatible
Package
Groups
Fragment
: { __typename
?: "PlanCompatiblePackageGroups" ; addons
?: ( { __typename
?: "Addon" } & AddonFragment ) [] | null ; displayName
: string ; options
: { __typename
?: "PlanCompatiblePackageGroupOptions" ; freeItems
?: number | null ; minItems
?: number | null } ; packageGroupId
: string } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4118 Type declaration Optional __typename?: "PlanCompatiblePackageGroups" Optional addons?: ( { __typename?: "Addon" } & AddonFragment ) [] | null display Name: string options: { __typename?: "PlanCompatiblePackageGroupOptions" ; freeItems?: number | null ; minItems?: number | null } Optional __typename?: "PlanCompatiblePackageGroupOptions" Optional free Items?: number | null Optional min Items?: number | null package Group Id: string Plan Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2307 Plan Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2321 Plan Filter Addon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2340 Plan Filter Product Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2357 Plan Fragment Plan
Fragment
: { __typename
?: "Plan" ; additionalMetaData
?: any | null ; basePlan
?: { __typename
?: "Plan" ; displayName
: string ; refId
: string } | null ; billingId
?: string | null ; compatibleAddons
?: ( { __typename
?: "Addon" } & AddonFragment ) [] | null ; compatiblePackageGroups
?: ( { __typename
?: "PlanCompatiblePackageGroups" } & PlanCompatiblePackageGroupsFragment ) [] | null ; defaultTrialConfig
?: { __typename
?: "DefaultTrialConfig" ; duration
: number ; units
: TrialPeriodUnits } | null ; description
?: string | null ; displayName
: string ; entitlements
?: ( { __typename
?: "PackageEntitlement" } & PackageEntitlementFragment ) [] | null ; hiddenFromWidgets
?: WidgetType [] | null ; id
: string ; inheritedEntitlements
?: ( { __typename
?: "PackageEntitlement" } & PackageEntitlementFragment ) [] | null ; overagePrices
?: ( { __typename
?: "Price" } & OveragePriceFragment ) [] | null ; prices
?: ( { __typename
?: "Price" } & PriceFragment ) [] | null ; pricingType
?: PricingType | null ; product
: { __typename
?: "Product" } & ProductFragment ; refId
: string ; versionNumber
: number } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4075 Type declaration Optional __typename?: "Plan" Optional additional Meta Data?: any | null Optional base Plan?: { __typename?: "Plan" ; displayName: string ; refId: string } | null Optional billing Id?: string | null Optional compatible Addons?: ( { __typename?: "Addon" } & AddonFragment ) [] | null Optional compatible Package Groups?: ( { __typename?: "PlanCompatiblePackageGroups" } & PlanCompatiblePackageGroupsFragment ) [] | null Optional default Trial Config?: { __typename?: "DefaultTrialConfig" ; duration: number ; units: TrialPeriodUnits } | null Optional description?: string | null display Name: string Optional entitlements?: ( { __typename?: "PackageEntitlement" } & PackageEntitlementFragment ) [] | null Optional hidden From Widgets?: WidgetType [] | null id: string Optional inherited Entitlements?: ( { __typename?: "PackageEntitlement" } & PackageEntitlementFragment ) [] | null Optional overage Prices?: ( { __typename?: "Price" } & OveragePriceFragment ) [] | null Optional prices?: ( { __typename?: "Price" } & PriceFragment ) [] | null Optional pricing Type?: PricingType | null product: { __typename?: "Product" } & ProductFragment ref Id: string version Number: number Plan Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2371 Plan Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2391 Preview Next Invoice Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2405 Preview Subscription Type declaration Optional billing Country Code?: string customer Id: string plan Id: string Optional promotion Code?: string Optional resource Id?: string Optional start Date?: Date Optional unit Quantity?: number Preview Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2411 Preview Subscription Mutation Preview
Subscription
Mutation
: { __typename
?: "Mutation" ; previewSubscription
: { __typename
?: "SubscriptionPreviewV2" } & SubscriptionPreviewV2Fragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5447 Preview Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5444 Price Price
: { amount
?: number | null ; billingCountryCode
?: string | null ; billingId
?: string | null ; billingPeriod
: BillingPeriod ; blockSize
?: number | null ; 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 billing Country Code?: string | null Optional billing Id?: string | null Optional block Size?: number | null Optional feature?: { displayName: string ; featureId: string ; unitQuantity?: number | null ; units?: string | null ; unitsPlural?: string | null } | null is Tiered Price: boolean Optional max Unit Quantity?: number | null Optional min Unit Quantity?: number | null tiers Mode: TiersMode | null | undefined Price Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2426 Price Filter Package Dto Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2438 Price Fragment Price
Fragment
: { __typename
?: "Price" ; billingCadence
: BillingCadence ; billingCountryCode
?: string | null ; billingId
?: string | null ; billingModel
: BillingModel ; billingPeriod
: BillingPeriod ; blockSize
?: number | null ; feature
?: { __typename
?: "Feature" ; description
?: string | null ; displayName
: string ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; refId
: string } | null ; maxUnitQuantity
?: number | null ; minUnitQuantity
?: number | null ; price
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; tiers
?: ( { __typename
?: "PriceTier" } & PriceTierFragment ) [] | null ; tiersMode
?: TiersMode | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3958 Type declaration Optional __typename?: "Price" Optional billing Country Code?: string | null Optional billing Id?: string | null Optional block Size?: number | null Optional feature?: { __typename?: "Feature" ; description?: string | null ; displayName: string ; featureUnits?: string | null ; featureUnitsPlural?: string | null ; refId: string } | null Optional max Unit Quantity?: number | null Optional min Unit Quantity?: number | null Optional price?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional tiers?: ( { __typename?: "PriceTier" } & PriceTierFragment ) [] | null Optional tiers Mode?: TiersMode | null Price Override Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2455 Price Period Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2465 Price Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2473 Price Tier Fragment Price
Tier
Fragment
: { __typename
?: "PriceTier" ; flatPrice
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; unitPrice
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; upTo
?: number | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3944 Type declaration Optional __typename?: "PriceTier" Optional flat Price?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional unit Price?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional up To?: number | null Price Tier Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2487 Pricing Model Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2492 Pricing Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2507 Product Product: { description?: string | null ; displayName?: string | null ; id: string ; metadata?: Metadata | null }
Type declaration Optional description?: string | null Optional display Name?: string | null id: string Optional metadata?: Metadata | null Product Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2523 Product Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2531 Product Fragment Product Fragment: { __typename?: "Product" ; additionalMetaData?: any | null ; description?: string | null ; displayName?: string | null ; productSettings: { __typename?: "ProductSettings" ; downgradePlan?: { __typename?: "Plan" ; displayName: string ; refId: string } | null } ; refId: string }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4763 Type declaration Optional __typename?: "Product" Optional additional Meta Data?: any | null Optional description?: string | null Optional display Name?: string | null product Settings: { __typename?: "ProductSettings" ; downgradePlan?: { __typename?: "Plan" ; displayName: string ; refId: string } | null } Optional __typename?: "ProductSettings" Optional downgrade Plan?: { __typename?: "Plan" ; displayName: string ; refId: string } | null ref Id: string Product Settings Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2545 Product Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2554 Product Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2571 Promotional Entitlement Type declaration Optional expires At?: Date has Expiration Date: boolean Optional has Unlimited Usage?: boolean | null is Visible: boolean usage Limit: number Promotional Entitlement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2578 Promotional Entitlement Fragment Promotional
Entitlement
Fragment
: { __typename
?: "PromotionalEntitlement" ; endDate
?: any | null ; feature
: { __typename
?: "Feature" ; additionalMetaData
?: any | null ; description
?: string | null ; displayName
: string ; featureType
: FeatureType ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; meterType
?: MeterType | null ; refId
: string } ; featureId
: string ; hasSoftLimit
?: boolean | null ; hasUnlimitedUsage
?: boolean | null ; isVisible
: boolean ; resetPeriod
?: EntitlementResetPeriod | null ; status
: PromotionalEntitlementStatus ; usageLimit
?: number | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4308 Type declaration Optional __typename?: "PromotionalEntitlement" Optional end Date?: any | null feature: { __typename?: "Feature" ; additionalMetaData?: any | null ; description?: string | null ; displayName: string ; featureType: FeatureType ; featureUnits?: string | null ; featureUnitsPlural?: string | null ; meterType?: MeterType | null ; refId: string } Optional __typename?: "Feature" Optional additional Meta Data?: any | null Optional description?: string | null display Name: string Optional feature Units?: string | null Optional feature Units Plural?: string | null Optional meter Type?: MeterType | null ref Id: string feature Id: string Optional has Soft Limit?: boolean | null Optional has Unlimited Usage?: boolean | null is Visible: boolean Optional usage Limit?: number | null Promotional Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2587 Promotional Entitlement Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2612 Promotional Entitlement Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2630 Promotional Entitlement Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2646 Provision Customer Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5231 Type declaration Optional __typename?: "ProvisionedCustomer" Optional entitlements?: ( { __typename?: "Entitlement" } & EntitlementFragment ) [] | null Optional subscription?: ( { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment ) | null Provision Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2662 Provision Customer Mutation Provision
Customer
Mutation
: { __typename
?: "Mutation" ; provisionCustomer
: { __typename
?: "ProvisionedCustomer" } & ProvisionCustomerFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5324 Provision Customer Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5321 Provision Customer Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2680 Provision Sandbox Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2709 Provision Subscription Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2713 Provision Subscription Fragment Provision
Subscription
Fragment
: { __typename
?: "ProvisionSubscriptionResult" ; checkoutBillingId
?: string | null ; checkoutUrl
?: string | null ; entitlements
?: ( { __typename
?: "Entitlement" } & EntitlementFragment ) [] | null ; status
: ProvisionSubscriptionStatus ; subscription
?: ( { __typename
?: "CustomerSubscription" } & SlimSubscriptionFragment ) | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5253 Type declaration Optional __typename?: "ProvisionSubscriptionResult" Optional checkout Billing Id?: string | null Optional checkout Url?: string | null Optional entitlements?: ( { __typename?: "Entitlement" } & EntitlementFragment ) [] | null Optional subscription?: ( { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment ) | null Provision Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2746 Provision Subscription Mutation Provision
Subscription
Mutation
: { __typename
?: "Mutation" ; provisionSubscription
: { __typename
?: "ProvisionSubscriptionResult" } & ProvisionSubscriptionFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5386 Provision Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5383 Recalculate Entitlements Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2789 Recalculate Entitlements Side Effects Options Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2795 Remove Base Plan From Plan Input Remove
Base
Plan
From
Plan
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2801 Remove Compatible Addons From Plan Input Remove
Compatible
Addons
From
Plan
Input
: { id
: Scalars [ "String" ] ; relationIds
: Scalars [ "String" ] [] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2807 Remove Coupon From Customer Input Remove
Coupon
From
Customer
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2813 Remove Coupon From Customer Subscription Input Remove
Coupon
From
Customer
Subscription
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2819 Remove Experiment From Customer Input Remove
Experiment
From
Customer
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2825 Remove Experiment From Customer Subscription Input Remove
Experiment
From
Customer
Subscription
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2831 Report Entitlement Check Requested Mutation Report Entitlement Check Requested Mutation: { __typename?: "Mutation" ; reportEntitlementCheckRequested: boolean }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5488 Type declaration Optional __typename?: "Mutation" report Entitlement Check Requested: boolean Report Entitlement Check Requested Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5485 Report Event Mutation Report Event Mutation: { __typename?: "Mutation" ; reportEvent?: string | null }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5481 Type declaration Optional __typename?: "Mutation" Optional report Event?: string | null Report Event Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5478 Report Usage Base Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2837 Report Usage Bulk Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2845 Report Usage Bulk Mutation Report
Usage
Bulk
Mutation
: { __typename
?: "Mutation" ; reportUsageBulk
: ( { __typename
?: "UsageMeasurementWithCurrentUsage" } & ReportUsageFragment ) [] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5472 Type declaration Optional __typename?: "Mutation" report Usage Bulk: ( { __typename?: "UsageMeasurementWithCurrentUsage" } & ReportUsageFragment ) [] Report Usage Bulk Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5469 Report Usage Fragment Report Usage Fragment: { __typename?: "UsageMeasurementWithCurrentUsage" ; currentUsage?: number | null ; customerId: string ; featureId: string ; id: string ; nextResetDate?: any | null ; resourceId?: string | null ; timestamp: any }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5265 Type declaration Optional __typename?: "UsageMeasurementWithCurrentUsage" Optional current Usage?: number | null customer Id: string feature Id: string id: string Optional next Reset Date?: any | null Optional resource Id?: string | null timestamp: any Report Usage Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2849 Report Usage Mutation Report
Usage
Mutation
: { __typename
?: "Mutation" ; reportUsage
: { __typename
?: "UsageMeasurementWithCurrentUsage" } & ReportUsageFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5463 Type declaration Optional __typename?: "Mutation" report Usage: { __typename?: "UsageMeasurementWithCurrentUsage" } & ReportUsageFragment Report Usage Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5460 Reset Period Configuration Fragment Reset Period Configuration Fragment: ResetPeriodConfigurationFragment_MonthlyResetPeriodConfig_ | ResetPeriodConfigurationFragment_WeeklyResetPeriodConfig_ | ResetPeriodConfigurationFragment_YearlyResetPeriodConfig_
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4677 Resync Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2858 Revoke Promotional Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2862 Revoke Promotional Entitlement Mutation Revoke Promotional Entitlement Mutation: { __typename?: "Mutation" ; revokePromotionalEntitlement: { __typename?: "PromotionalEntitlement" ; id: string } }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5376 Type declaration Optional __typename?: "Mutation" revoke Promotional Entitlement: { __typename?: "PromotionalEntitlement" ; id: string } Optional __typename?: "PromotionalEntitlement" id: string Revoke Promotional Entitlement Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5373 Salesforce Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2867 Scalars Scalars: { Boolean: boolean ; ConnectionCursor: any ; DateTime: any ; Float: number ; ID: string ; Int: number ; JSON: any ; String: string }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:17 Type declaration Boolean: boolean Connection Cursor: any Date Time: any Float: number ID: string Int: number JSON: any String: string Schedule Variables Fragment Schedule Variables Fragment: ScheduleVariablesFragment_AddonChangeVariables_ | ScheduleVariablesFragment_BillingPeriodChangeVariables_ | ScheduleVariablesFragment_DowngradeChangeVariables_ | ScheduleVariablesFragment_PlanChangeVariables_ | ScheduleVariablesFragment_UnitAmountChangeVariables_
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5320 Sdk Sdk
: ReturnType < typeof getSdk > Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5851 Sdk Function Wrapper Sdk Function Wrapper: < T > ( action: ( requestHeaders?: Record < string , string > ) => Promise < T > , operationName: string , operationType?: string ) => Promise < T >
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5807 Type declaration < T > ( action: ( requestHeaders?: Record < string , string > ) => Promise < T > , operationName: string , operationType?: string ) : Promise < T > Type parameters Parameters action: ( requestHeaders?: Record < string , string > ) => Promise < T > ( requestHeaders?: Record < string , string > ) : Promise < T > Parameters Optional requestHeaders: Record < string , string > Returns Promise < T > operationName: string Optional operationType: string Returns Promise < T > Set Base Plan On Plan Input Set
Base
Plan
On
Plan
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2879 Set Compatible Addons On Plan Input Set
Compatible
Addons
On
Plan
Input
: { id
: Scalars [ "String" ] ; relationIds
: Scalars [ "String" ] [] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2885 Set Coupon On Customer Input Set
Coupon
On
Customer
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2891 Set Coupon On Customer Subscription Input Set
Coupon
On
Customer
Subscription
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2897 Set Experiment On Customer Input Set
Experiment
On
Customer
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2903 Set Experiment On Customer Subscription Input Set
Experiment
On
Customer
Subscription
Input
: { id
: Scalars [ "String" ] ; relationId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2909 Set Package Group Addons Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2916 Set Plan Compatible Package Group Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2925 Set Plan Compatible Package Group Options Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2932 Set Plan Compatible Package Groups Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2939 Slim Customer Fragment Slim Customer Fragment: { __typename?: "Customer" ; additionalMetaData?: any | null ; awsMarketplaceCustomerId?: string | null ; billingId?: string | null ; createdAt?: any | null ; customerId: string ; email?: string | null ; id: string ; name?: string | null ; refId: string ; updatedAt: any }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4330 Type declaration Optional __typename?: "Customer" Optional additional Meta Data?: any | null Optional aws Marketplace Customer Id?: string | null Optional billing Id?: string | null Optional created At?: any | null customer Id: string Optional email?: string | null id: string Optional name?: string | null ref Id: string updated At: any Slim Subscription Fragment Slim
Subscription
Fragment
: { __typename
?: "CustomerSubscription" ; additionalMetaData
?: any | null ; addons
?: { __typename
?: "SubscriptionAddon" ; addon
: { __typename
?: "Addon" ; id
: string ; refId
: string } ; quantity
: number } [] | null ; billingId
?: string | null ; billingLinkUrl
?: string | null ; billingSyncError
?: string | null ; currentBillingPeriodEnd
?: any | null ; customer
: { __typename
?: "Customer" ; id
: string ; refId
: string } ; effectiveEndDate
?: any | null ; experimentInfo
?: { __typename
?: "experimentInfo" ; groupName
: string ; groupType
: ExperimentGroupType ; id
: string ; name
: string } | null ; id
: string ; latestInvoice
?: ( { __typename
?: "SubscriptionInvoice" } & SubscriptionInvoiceFragment ) | null ; paymentCollection
: PaymentCollection ; plan
: { __typename
?: "Plan" ; id
: string ; refId
: string } ; prices
?: { __typename
?: "SubscriptionPrice" ; price
?: ( { __typename
?: "Price" } & PriceFragment ) | null ; usageLimit
?: number | null } [] | null ; pricingType
: PricingType ; refId
: string ; resource
?: ( { __typename
?: "CustomerResource" } & CustomerResourceFragment ) | null ; status
: SubscriptionStatus ; totalPrice
?: ( { __typename
?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment ) | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4135 Type declaration Optional __typename?: "CustomerSubscription" Optional additional Meta Data?: any | null Optional addons?: { __typename?: "SubscriptionAddon" ; addon: { __typename?: "Addon" ; id: string ; refId: string } ; quantity: number } [] | null Optional billing Id?: string | null Optional billing Link Url?: string | null Optional billing Sync Error?: string | null Optional current Billing Period End?: any | null customer: { __typename?: "Customer" ; id: string ; refId: string } Optional __typename?: "Customer" id: string ref Id: string Optional effective End Date?: any | null Optional experiment Info?: { __typename?: "experimentInfo" ; groupName: string ; groupType: ExperimentGroupType ; id: string ; name: string } | null id: string Optional latest Invoice?: ( { __typename?: "SubscriptionInvoice" } & SubscriptionInvoiceFragment ) | null plan: { __typename?: "Plan" ; id: string ; refId: string } Optional __typename?: "Plan" id: string ref Id: string Optional prices?: { __typename?: "SubscriptionPrice" ; price?: ( { __typename?: "Price" } & PriceFragment ) | null ; usageLimit?: number | null } [] | null ref Id: string Optional resource?: ( { __typename?: "CustomerResource" } & CustomerResourceFragment ) | null Optional total Price?: ( { __typename?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment ) | null Snowflake Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2947 Start Experiment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2971 Stop Experiment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2975 String Field Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2979 Stripe Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2995 Stripe Customer Search Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3000 Stripe Product Search Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3005 Stripe Subscription Search Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3010 Subscription Type declaration Optional billing Id?: string Optional cancellation Date?: Date Optional crm Id?: string Optional current Billing Period End?: Date Optional effective End Date?: Date Optional end Date?: Date Optional experiment Info?: ExperimentInfo | null id: string Optional metadata?: Metadata | null Optional resource Id?: string start Date: Date Optional trial End Date?: Date Subscription Addon Subscription
Addon
: { addon
: Addon ; quantity
: number } Subscription Addon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3014 Subscription Addon Filter Addon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3025 Subscription Addon Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3042 Subscription Addon Filter Price Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3068 Subscription Addon Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3079 Subscription Addon Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3083 Subscription Billing Info Subscription
Billing
Info
: { billingAddress
?: BillingAddress ; taxPercentage
?: number ; taxRateIds
?: string [] } Type declaration Optional tax Percentage?: number Optional tax Rate Ids?: string [] Subscription Cancel Reason Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3117 Subscription Cancellation Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3137 Subscription Entitlement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3162 Subscription Entitlement Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3173 Subscription Entitlement Filter Feature Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3199 Subscription Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3213 Subscription Entitlement Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3224 Subscription Estimation Addon Subscription Estimation Addon: { addonId: string ; quantity?: number }
Type declaration addon Id: string Optional quantity?: number Subscription Fragment Subscription
Fragment
: { __typename
?: "CustomerSubscription" ; additionalMetaData
?: any | null ; addons
?: { __typename
?: "SubscriptionAddon" ; addon
: { __typename
?: "Addon" } & AddonFragment ; id
: string ; quantity
: number } [] | null ; billingId
?: string | null ; billingLinkUrl
?: string | null ; billingSyncError
?: string | null ; cancellationDate
?: any | null ; currentBillingPeriodEnd
?: any | null ; effectiveEndDate
?: any | null ; endDate
?: any | null ; experimentInfo
?: { __typename
?: "experimentInfo" ; groupName
: string ; groupType
: ExperimentGroupType ; id
: string ; name
: string } | null ; futureUpdates
: ( { __typename
?: "SubscriptionFutureUpdate" } & SubscriptionFutureUpdateDataFragment ) [] ; id
: string ; latestInvoice
?: ( { __typename
?: "SubscriptionInvoice" } & SubscriptionInvoiceFragment ) | null ; paymentCollection
: PaymentCollection ; plan
: { __typename
?: "Plan" } & PlanFragment ; prices
?: { __typename
?: "SubscriptionPrice" ; price
?: ( { __typename
?: "Price" } & PriceFragment ) | null ; usageLimit
?: number | null } [] | null ; pricingType
: PricingType ; refId
: string ; resource
?: ( { __typename
?: "CustomerResource" } & CustomerResourceFragment ) | null ; scheduledUpdates
?: ( { __typename
?: "SubscriptionScheduledUpdate" } & SubscriptionScheduledUpdateDataFragment ) [] | null ; startDate
: any ; status
: SubscriptionStatus ; subscriptionId
: string ; totalPrice
?: ( { __typename
?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment ) | null ; trialEndDate
?: any | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4249 Type declaration Optional __typename?: "CustomerSubscription" Optional additional Meta Data?: any | null Optional addons?: { __typename?: "SubscriptionAddon" ; addon: { __typename?: "Addon" } & AddonFragment ; id: string ; quantity: number } [] | null Optional billing Id?: string | null Optional billing Link Url?: string | null Optional billing Sync Error?: string | null Optional cancellation Date?: any | null Optional current Billing Period End?: any | null Optional effective End Date?: any | null Optional end Date?: any | null Optional experiment Info?: { __typename?: "experimentInfo" ; groupName: string ; groupType: ExperimentGroupType ; id: string ; name: string } | null id: string Optional latest Invoice?: ( { __typename?: "SubscriptionInvoice" } & SubscriptionInvoiceFragment ) | null plan: { __typename?: "Plan" } & PlanFragment Optional prices?: { __typename?: "SubscriptionPrice" ; price?: ( { __typename?: "Price" } & PriceFragment ) | null ; usageLimit?: number | null } [] | null ref Id: string Optional resource?: ( { __typename?: "CustomerResource" } & CustomerResourceFragment ) | null Optional scheduled Updates?: ( { __typename?: "SubscriptionScheduledUpdate" } & SubscriptionScheduledUpdateDataFragment ) [] | null start Date: any subscription Id: string Optional total Price?: ( { __typename?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment ) | null Optional trial End Date?: any | null Subscription Future Update Data Fragment Subscription
Future
Update
Data
Fragment
: { __typename
?: "SubscriptionFutureUpdate" ; scheduleStatus
: SubscriptionScheduleStatus ; scheduleVariables
?: ( { __typename
?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename
?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename
?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename
?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename
?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_ ) | null ; scheduledExecutionTime
: any ; subscriptionScheduleType
: SubscriptionScheduleType ; targetPackage
?: { __typename
?: "PackageDTO" ; displayName
: string ; id
: string ; refId
: string } | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4214 Type declaration Optional __typename?: "SubscriptionFutureUpdate" Optional schedule Variables?: ( { __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_ ) | null scheduled Execution Time: any Optional target Package?: { __typename?: "PackageDTO" ; displayName: string ; id: string ; refId: string } | null Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3236 Subscription Invoice Fragment Subscription
Invoice
Fragment
: { __typename
?: "SubscriptionInvoice" ; billingId
: string ; billingReason
?: SubscriptionInvoiceBillingReason | null ; createdAt
: any ; errorMessage
?: string | null ; paymentSecret
?: string | null ; paymentUrl
?: string | null ; requiresAction
: boolean ; status
: SubscriptionInvoiceStatus ; updatedAt
: any } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4237 Type declaration Optional __typename?: "SubscriptionInvoice" billing Id: string created At: any Optional error Message?: string | null Optional payment Secret?: string | null Optional payment Url?: string | null requires Action: boolean updated At: any Subscription Migration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3293 Subscription Migration Task Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3298 Subscription Migration Task Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3307 Subscription Minimum Spend Value Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3325 Subscription Preview Credits Subscription
Preview
Credits
: { initial
: Money ; remaining
: Money ; used
: Money } Subscription Preview Discount Type declaration Optional duration In Months?: number value: number Subscription Preview Fragment Subscription
Preview
Fragment
: { __typename
?: "SubscriptionPreview" ; billingPeriodRange
: { __typename
?: "DateRange" ; end
?: any | null ; start
?: any | null } ; credits
?: { __typename
?: "SubscriptionPreviewCredits" ; initial
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; remaining
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; used
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } } | null ; discount
?: { __typename
?: "SubscriptionPreviewDiscount" ; durationInMonths
?: number | null ; durationType
: DiscountDurationType ; type
: DiscountType ; value
: number } | null ; discountAmount
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; hasScheduledUpdates
?: boolean | null ; isPlanDowngrade
?: boolean | null ; proration
?: { __typename
?: "SubscriptionPreviewProrations" ; credit
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; debit
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; netAmount
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; prorationDate
: any } | null ; subTotal
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; subscription
?: { __typename
?: "SubscriptionPricePreviewDTO" ; discount
?: { __typename
?: "SubscriptionPreviewDiscount" ; durationInMonths
?: number | null ; durationType
: DiscountDurationType ; type
: DiscountType ; value
: number } | null ; discountAmount
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; subTotal
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; tax
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; taxDetails
?: { __typename
?: "SubscriptionPreviewTaxDetails" ; displayName
: string ; inclusive
: boolean ; percentage
: number } | null ; total
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; totalExcludingTax
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } } | null ; tax
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; taxDetails
?: { __typename
?: "SubscriptionPreviewTaxDetails" ; displayName
: string ; inclusive
: boolean ; percentage
: number } | null ; total
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; totalExcludingTax
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4394 Type declaration Optional __typename?: "SubscriptionPreview" billing Period Range: { __typename?: "DateRange" ; end?: any | null ; start?: any | null } Optional __typename?: "DateRange" Optional end?: any | null Optional start?: any | null Optional credits?: { __typename?: "SubscriptionPreviewCredits" ; initial: { __typename?: "Money" ; amount: number ; currency: Currency } ; remaining: { __typename?: "Money" ; amount: number ; currency: Currency } ; used: { __typename?: "Money" ; amount: number ; currency: Currency } } | null Optional discount?: { __typename?: "SubscriptionPreviewDiscount" ; durationInMonths?: number | null ; durationType: DiscountDurationType ; type: DiscountType ; value: number } | null Optional discount Amount?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional has Scheduled Updates?: boolean | null Optional is Plan Downgrade?: boolean | null Optional proration?: { __typename?: "SubscriptionPreviewProrations" ; credit: { __typename?: "Money" ; amount: number ; currency: Currency } ; debit: { __typename?: "Money" ; amount: number ; currency: Currency } ; netAmount: { __typename?: "Money" ; amount: number ; currency: Currency } ; prorationDate: any } | null sub Total: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number Optional subscription?: { __typename?: "SubscriptionPricePreviewDTO" ; discount?: { __typename?: "SubscriptionPreviewDiscount" ; durationInMonths?: number | null ; durationType: DiscountDurationType ; type: DiscountType ; value: number } | null ; discountAmount?: { __typename?: "Money" ; amount: number ; currency: Currency } | null ; subTotal: { __typename?: "Money" ; amount: number ; currency: Currency } ; tax: { __typename?: "Money" ; amount: number ; currency: Currency } ; taxDetails?: { __typename?: "SubscriptionPreviewTaxDetails" ; displayName: string ; inclusive: boolean ; percentage: number } | null ; total: { __typename?: "Money" ; amount: number ; currency: Currency } ; totalExcludingTax: { __typename?: "Money" ; amount: number ; currency: Currency } } | null Optional tax?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional tax Details?: { __typename?: "SubscriptionPreviewTaxDetails" ; displayName: string ; inclusive: boolean ; percentage: number } | null total: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number total Excluding Tax: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number Subscription Preview Invoice Subscription Preview Invoice Fragment Subscription
Preview
Invoice
Fragment
: { __typename
?: "SubscriptionPreviewInvoice" ; discount
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; discountDetails
?: { __typename
?: "SubscriptionPreviewDiscount" ; durationInMonths
?: number | null ; durationType
: DiscountDurationType ; type
: DiscountType ; value
: number } | null ; subTotal
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; tax
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; taxDetails
?: { __typename
?: "SubscriptionPreviewTaxDetails" ; displayName
: string ; inclusive
: boolean ; percentage
: number } | null ; total
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; totalExcludingTax
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4520 Type declaration Optional __typename?: "SubscriptionPreviewInvoice" Optional discount?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional discount Details?: { __typename?: "SubscriptionPreviewDiscount" ; durationInMonths?: number | null ; durationType: DiscountDurationType ; type: DiscountType ; value: number } | null sub Total: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number Optional tax?: { __typename?: "Money" ; amount: number ; currency: Currency } | null Optional tax Details?: { __typename?: "SubscriptionPreviewTaxDetails" ; displayName: string ; inclusive: boolean ; percentage: number } | null total: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number total Excluding Tax: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number Subscription Preview Proration Subscription
Preview
Proration
: { credit
: Money ; debit
: Money ; hasProrations
?: boolean ; netAmount
: Money ; prorationDate
: Date } Type declaration Optional has Prorations?: boolean net Amount: Money proration Date: Date Subscription Preview Tax Details Subscription Preview Tax Details: { displayName: string ; inclusive: boolean ; percentage: number }
Type declaration display Name: string inclusive: boolean percentage: number Subscription Preview V2 Fragment Subscription
Preview
V2
Fragment
: { __typename
?: "SubscriptionPreviewV2" ; billingPeriodRange
: { __typename
?: "DateRange" ; end
?: any | null ; start
?: any | null } ; hasScheduledUpdates
?: boolean | null ; immediateInvoice
: { __typename
?: "ImmediateSubscriptionPreviewInvoice" } & ImmediateSubscriptionPreviewInvoiceFragment ; isPlanDowngrade
?: boolean | null ; recurringInvoice
?: ( { __typename
?: "SubscriptionPreviewInvoice" } & SubscriptionPreviewInvoiceFragment ) | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4640 Type declaration Optional __typename?: "SubscriptionPreviewV2" billing Period Range: { __typename?: "DateRange" ; end?: any | null ; start?: any | null } Optional __typename?: "DateRange" Optional end?: any | null Optional start?: any | null Optional has Scheduled Updates?: boolean | null Optional is Plan Downgrade?: boolean | null Optional recurring Invoice?: ( { __typename?: "SubscriptionPreviewInvoice" } & SubscriptionPreviewInvoiceFragment ) | null Subscription Price Subscription
Price
: Price & { grossAmount
: number } Subscription Price Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3329 Subscription Price Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3342 Subscription Price Filter Price Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3368 Subscription Price Preview Type declaration Optional discount Amount?: Money Optional tax?: Money total Excluding Tax: Money Subscription Price Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3379 Subscription Scheduled Update Data Fragment Subscription
Scheduled
Update
Data
Fragment
: { __typename
?: "SubscriptionScheduledUpdate" ; scheduleStatus
: SubscriptionScheduleStatus ; scheduleVariables
?: ( { __typename
?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename
?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename
?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename
?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename
?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_ ) | null ; scheduledExecutionTime
: any ; subscriptionScheduleType
: SubscriptionScheduleType ; targetPackage
?: { __typename
?: "PackageDTO" ; displayName
: string ; id
: string ; refId
: string } | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4191 Type declaration Optional __typename?: "SubscriptionScheduledUpdate" Optional schedule Variables?: ( { __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename?: "UnitAmountChangeVariables" } & ScheduleVariablesFragment_UnitAmountChangeVariables_ ) | null scheduled Execution Time: any Optional target Package?: { __typename?: "PackageDTO" ; displayName: string ; id: string ; refId: string } | null Subscription Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3424 Subscription Update Schedule Cancellation Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3440 Sync Tax Rates Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3452 Task Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3463 Task Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3489 Tax Exempt Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3505 Test Hook Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3509 Tiers Mode Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3519 Total Price Fragment Total
Price
Fragment
: { __typename
?: "CustomerSubscriptionTotalPrice" ; subTotal
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; total
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4010 Type declaration Optional __typename?: "CustomerSubscriptionTotalPrice" sub Total: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number total: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number Transfer Subscription Input Transfer
Subscription
Input
: { customerId
: Scalars [ "String" ] ; destinationResourceId
: Scalars [ "String" ] ; sourceResourceId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3535 Transfer Subscription Mutation Transfer
Subscription
Mutation
: { __typename
?: "Mutation" ; transferSubscription
: { __typename
?: "CustomerSubscription" } & SlimSubscriptionFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5533 Type declaration Optional __typename?: "Mutation" transfer Subscription: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment Transfer Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5530 Trial Override Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3540 Trialed Plan Trialed Plan: { planId?: string | null ; productId?: string | null }
Type declaration Optional plan Id?: string | null Optional product Id?: string | null Trigger Subscription Billing Month Ends Soon Webhook Input Trigger
Subscription
Billing
Month
Ends
Soon
Webhook
Input
: { subscriptionId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3550 Trigger Subscription Migration Input Trigger
Subscription
Migration
Input
: { environmentId
: Scalars [ "String" ] ; refId
: Scalars [ "String" ] ; versionNumber
: Scalars [ "Float" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3554 Trigger Subscription Usage Sync Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3560 Typography Configuration Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4712 Type declaration Optional __typename?: "TypographyConfiguration" Optional body?: ( { __typename?: "FontVariant" } & FontVariantFragment ) | null Optional font Family?: string | null Optional h1?: ( { __typename?: "FontVariant" } & FontVariantFragment ) | null Optional h2?: ( { __typename?: "FontVariant" } & FontVariantFragment ) | null Optional h3?: ( { __typename?: "FontVariant" } & FontVariantFragment ) | null Typography Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3568 Unarchive Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3575 Unarchive Customer Mutation Unarchive
Customer
Mutation
: { __typename
?: "Mutation" ; unarchiveCustomer
: { __typename
?: "Customer" } & SlimCustomerFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5524 Type declaration Optional __typename?: "Mutation" unarchive Customer: { __typename?: "Customer" } & SlimCustomerFragment Unarchive Customer Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5521 Unarchive Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3579 Update Account Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3583 Update Coupon Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3590 Update Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3597 Update Customer Mutation Update
Customer
Mutation
: { __typename
?: "Mutation" ; updateCustomer
: { __typename
?: "Customer" } & SlimCustomerFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5349 Update Customer Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5346 Update Experiment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3612 Update Feature Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3623 Update Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3638 Update Hook Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3648 Update Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3658 Update One Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3665 Update One Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3671 Update One Hook Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3677 Update One Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3683 Update One Package Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3689 Update One Product Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3695 Update One Promotional Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3701 Update Package Entitlement Order Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3707 Update Package Entitlement Order Item Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3712 Update Subscription Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3716 Update Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3727 Update Subscription Mutation Update
Subscription
Mutation
: { __typename
?: "Mutation" ; updateSubscription
: { __typename
?: "CustomerSubscription" } & SlimSubscriptionFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5411 Update Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5408 Update User Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3749 Usage Event Report Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3753 Usage Events Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3761 Usage Events Report Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3765 Usage History Fragment Usage History Fragment: { __typename?: "UsageHistory" ; endDate?: any | null ; groups?: { __typename?: "GroupUsageHistory" ; groupInfo: { __typename?: "GroupInfo" ; key: string ; value: string } [] ; usageMeasurements: { __typename?: "UsageMeasurementPoint" ; date: any ; isResetPoint?: boolean | null ; value: number } [] } [] | null ; startDate: any ; usageMeasurements: { __typename?: "UsageMeasurementPoint" ; date: any ; isResetPoint?: boolean | null ; value: number } [] }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5206 Type declaration Optional __typename?: "UsageHistory" Optional end Date?: any | null Optional groups?: { __typename?: "GroupUsageHistory" ; groupInfo: { __typename?: "GroupInfo" ; key: string ; value: string } [] ; usageMeasurements: { __typename?: "UsageMeasurementPoint" ; date: any ; isResetPoint?: boolean | null ; value: number } [] } [] | null start Date: any usage Measurements: { __typename?: "UsageMeasurementPoint" ; date: any ; isResetPoint?: boolean | null ; value: number } [] Usage History Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3769 Usage History Point Usage History Point: { date: Date ; isResetPoint: boolean ; value: number }
Type declaration date: Date is Reset Point: boolean value: number Usage Measurement Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3782 Usage Measurement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3791 Usage Measurement Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3800 Usage Measurement Filter Feature Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3818 Usage Measurement Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3832 Usage Updated Fragment Usage Updated Fragment: { __typename?: "UsageMeasurementUpdated" ; currentUsage: number ; customerId: string ; featureId: string ; nextResetDate?: number | null ; resourceId?: string | null }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4678 Type declaration Optional __typename?: "UsageMeasurementUpdated" current Usage: number customer Id: string feature Id: string Optional next Reset Date?: number | null Optional resource Id?: string | null Validate Merge Environment Input Validate
Merge
Environment
Input
: { destinationEnvironmentSlug
: Scalars [ "String" ] ; sourceEnvironmentSlug
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3847 Type declaration destination Environment Slug: Scalars [ "String" ] source Environment Slug: Scalars [ "String" ] Vendor Identifier Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3861 Wait For Checkout Completed Wait For Checkout Completed: { refreshOnComplete?: boolean ; timeoutMs?: number }
Type declaration Optional refresh On Complete?: boolean Optional timeout Ms?: number Weekly Reset Period Config Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3888 Widget Configuration Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3891 Yearly Reset Period Config Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3907 Zuora Credentials Input Zuora
Credentials
Input
: { baseUrl
: Scalars [ "String" ] ; clientId
: Scalars [ "String" ] ; clientSecret
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3910 Variables Const Addon Dependency Fragment DocAddon Dependency Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5715 Const Addon Fragment DocAddon Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5716 Const Apply Subscription DocumentApply Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5774 Const Apply Subscription Fragment DocApply Subscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5763 Const Archive Customer DocumentArchive Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5788 Const Cancel Subscription DocumentCancel Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5777 Const Cancel Subscription Updates DocumentCancel Subscription Updates Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5781 Const Checkout Configuration Fragment DocCheckout Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5747 Const Checkout State Fragment DocCheckout State Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5748 Const Coupon Fragment DocCoupon Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5704 Const Create Subscription DocumentCreate Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5786 Const Customer Fragment DocCustomer Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5706 Const Customer Portal Billing Information Fragment DocCustomer Portal Billing Information Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5742 Const Customer Portal Configuration Fragment DocCustomer Portal Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5745 Const Customer Portal Entitlement Fragment DocCustomer Portal Entitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5740 Const Customer Portal Fragment DocCustomer Portal Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5746 Const Customer Portal Promotional Entitlement Fragment DocCustomer Portal Promotional Entitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5741 Const Customer Portal Subscription Addon Fragment DocCustomer Portal Subscription Addon Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5737 Const Customer Portal Subscription Fragment DocCustomer Portal Subscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5739 Const Customer Portal Subscription Price Fragment DocCustomer Portal Subscription Price Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5736 Const Customer Portal Subscription Scheduled Update Data Fragment DocCustomer Portal Subscription Scheduled Update Data Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5738 Const Customer Resource Fragment DocCustomer Resource Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5708 Const Customer Statistics Fragment DocCustomer Statistics Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5724 Const Customer With Subscriptions Fragment DocCustomer With Subscriptions Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5723 Const Detach Customer Payment Method DocumentDetach Customer Payment Method Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5770 Const Entitlement Fragment DocEntitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5731 Const Entitlement Usage Updated Fragment DocEntitlement Usage Updated Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5734 Const Entitlements Updated Payload Fragment DocEntitlements Updated Payload Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5732 Const Estimate Subscription DocumentEstimate Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5778 Const Estimate Subscription Update DocumentEstimate Subscription Update Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5779 Const Feature Fragment DocFeature Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5730 Const Font Variant Fragment DocFont Variant Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5743 Const Get Active Subscriptions DocumentGet Active Subscriptions Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5793 Const Get Checkout State DocumentGet Checkout State Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5801 Const Get Coupons DocumentGet Coupons Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5794 Const Get Customer By Id DocumentGet Customer By Id Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5791 Const Get Customer Portal By Ref Id DocumentGet Customer Portal By Ref Id Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5800 Const Get Customer Statistics DocumentGet Customer Statistics Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5792 Const Get Entitlement DocumentGet Entitlement Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5797 Const Get Entitlements DocumentGet Entitlements Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5796 Const Get Mock Paywall DocumentGet Mock Paywall Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5802 Const Get Paywall DocumentGet Paywall Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5795 Const Get Products DocumentGet Products Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5798 Const Get Sdk Configuration DocumentGet Sdk Configuration Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5799 Const Get Usage History DocumentGet Usage History Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5803 Const Grant Promotional Entitlements DocumentGrant Promotional Entitlements Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5771 Const Immediate Subscription Preview Invoice Fragment DocImmediate Subscription Preview Invoice Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5726 Const Import Customer Bulk DocumentImport Customer Bulk Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5767 Const Import Customer DocumentImport Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5768 Const Import Subscriptions Bulk DocumentImport Subscriptions Bulk Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5775 Const Layout Configuration Fragment DocLayout Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5756 Const Migrate Subscription To Latest DocumentMigrate Subscription To Latest Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5787 Const Mock Paywall Addon Dependency Fragment DocMock Paywall Addon Dependency Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5751 Const Mock Paywall Addon Fragment DocMock Paywall Addon Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5752 Const Mock Paywall Package Entitlement Fragment DocMock Paywall Package Entitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5749 Const Mock Paywall Plan Compatible Package Groups Fragment DocMock Paywall Plan Compatible Package Groups Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5753 Const Mock Paywall Plan Fragment DocMock Paywall Plan Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5754 Const Mock Paywall Price Fragment DocMock Paywall Price Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5750 Const On Entitlements Updated DocumentOn Entitlements Updated Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5804 Const On Package Published DocumentOn Package Published Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5806 Const On Usage Updated DocumentOn Usage Updated Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5805 Const Overage Price Fragment DocOverage Price Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5714 Const Package Entitlement Fragment DocPackage Entitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5713 Const Package Published Payload Fragment DocPackage Published Payload Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5735 Const Paywall Calculated Price Points Fragment DocPaywall Calculated Price Points Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5758 Const Paywall Configuration Fragment DocPaywall Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5757 Const Paywall Currency Fragment DocPaywall Currency Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5755 Const Paywall Fragment DocPaywall Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5759 Const Plan Compatible Package Groups Fragment DocPlan Compatible Package Groups Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5717 Const Plan Fragment DocPlan Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5718 Const Preview Subscription DocumentPreview Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5780 Const Price Fragment DocPrice Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5710 Const Price Tier Fragment DocPrice Tier Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5709 Const Product Fragment DocProduct Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5712 Const Promotional Entitlement Fragment DocPromotional Entitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5705 Const Provision Customer DocumentProvision Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5766 Const Provision Customer Fragment DocProvision Customer Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5762 Const Provision Subscription DocumentProvision Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5773 Const Provision Subscription Fragment DocProvision Subscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5764 Const Report Entitlement Check Requested DocumentReport Entitlement Check Requested Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5785 Const Report Event DocumentReport Event Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5784 Const Report Usage Bulk DocumentReport Usage Bulk Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5783 Const Report Usage DocumentReport Usage Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5782 Const Report Usage Fragment DocReport Usage Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5765 Const Reset Period Configuration Fragment DocReset Period Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5729 Const Revoke Promotional Entitlement DocumentRevoke Promotional Entitlement Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5772 Const Schedule Variables Fragment DocSchedule Variables Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5719 Const Slim Customer Fragment DocSlim Customer Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5703 Const Slim Subscription Fragment DocSlim Subscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5761 Const Subscription Fragment DocSubscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5722 Const Subscription Future Update Data Fragment DocSubscription Future Update Data Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5721 Const Subscription Invoice Fragment DocSubscription Invoice Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5707 Const Subscription Preview Fragment DocSubscription Preview Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5725 Const Subscription Preview Invoice Fragment DocSubscription Preview Invoice Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5727 Const Subscription Preview V2 Fragment DocSubscription Preview V2 Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5728 Const Subscription Scheduled Update Data Fragment DocSubscription Scheduled Update Data Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5720 Const Total Price Fragment DocTotal Price Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5711 Const Transfer Subscription DocumentTransfer Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5790 Const Typography Configuration Fragment DocTypography Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5744 Const Unarchive Customer DocumentUnarchive Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5789 Const Update Customer DocumentUpdate Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5769 Const Update Subscription DocumentUpdate Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5776 Const Usage History Fragment DocUsage History Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5760 Const Usage Updated Fragment DocUsage Updated Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5733
The id of the record.