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:51 Addon Type declaration Optional billing Id?: string | null description: string display Name: string id: string Optional max Quantity?: number Optional metadata?: Metadata | null price Points: Price [] Optional pricing Type?: PricingType | null Addon Archive Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:58 Addon Associated Entities Input Addon
Associated
Entities
Input
: { environmentId
: Scalars [ "String" ] ; refId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:65 Addon Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:71 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:4648 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:88 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:4625 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:105 Addon Un Archive Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:126 Addon Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:132 Address Address: { addressLine1?: string ; addressLine2?: string ; city?: string ; country?: string ; phoneNumber?: string ; postalCode?: string ; state?: string }
Type declaration Optional address Line1?: string Optional address Line2?: string Optional city?: string Optional country?: string Optional phone Number?: string Optional postal Code?: string Optional state?: string Aggregated Events By Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:154 Api Key Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:175 Api Key Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:180 Apply Subscription Type declaration Optional billing Country Code?: string Optional billing Id?: string customer Id: string Optional metadata?: Metadata | null Optional paying Customer Id?: string 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:6069 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:193 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:6247 Apply Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6244 Archive Coupon Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:226 Archive Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:230 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:6375 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:6372 Archive Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:234 Archive Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:238 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:243 Archive Plan Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:249 Attach Customer Payment Method Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:253 Auth0 Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:268 Auto Cancellation Rule Input Auto
Cancellation
Rule
Input
: { sourcePlanId
: Scalars [ "String" ] ; targetPlanId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:281 Aws Marketplace Credentials Input Aws
Marketplace
Credentials
Input
: { awsRoleArn
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:287 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 Big Query Credentials Input Big
Query
Credentials
Input
: { credentialsJson
: Scalars [ "String" ] ; datasetId
: Scalars [ "String" ] ; datasetLocation
: Scalars [ "String" ] ; gcsBucketName
: Scalars [ "String" ] ; gcsBucketPath
: Scalars [ "String" ] ; hmacKeyAccessId
: Scalars [ "String" ] ; hmacKeySecret
: Scalars [ "String" ] ; projectId
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:290 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:300 Billing Address Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:304 Billing Cadence Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:322 Billing Info Billing
Info
: { billingAddress
?: Address ; currency
?: Currency ; customerName
?: string ; integrationId
?: string ; invoiceCustomFields
?: Record < string , string > ; language
?: string ; metadata
?: Metadata | null ; paymentMethodId
?: string ; shippingAddress
?: Address ; taxIds
?: TaxExempt [] ; timezone
?: string } Type declaration Optional billing Address?: Address Optional currency?: Currency Optional customer Name?: string Optional integration Id?: string Optional invoice Custom Fields?: Record < string , string > Optional language?: string Optional metadata?: Metadata | null Optional payment Method Id?: string Optional shipping Address?: Address Optional tax Ids?: TaxExempt [] Optional timezone?: string Billing Model Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:345 Billing Period Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:366 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:387 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:392 Cancel Subscription Type declaration Optional end Date?: Date Optional prorate?: boolean subscription Id: string 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:6272 Cancel Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6269 Cancel Subscription Scheduled Updates 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:6317 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:6314 Charge Subscription Usage Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:405 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:5639 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:413 Checkout Content Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:419 Checkout Options Checkout Options: { allowPromoCodes?: boolean ; allowTaxIdCollection?: boolean ; cancelUrl: string ; collectBillingAddress?: boolean ; collectPhoneNumber?: boolean ; referenceId?: string ; successUrl: string }
Type declaration Optional allow Promo Codes?: boolean Optional allow Tax Id Collection?: boolean cancel Url: string Optional collect Billing Address?: boolean Optional collect Phone Number?: boolean Optional reference Id?: string success Url: string Checkout Palette Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:431 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:5611 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:438 Clear Customer Persistent Cache Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:445 Client Configuration Client
Configuration
: { apiKey
: string ; baseEdgeUri
?: string ; baseUri
?: string ; clientName
?: string ; clientVersion
?: string ; enableEdge
?: boolean ; enableRemoteConfig
?: boolean ; entitlementsFallback
?: EntitlementsFallback ; logConfiguration
?: LogConfiguration ; memoryCacheMaxSizeBytes
?: number ; offline
?: boolean ; realtimeUpdatesEnabled
?: boolean ; redis
?: StiggRedisOptions ; timeout
?: number ; wsUrl
?: string } Type declaration api Key: string Optional base Edge Uri?: string Optional base Uri?: string Optional client Name?: string Optional client Version?: string Optional enable Edge?: boolean Optional enable Remote Config?: boolean Optional memory Cache Max Size Bytes?: number Optional offline?: boolean Optional realtime Updates Enabled?: boolean Optional redis?: StiggRedisOptions Optional timeout?: number Optional ws Url?: string 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
: { amountsOff
?: Money [] | null ; description
?: string | null ; discountValue
: number ; id
: string ; metadata
?: Metadata | null ; name
: string ; percentOff
?: number | null } Type declaration Optional amounts Off?: Money [] | null Optional description?: string | null discount Value: number id: string Optional metadata?: Metadata | null name: string Optional percent Off?: number | null Coupon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:461 Coupon Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:477 Coupon Fragment Coupon
Fragment
: { __typename
?: "Coupon" ; additionalMetaData
?: any | null ; amountsOff
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } [] | null ; billingId
?: string | null ; billingLinkUrl
?: string | null ; createdAt
: any ; description
?: string | null ; discountValue
: number ; id
: string ; name
: string ; percentOff
?: number | null ; 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:4498 Type declaration Optional __typename?: "Coupon" Optional additional Meta Data?: any | null Optional amounts Off?: { __typename?: "Money" ; amount: number ; currency: Currency } [] | null Optional billing Id?: string | null Optional billing Link Url?: string | null created At: any Optional description?: string | null discount Value: number id: string name: string Optional percent Off?: number | null 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:495 Coupon Source Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:519 Coupon Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:528 Coupon Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:549 Create Coupon Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:565 Create Customer Create
Customer
: { billingId
?: string ; billingInfo
?: BillingInfo ; couponId
?: string ; customerId
?: string ; email
?: string ; excludeFromExperiment
?: boolean ; metadata
?: Metadata | null ; name
?: string ; salesforceId
?: string ; shouldSyncFree
?: boolean } Type declaration Optional billing Id?: string Optional billing Info?: BillingInfo Optional coupon Id?: string Optional customer Id?: string Optional email?: string Optional exclude From Experiment?: boolean Optional metadata?: Metadata | null Optional name?: string Optional salesforce Id?: string Optional should Sync Free?: boolean Create Environment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:580 Create Environment Options Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:591 Create Experiment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:594 Create Hook Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:604 Create Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:616 Create Many Package Entitlements Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:633 Create Many Promotional Entitlements Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:637 Create Meter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:641 Create One Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:645 Create One Hook Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:649 Create One Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:653 Create One Product Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:657 Create Or Update Aws Marketplace Product Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:661 Create Package Group Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:678 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:6356 Create Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6353 Create Subscription Params Type declaration Optional await Payment Confirmation?: boolean Optional id?: string Optional metadata?: Metadata | null plan Id: string Optional promotion Code?: string Optional resource Id?: string Optional skip Trial?: boolean Optional start Date?: Date Optional unit Quantity?: number Create Usage Measurement Create
Usage
Measurement
: { createdAt
?: Date ; customerId
: string ; dimensions
?: Record < string , EventDimensionValue > ; featureId
: string ; resourceId
?: string ; updateBehavior
?: UsageUpdateBehavior ; value
: number } Type declaration Optional created At?: Date customer Id: string feature Id: string Optional resource Id?: string value: number Cursor Paging Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:808 Customer Billing Info Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:818 Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:832 Customer Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:852 Customer Filter Promotional Entitlement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:880 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:4999 Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:889 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:5823 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:905 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:5658 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:914 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 ; usagePeriodEnd
?: any | null ; usagePeriodStart
?: any | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5791 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 Optional usage Period End?: any | null Optional usage Period Start?: any | null Customer Portal Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5587 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:919 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:5813 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 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:5754 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 ; planId
: string ; 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:5694 Type declaration Optional __typename?: "CustomerPortalSubscription" Optional billing Period Range?: { __typename?: "DateRange" ; end?: any | null ; start?: any | null } | null plan Id: string 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 ; blockSize
?: number | 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:5675 Type declaration Optional __typename?: "CustomerPortalSubscriptionPrice" Optional billing Model?: BillingModel | null Optional billing Period?: BillingPeriod | null Optional block Size?: number | 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
?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_ ) | ( { __typename
?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename
?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_ ) | ( { __typename
?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename
?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename
?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_ ) | ( { __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:5761 Type declaration Optional __typename?: "SubscriptionScheduledUpdate" Optional schedule Variables?: ( { __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_ ) | ( { __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_ ) | ( { __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_ ) | ( { __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:924 Customer Resource Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:933 Customer Resource Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:951 Customer Resource Fragment Customer Resource Fragment: { __typename?: "CustomerResource" ; resourceId: string }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4716 Type declaration Optional __typename?: "CustomerResource" resource Id: string Customer Resource Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:979 Customer Search Query Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:989 Customer Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:992 Customer State Customer
State
: Omit < FullCustomer , "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:5039 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:1013 Customer Subscription Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1048 Customer Subscription Filter Customer Resource Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1066 Customer Subscription Filter Plan Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1073 Customer Subscription Filter Subscription Addon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1090 Customer Subscription Filter Subscription Entitlement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1098 Customer Subscription Filter Subscription Price Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1107 Customer Subscription Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1118 Customer With Subscriptions Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5033 Date Field Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1149 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:1163 Date Range Date Range: { end?: Date ; start?: Date }
Type declaration Optional end?: Date Optional start?: Date Default Sso Roles Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1167 Default Trial Config Input Dto Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1175 Delegate Subscription To Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1184 Delegate Subscription To Customer Mutation Delegate
Subscription
To
Customer
Mutation
: { __typename
?: "Mutation" ; delegateSubscriptionToCustomer
: { __typename
?: "CustomerSubscription" } & SlimSubscriptionFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6403 Type declaration Optional __typename?: "Mutation" delegate Subscription To Customer: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment Delegate Subscription To Customer Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6400 Delete Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1192 Delete One Hook Input Delete
One
Hook
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1196 Delete One Integration Input Delete
One
Integration
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1200 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:1204 Delete One Price Input Delete
One
Price
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1208 Delete One Product Input Delete
One
Product
Input
: { id
: Scalars [ "String" ] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1212 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:1216 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:1229 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:6210 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:6207 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:1233 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:1238 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:1253 Dump Environment For For Merge Comparison Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1258 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:1267 Duplicate Product Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1271 Edit Package Group Details Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1279 Entitlement Check Requested Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1296 Entitlement Check Result Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1304 Entitlement Feature Type declaration id: string Optional is Metered?: boolean 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 ; usagePeriodAnchor
?: any | null ; usagePeriodEnd
?: any | null ; usagePeriodStart
?: any | null ; usageUpdatedAt
?: any | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5466 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 Period Anchor?: any | null Optional usage Period End?: any | null Optional usage Period Start?: any | null Optional usage Updated At?: any | null Entitlement Options Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1318 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:5569 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:5561 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:1341 Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1350 Environment Merge Configuration Input Environment
Merge
Configuration
Input
: { includeCoupons
?: InputMaybe < Scalars [ "Boolean" ] > } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1358 Environment Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1369 Estimate Subscription Type declaration Optional billing Country Code?: string customer Id: string Optional paying 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:1559 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:6281 Estimate Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6278 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:1581 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:6290 Estimate Subscription Update Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6287 Event Dimension Value Event Dimension Value: string | number | boolean
Event Log Created At Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1649 Event Log Entity Id Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1653 Event Log Environment Id Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1657 Event Log Event Log Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1660 Event Log Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1666 Event Log Id Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1676 Event Log Parent Entity Id Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1679 Event Log Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1683 Events Fields Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1762 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:1772 Experiment Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1784 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:1802 Experiment Stats Query Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1816 Experiment Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1826 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:1842 Feature Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1846 Feature Fragment Feature
Fragment
: { __typename
: "EntitlementFeature" ; description
?: string | null ; displayName
: string ; featureType
: FeatureType ; featureUnits
?: string | null ; featureUnitsPlural
?: string | null ; meterType
?: MeterType | null ; refId
: string ; unitTransformation
?: { __typename
?: "UnitTransformation" ; divide
: number ; round
: UnitTransformationRound } | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5428 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 Optional unit Transformation?: { __typename?: "UnitTransformation" ; divide: number ; round: UnitTransformationRound } | null Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1860 Feature Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1875 Feature Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1898 Feature Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1919 Fetch Entitlement Query Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1935 Fetch Entitlements Query Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1942 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:5511 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:1947 Full Entitlement Feature Full
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 Full Promotional Entitlement Full
Promotional
Entitlement
: { expiresAt
?: Date ; feature
: EntitlementFeature ; hasExpirationDate
: boolean ; hasSoftLimit
?: boolean | null ; hasUnlimitedUsage
?: boolean | null ; isVisible
: boolean ; status
: PromotionalEntitlementStatus ; usageLimit
: number } Type declaration Optional expires At?: Date has Expiration Date: boolean Optional has Soft Limit?: boolean | null Optional has Unlimited Usage?: boolean | null is Visible: boolean usage Limit: number Full Subscription Type declaration Optional billing Id?: string Optional billing Link Url?: string Optional billing Sync Error?: 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 start Date: Date Optional trial End Date?: Date Full Subscription Addon Full
Subscription
Addon
: { addon
: Addon ; quantity
: number } Get Active Subscriptions Get Active Subscriptions: { customerId: string ; resourceId?: string | string [] }
Type declaration customer Id: string Optional resource Id?: string | string [] Get Active Subscriptions Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1956 Get Active Subscriptions List Query Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6448 Get Active Subscriptions List Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6445 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:6439 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:6436 Get Auth0 Applications Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1962 Get Boolean Entitlement Type declaration customer Id: string feature Id: string Optional resource Id?: string 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:6543 Get Checkout State Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6540 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:6466 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:6463 Get Customer By Id Query Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6421 Get Customer By Id Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6418 Get Customer By Ref Id Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1968 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:6534 Get Customer Portal By Ref Id Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6531 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:6430 Get Customer Statistics Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6427 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:6499 Get Entitlement Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6496 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:6490 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:6487 Get Metered Entitlement Type declaration customer Id: string 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:6552 Get Mock Paywall Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6549 Get Numeric Entitlement Type declaration customer Id: string 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:1972 Get Package Group Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1978 Get Paywall Get Paywall: { billingCountryCode?: string ; customerId?: string ; fetchAllCountriesPrices?: boolean ; includeHiddenPlans?: boolean ; productId?: string ; resourceId?: string }
Type declaration Optional billing Country Code?: string Optional customer Id?: string Optional fetch All Countries Prices?: boolean 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:1986 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:6481 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:6478 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:6508 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:6505 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:6523 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:6520 Get Subscription Get Subscription: { subscriptionId: string }
Get Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:1997 Get Subscription Query Get
Subscription
Query
: { __typename
?: "Query" ; getSubscription
: { __typename
?: "CustomerSubscription" } & SubscriptionFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6457 Type declaration Optional __typename?: "Query" get Subscription: { __typename?: "CustomerSubscription" } & SubscriptionFragment Get Subscription Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6454 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:6567 Get Usage History Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6564 Get Usage History V2 Query Get
Usage
History
V2
Query
: { __typename
?: "Query" ; usageHistoryV2
: { __typename
?: "UsageHistoryV2" } & UsageHistoryV2Fragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6576 Get Usage History V2 Query Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6573 Get Widget Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2003 Grant Promotional Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2006 Grant Promotional Entitlements Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2019 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:6219 Grant Promotional Entitlements Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6216 Hook Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2024 Hook Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2033 Hook Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2050 Hubspot Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2066 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:5219 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 Import
Customer
: { billingId
?: string ; customerId
?: string ; email
?: string ; metadata
?: Metadata | null ; name
?: string ; paymentMethodId
?: string ; updatedAt
?: Date } Type declaration Optional billing Id?: string Optional customer Id?: string Optional email?: string Optional metadata?: Metadata | null Optional name?: string Optional payment Method Id?: string Optional updated At?: Date Import Customer Bulk Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2070 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:6185 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:6182 Import Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2074 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:6192 Import Customer Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6189 Import Integration Catalog Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2087 Import Integration Customers Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2099 Import Integration Task Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2107 Import Integration Task Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2116 Import Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2128 Import Subscriptions Bulk Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2146 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:6256 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:6253 Init Add Stripe Customer Payment Method Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2150 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:2156 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:2170 Integration Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2174 Integration Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2183 Integration Vendor Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2195 Invite Members Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2201 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:5516 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:2224 List Aws Products Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2228 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:2232 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:2238 Member Filter User Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2246 Member Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2253 Merge Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2269 Meter Aggregation Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2285 Meter Condition Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2289 Meter Filter Definition Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2294 Meter Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2303 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 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:6365 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:6362 Minimum Spend Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2320 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:5955 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:5961 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:5878 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:5941 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" ; budget
?: { __typename
?: "BudgetConfiguration" ; limit
: number } | null ; duration
: number ; trialEndBehavior
?: TrialEndBehavior | null ; 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:5832 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" ; budget?: { __typename?: "BudgetConfiguration" ; limit: number } | null ; duration: number ; trialEndBehavior?: TrialEndBehavior | null ; 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:5898 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:2326 Monthly Reset Period Config Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2335 Number Field Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2338 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:2352 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:6585 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:6582 On Package Published Subscription Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6603 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:6600 On Usage Updated Subscription Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6594 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:6591 Open Fga Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2356 Overage Entitlement Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2369 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:4566 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:2386 Package Dto Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2393 Package Dto Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2410 Package Entitlement Type declaration Optional display Name Override?: PackageEntitlementFragment [ "displayNameOverride" ] Optional has Soft Limit?: boolean | null Optional has Unlimited Usage?: boolean | null usage Limit: number Package Entitlement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2430 Package Entitlement Filter Feature Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2441 Package Entitlement Filter Package Dto Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2455 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:4603 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:2472 Package Entitlement Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2491 Package Entitlement Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2503 Package Group Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2519 Package Group Filter Product Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2533 Package Group Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2548 Package Group Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2573 Package Pricing Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2589 Package Publish Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2600 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:5578 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:2610 Payment Collection Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2633 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 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:5924 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:2663 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:5523 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:2670 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:5541 Type declaration Optional __typename?: "PaywallCurrency" symbol: string Paywall Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5980 Paywall Layout Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2676 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:4703 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:2691 Plan Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2705 Plan Filter Addon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2724 Plan Filter Product Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2741 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" ; budget
?: { __typename
?: "BudgetConfiguration" ; limit
: number } | null ; duration
: number ; trialEndBehavior
?: TrialEndBehavior | null ; 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:4655 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" ; budget?: { __typename?: "BudgetConfiguration" ; limit: number } | null ; duration: number ; trialEndBehavior?: TrialEndBehavior | null ; 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:2756 Plan Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2776 Prepare Payment Method Form Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2789 Preview Next Invoice Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2796 Preview Next Invoice Mutation Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6308 Type declaration Optional __typename?: "Mutation" Preview Next Invoice Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6305 Preview Subscription Type declaration Optional billing Country Code?: string customer Id: string Optional paying 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:2802 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:6299 Preview Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6296 Price Price
: { amount
?: number | null ; billingCadence
?: BillingCadence ; billingCountryCode
?: string | null ; billingId
?: string | null ; billingPeriod
: BillingPeriod ; blockSize
?: number | null ; currency
: Currency ; feature
?: { description
?: string | null ; displayName
: string ; featureId
: string ; unitQuantity
?: number | null ; units
?: string | null ; unitsPlural
?: string | null } | null ; 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?: { description?: string | null ; displayName: string ; featureId: string ; unitQuantity?: number | null ; units?: string | null ; unitsPlural?: string | null } | null 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:2823 Price Filter Package Dto Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2835 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:4538 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:2852 Price Period Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2864 Price Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2872 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:4524 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:2886 Pricing Model Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2891 Pricing Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2910 Product Product
: { description
?: string | null ; displayName
?: string | null ; downgradePlan
?: Pick < Plan , "id" | "displayName" > ; id
: string ; metadata
?: Metadata | null } Type declaration Optional description?: string | null Optional display Name?: string | null Optional downgrade Plan?: Pick < Plan , "id" | "displayName" > id: string Optional metadata?: Metadata | null Product Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2926 Product Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2934 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:5546 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:2949 Product Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2958 Product Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:2976 Promotional Entitlement Promotional
Entitlement
: { expiresAt
?: Date ; feature
: FullEntitlementFeature ; hasExpirationDate
: boolean ; hasSoftLimit
?: boolean | null ; hasUnlimitedUsage
?: boolean | null ; isVisible
: boolean ; status
: PromotionalEntitlementStatus ; usageLimit
: number } Type declaration Optional expires At?: Date has Expiration Date: boolean Optional has Soft Limit?: boolean | null 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:2987 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:4964 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:2996 Promotional Entitlement Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3021 Promotional Entitlement Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3039 Promotional Entitlement Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3055 Provision Customer Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6056 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:3071 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:6176 Provision Customer Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6173 Provision Customer Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3089 Provision Sandbox Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3120 Provision Subscription Type declaration Optional await Payment Confirmation?: boolean Optional billing Country Code?: string Optional billing Id?: string customer Id: string Optional id?: string Optional metadata?: Metadata | null Optional paying Customer Id?: string plan Id: string Optional promotion Code?: string Optional resource Id?: string Optional salesforce Id?: string Optional skip Trial?: boolean Optional start Date?: Date Optional unit Quantity?: number 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:6078 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:3160 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:6238 Provision Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6235 Provision Subscription Result Type declaration Optional checkout Url?: string | null Recalculate Entitlements Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3206 Recalculate Entitlements Side Effects Options Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3212 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:3218 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:3224 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:3230 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:3236 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:3242 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:6349 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:6346 Report Event Report
Event
: { customerId
: string ; dimensions
?: Record < string , EventDimensionValue > ; eventName
: string ; idempotencyKey
: string ; resourceId
?: string ; timestamp
?: Date } Type declaration customer Id: string event Name: string idempotency Key: string Optional resource Id?: string Optional timestamp?: Date Report Event Mutation Report Event Mutation: { __typename?: "Mutation" ; reportEvent?: string | null }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6342 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:6339 Report Usage Report
Usage
: { createdAt
?: Date ; customerId
: string ; dimensions
?: Record < string , EventDimensionValue > ; featureId
: string ; resourceId
?: string ; updateBehavior
?: UsageUpdateBehavior ; value
: number } Type declaration Optional created At?: Date customer Id: string feature Id: string Optional resource Id?: string value: number Report Usage Ack Report Usage Ack: { currentUsage?: number ; customerId: string ; featureId: string ; measurementId: string ; nextResetDate?: Date ; resourceId?: string ; usagePeriodEnd?: Date ; usagePeriodStart?: Date }
Type declaration Optional current Usage?: number customer Id: string feature Id: string measurement Id: string Optional next Reset Date?: Date Optional resource Id?: string Optional usage Period End?: Date Optional usage Period Start?: Date Report Usage Base Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3248 Report Usage Bulk Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3257 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:6333 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:6330 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 ; usagePeriodEnd?: any | null ; usagePeriodStart?: any | null }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6090 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 Optional usage Period End?: any | null Optional usage Period Start?: any | null Report Usage Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3261 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:6324 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:6321 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:5455 Resync Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3271 Revoke Promotional Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3281 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:6228 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:6225 Salesforce Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3286 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_AddonPriceOverrideChangeVariables_ | ScheduleVariablesFragment_BillingPeriodChangeVariables_ | ScheduleVariablesFragment_CouponChangeVariables_ | ScheduleVariablesFragment_DowngradeChangeVariables_ | ScheduleVariablesFragment_PlanChangeVariables_ | ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_ | ScheduleVariablesFragment_UnitAmountChangeVariables_
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6172 Sdk Sdk
: ReturnType < typeof getSdk > Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6773 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:6723 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 Access Roles Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3298 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:3308 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:3314 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:3320 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:3326 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:3332 Set Package Group Addons Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3339 Set Plan Compatible Package Group Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3348 Set Plan Compatible Package Group Options Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3355 Set Plan Compatible Package Groups Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3362 Slim Customer Slim
Customer
: { awsMarketplaceCustomerId
?: string | null ; billingId
?: string ; createdAt
: Date ; email
?: string ; id
: string ; metadata
?: Metadata | null ; name
?: string ; updatedAt
: Date } Type declaration Optional aws Marketplace Customer Id?: string | null Optional billing Id?: string created At: Date Optional email?: string id: string Optional metadata?: Metadata | null Optional name?: string updated At: Date 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:4986 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 ; subscriptionId
: string ; totalPrice
?: ( { __typename
?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment ) | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4758 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 subscription Id: string Optional total Price?: ( { __typename?: "CustomerSubscriptionTotalPrice" } & TotalPriceFragment ) | null Slim Subscription Fragment V2 Fragment Slim
Subscription
Fragment
V2
Fragment
: { __typename
?: "CustomerSubscription" ; addons
?: { __typename
?: "SubscriptionAddon" ; addon
: { __typename
?: "Addon" ; addonId
: string } ; quantity
: number } [] | null ; currentBillingPeriodEnd
?: any | null ; customer
: { __typename
?: "Customer" ; customerId
: string } ; payingCustomer
?: { __typename
?: "Customer" ; customerId
: string } | null ; plan
: { __typename
?: "Plan" ; displayName
: string ; planId
: string } ; pricingType
: PricingType ; resource
?: { __typename
?: "CustomerResource" ; resourceId
: string } | null ; startDate
: any ; status
: SubscriptionStatus ; subscriptionId
: string ; trialConfiguration
?: { __typename
?: "TrialConfiguration" ; trialEndBehavior
: TrialEndBehavior } | null ; trialEndDate
?: any | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4720 Type declaration Optional __typename?: "CustomerSubscription" Optional addons?: { __typename?: "SubscriptionAddon" ; addon: { __typename?: "Addon" ; addonId: string } ; quantity: number } [] | null Optional current Billing Period End?: any | null customer: { __typename?: "Customer" ; customerId: string } Optional __typename?: "Customer" customer Id: string Optional paying Customer?: { __typename?: "Customer" ; customerId: string } | null plan: { __typename?: "Plan" ; displayName: string ; planId: string } Optional __typename?: "Plan" display Name: string plan Id: string Optional resource?: { __typename?: "CustomerResource" ; resourceId: string } | null start Date: any subscription Id: string Optional trial Configuration?: { __typename?: "TrialConfiguration" ; trialEndBehavior: TrialEndBehavior } | null Optional trial End Date?: any | null Snowflake Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3370 Start Experiment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3394 Stop Experiment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3398 String Field Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3402 Stripe Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3418 Stripe Customer Search Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3424 Stripe Product Search Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3429 Stripe Subscription Search Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3434 Subscription Type declaration addon Ids: string [] Optional billing Id?: string Optional billing Link Url?: string Optional billing Sync Error?: string customer Id: string Optional effective End Date?: Date Optional experiment Info?: ExperimentInfo | null id: string Optional metadata?: Metadata | null plan Id: string Subscription Addon Subscription Addon: { addonId: string ; quantity?: number }
Type declaration addon Id: string Optional quantity?: number Subscription Addon Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3438 Subscription Addon Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3448 Subscription Addon Filter Price Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3476 Subscription Addon Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3487 Subscription Addon Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3491 Subscription Billing Info Subscription
Billing
Info
: { billingAddress
?: BillingAddress ; chargeOnBehalfOfAccount
?: string ; couponId
?: string ; integrationId
?: string ; isBackdated
?: boolean ; isInvoicePaid
?: boolean ; metadata
?: Metadata | null ; taxPercentage
?: number ; taxRateIds
?: string [] } Type declaration Optional charge On Behalf Of Account?: string Optional coupon Id?: string Optional integration Id?: string Optional is Backdated?: boolean Optional is Invoice Paid?: boolean Optional metadata?: Metadata | null 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:3527 Subscription Cancellation Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3547 Subscription Coupon Configuration Input Subscription
Coupon
Configuration
Input
: { startDate
?: InputMaybe < Scalars [ "DateTime" ] > } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3562 Subscription Coupon Discount Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3567 Subscription Coupon Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3580 Subscription Entitlement Subscription
Entitlement
: { featureId
: string ; hasSoftLimit
?: boolean ; hasUnlimitedUsage
?: boolean ; monthlyResetPeriodConfiguration
?: { accordingTo
: MonthlyAccordingTo } ; resetPeriod
?: EntitlementResetPeriod ; usageLimit
?: number ; weeklyResetPeriodConfiguration
?: { accordingTo
: WeeklyAccordingTo } } Type declaration feature Id: string Optional has Soft Limit?: boolean Optional has Unlimited Usage?: boolean Optional monthly Reset Period Configuration?: { accordingTo: MonthlyAccordingTo } Optional usage Limit?: number Optional weekly Reset Period Configuration?: { accordingTo: WeeklyAccordingTo } Subscription Entitlement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3609 Subscription Entitlement Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3620 Subscription Entitlement Filter Feature Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3648 Subscription Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3662 Subscription Entitlement Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3673 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 ; payingCustomer
?: ( { __typename
?: "Customer" } & SlimCustomerFragment ) | null ; paymentCollection
: PaymentCollection ; paymentCollectionMethod
?: PaymentCollectionMethod | null ; 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 ; trialConfiguration
?: ( { __typename
?: "TrialConfiguration" } & SubscriptionTrialConfigurationFragment ) | null ; trialEndDate
?: any | null } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4894 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 Optional paying Customer?: ( { __typename?: "Customer" } & SlimCustomerFragment ) | 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 Configuration?: ( { __typename?: "TrialConfiguration" } & SubscriptionTrialConfigurationFragment ) | 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
?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_ ) | ( { __typename
?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename
?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_ ) | ( { __typename
?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename
?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename
?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_ ) | ( { __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:4844 Type declaration Optional __typename?: "SubscriptionFutureUpdate" Optional schedule Variables?: ( { __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_ ) | ( { __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_ ) | ( { __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_ ) | ( { __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:3685 Subscription Invoice Fragment Subscription
Invoice
Fragment
: { __typename
?: "SubscriptionInvoice" ; amountDue
?: number | null ; attemptCount
?: number | null ; billingId
: string ; billingReason
?: SubscriptionInvoiceBillingReason | null ; createdAt
: any ; currency
?: string | null ; errorMessage
?: string | null ; paymentSecret
?: string | null ; paymentUrl
?: string | null ; pdfUrl
?: string | null ; requiresAction
: boolean ; status
: SubscriptionInvoiceStatus ; subTotal
?: number | null ; subTotalExcludingTax
?: number | null ; tax
?: number | null ; total
?: number | null ; totalExcludingTax
?: number | null ; updatedAt
: any } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4873 Type declaration Optional __typename?: "SubscriptionInvoice" Optional amount Due?: number | null Optional attempt Count?: number | null billing Id: string created At: any Optional currency?: string | null Optional error Message?: string | null Optional payment Secret?: string | null Optional payment Url?: string | null Optional pdf Url?: string | null requires Action: boolean Optional sub Total?: number | null Optional sub Total Excluding Tax?: number | null Optional tax?: number | null Optional total?: number | null Optional total Excluding Tax?: number | null updated At: any Subscription Invoice Preview Fragment Subscription
Invoice
Preview
Fragment
: { __typename
?: "SubscriptionInvoicePreview" ; amountDue
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; 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 ; name
?: string | null ; type
: DiscountType ; value
: number } | null ; lastUpdatedAt
: any ; lines
: { __typename
?: "SubscriptionInvoicePreviewLineItem" ; amount
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; costDescription
: string ; description
: string ; hasSoftLimit
?: boolean | null ; lines
?: { __typename
?: "SubscriptionInvoicePreviewLineItemData" ; costDescription
: string ; description
: string ; hasSoftLimit
?: boolean | null ; proration
: boolean ; quantity
?: number | null ; type
: InvoiceLineItemType ; usageLimit
?: number | null } [] | null ; period
: { __typename
?: "SubscriptionInvoicePreviewLineItemPeriod" ; end
: any ; start
: any } ; price
?: ( { __typename
?: "Price" } & PriceFragment ) | null ; proration
: boolean ; quantity
?: number | null ; type
: InvoiceLineItemType ; unitPrice
?: { __typename
?: "Money" ; amount
: number ; currency
: Currency } | null ; usageLimit
?: number | null } [] ; minimumSpendAdjustment
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; subTotal
: { __typename
?: "Money" ; amount
: number ; currency
: Currency } ; subTotalExcludingTax
: { __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:5314 Type declaration Optional __typename?: "SubscriptionInvoicePreview" amount Due: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number 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 ; name?: string | null ; type: DiscountType ; value: number } | null last Updated At: any lines: { __typename?: "SubscriptionInvoicePreviewLineItem" ; amount: { __typename?: "Money" ; amount: number ; currency: Currency } ; costDescription: string ; description: string ; hasSoftLimit?: boolean | null ; lines?: { __typename?: "SubscriptionInvoicePreviewLineItemData" ; costDescription: string ; description: string ; hasSoftLimit?: boolean | null ; proration: boolean ; quantity?: number | null ; type: InvoiceLineItemType ; usageLimit?: number | null } [] | null ; period: { __typename?: "SubscriptionInvoicePreviewLineItemPeriod" ; end: any ; start: any } ; price?: ( { __typename?: "Price" } & PriceFragment ) | null ; proration: boolean ; quantity?: number | null ; type: InvoiceLineItemType ; unitPrice?: { __typename?: "Money" ; amount: number ; currency: Currency } | null ; usageLimit?: number | null } [] minimum Spend Adjustment: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number sub Total: { __typename?: "Money" ; amount: number ; currency: Currency } Optional __typename?: "Money" amount: number sub Total Excluding Tax: { __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 Migration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3747 Subscription Migration Task Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3752 Subscription Migration Task Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3761 Subscription Minimum Spend Value Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3779 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 ; name
?: string | null ; 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 ; name
?: string | null ; 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:5050 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 ; name?: string | null ; 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 ; name?: string | null ; 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:5178 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:5298 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:3783 Subscription Price Filter Customer Subscription Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3796 Subscription Price Filter Price Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3824 Subscription Price Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3835 Subscription Scheduled Update Data Fragment Subscription
Scheduled
Update
Data
Fragment
: { __typename
?: "SubscriptionScheduledUpdate" ; scheduleStatus
: SubscriptionScheduleStatus ; scheduleVariables
?: ( { __typename
?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename
?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_ ) | ( { __typename
?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename
?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_ ) | ( { __typename
?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename
?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename
?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_ ) | ( { __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:4815 Type declaration Optional __typename?: "SubscriptionScheduledUpdate" Optional schedule Variables?: ( { __typename?: "AddonChangeVariables" } & ScheduleVariablesFragment_AddonChangeVariables_ ) | ( { __typename?: "AddonPriceOverrideChangeVariables" } & ScheduleVariablesFragment_AddonPriceOverrideChangeVariables_ ) | ( { __typename?: "BillingPeriodChangeVariables" } & ScheduleVariablesFragment_BillingPeriodChangeVariables_ ) | ( { __typename?: "CouponChangeVariables" } & ScheduleVariablesFragment_CouponChangeVariables_ ) | ( { __typename?: "DowngradeChangeVariables" } & ScheduleVariablesFragment_DowngradeChangeVariables_ ) | ( { __typename?: "PlanChangeVariables" } & ScheduleVariablesFragment_PlanChangeVariables_ ) | ( { __typename?: "PlanPriceOverrideChangeVariables" } & ScheduleVariablesFragment_PlanPriceOverrideChangeVariables_ ) | ( { __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:3894 Subscription Trial Configuration Fragment Subscription
Trial
Configuration
Fragment
: { __typename
?: "TrialConfiguration" ; trialEndBehavior
: TrialEndBehavior } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4960 Type declaration Optional __typename?: "TrialConfiguration" Subscription Update Schedule Cancellation Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3910 Subscription Update Usage Reset Cutoff Rule Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3925 Sync Tax Rates Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3936 Task Status Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3947 Task Type Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3973 Tax Exempt Tax Exempt: { type: string ; value: string }
Type declaration type: string value: string Test Hook Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:3993 Tiers Mode Filter Comparison Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4003 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:4590 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:4019 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:6394 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:6391 Transfer Subscription To Resource Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4025 Transfer Subscription To Resource Mutation Transfer
Subscription
To
Resource
Mutation
: { __typename
?: "Mutation" ; transferSubscriptionToResource
: { __typename
?: "CustomerSubscription" } & SlimSubscriptionFragment } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6412 Type declaration Optional __typename?: "Mutation" transfer Subscription To Resource: { __typename?: "CustomerSubscription" } & SlimSubscriptionFragment Transfer Subscription To Resource Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6409 Trial Override Configuration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4040 Trialed Plan Trialed Plan: { planId: string ; productId: string }
Type declaration plan Id: string product Id: string 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:4052 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:4056 Trigger Subscription Usage Sync Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4062 Typography Configuration Fragment Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5495 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:4070 Un Archive Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4078 Un Archive Plan Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4085 Unarchive Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4091 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:6385 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:6382 Unarchive Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4095 Unit Transformation Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4100 Update Account Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4117 Update Coupon Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4124 Update Customer Update
Customer
: { billingId
?: string ; billingInfo
?: BillingInfo ; couponId
?: string | null ; customerId
: string ; email
?: string ; integrationId
?: string ; metadata
?: Metadata | null ; name
?: string ; salesforceId
?: string ; shouldWaitSync
?: boolean } Type declaration Optional billing Id?: string Optional billing Info?: BillingInfo Optional coupon Id?: string | null customer Id: string Optional email?: string Optional integration Id?: string Optional metadata?: Metadata | null Optional name?: string Optional salesforce Id?: string Optional should Wait Sync?: boolean Update Customer Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4131 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:6201 Update Customer Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6198 Update Experiment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4146 Update Feature Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4157 Update Hook Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4169 Update Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4181 Update One Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4194 Update One Hook Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4200 Update One Integration Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4206 Update One Package Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4212 Update One Product Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4218 Update One Promotional Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4224 Update Package Entitlement Order Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4230 Update Package Entitlement Order Item Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4235 Update Stripe Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4239 Update Subscription Type declaration Optional await Payment Confirmation?: boolean Optional metadata?: Metadata | null subscription Id: string Optional trial End Date?: Date Optional unit Quantity?: number Update Subscription Entitlement Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4242 Update Subscription Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4253 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:6263 Update Subscription Mutation Variables Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6260 Update User Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4277 Usage Event Report Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4281 Usage Events Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4289 Usage Events Report Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4297 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 ; value
: number } [] } [] | null ; markers
: { __typename
?: "UsageMarker" ; timestamp
: any ; type
: UsageMarkerType } [] ; startDate
: any ; usageMeasurements
: { __typename
?: "UsageMeasurementPoint" ; date
: any ; isResetPoint
: boolean ; value
: number } [] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6004 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 ; value: number } [] } [] | null markers: { __typename?: "UsageMarker" ; timestamp: any ; type: UsageMarkerType } [] start Date: any usage Measurements: { __typename?: "UsageMeasurementPoint" ; date: any ; isResetPoint: boolean ; value: number } [] Usage History Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4301 Usage History Point Usage History Point: { date: Date ; isResetPoint: boolean ; value: number }
Type declaration date: Date is Reset Point: boolean value: number Usage History V2 Fragment Usage
History
V2
Fragment
: { __typename
?: "UsageHistoryV2" ; markers
: { __typename
?: "UsageMarker" ; timestamp
: any ; type
: UsageMarkerType } [] ; series
: { __typename
?: "UsageHistorySeries" ; points
: { __typename
?: "UsageHistoryPoint" ; isResetPoint
: boolean ; timestamp
: any ; value
: number } [] ; tags
: { __typename
?: "UsageHistorySeriesTag" ; key
: string ; value
: string } [] } [] } Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6034 Type declaration Optional __typename?: "UsageHistoryV2" markers: { __typename?: "UsageMarker" ; timestamp: any ; type: UsageMarkerType } [] series: { __typename?: "UsageHistorySeries" ; points: { __typename?: "UsageHistoryPoint" ; isResetPoint: boolean ; timestamp: any ; value: number } [] ; tags: { __typename?: "UsageHistorySeriesTag" ; key: string ; value: string } [] } [] Usage History V2 Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4315 Usage Measurement Create Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4337 Usage Measurement Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4347 Usage Measurement Filter Customer Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4356 Usage Measurement Filter Feature Filter Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4374 Usage Measurement Sort Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4388 Usage Updated Fragment Usage Updated Fragment: { __typename?: "UsageMeasurementUpdated" ; currentUsage: number ; customerId: string ; featureId: string ; nextResetDate?: number | null ; resourceId?: string | null ; usagePeriodEnd?: number | null ; usagePeriodStart?: number | null }
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:5456 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 Optional usage Period End?: number | null Optional usage Period Start?: number | null Validate Merge Environment Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4403 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:4422 Weekly Reset Period Config Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4462 Widget Configuration Update Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4465 Yearly Reset Period Config Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4481 Zuora Credentials Input Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:4484 Variables Const Addon Dependency Fragment DocAddon Dependency Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6622 Const Addon Fragment DocAddon Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6623 Const Apply Subscription DocumentApply Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6684 Const Apply Subscription Fragment DocApply Subscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6673 Const Archive Customer DocumentArchive Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6699 Const Cancel Subscription DocumentCancel Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6687 Const Cancel Subscription Updates DocumentCancel Subscription Updates Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6692 Const Checkout Configuration Fragment DocCheckout Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6656 Const Checkout State Fragment DocCheckout State Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6657 Const Coupon Fragment DocCoupon Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6611 Const Create Subscription DocumentCreate Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6697 Const Customer Fragment DocCustomer Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6613 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:6651 Const Customer Portal Configuration Fragment DocCustomer Portal Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6654 Const Customer Portal Entitlement Fragment DocCustomer Portal Entitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6649 Const Customer Portal Fragment DocCustomer Portal Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6655 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:6650 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:6646 Const Customer Portal Subscription Fragment DocCustomer Portal Subscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6648 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:6645 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:6647 Const Customer Resource Fragment DocCustomer Resource Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6615 Const Customer Statistics Fragment DocCustomer Statistics Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6632 Const Customer With Subscriptions Fragment DocCustomer With Subscriptions Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6631 Const Delegate Subscription To Customer DocumentDelegate Subscription To Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6702 Const Detach Customer Payment Method DocumentDetach Customer Payment Method Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6680 Const Entitlement Fragment DocEntitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6640 Const Entitlement Usage Updated Fragment DocEntitlement Usage Updated Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6643 Const Entitlements Updated Payload Fragment DocEntitlements Updated Payload Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6641 Const Estimate Subscription DocumentEstimate Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6688 Const Estimate Subscription Update DocumentEstimate Subscription Update Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6689 Const Feature Fragment DocFeature Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6639 Const Font Variant Fragment DocFont Variant Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6652 Const Get Active Subscriptions DocumentGet Active Subscriptions Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6706 Const Get Active Subscriptions List DocumentGet Active Subscriptions List Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6707 Const Get Checkout State DocumentGet Checkout State Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6716 Const Get Coupons DocumentGet Coupons Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6709 Const Get Customer By Id DocumentGet Customer By Id Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6704 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:6715 Const Get Customer Statistics DocumentGet Customer Statistics Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6705 Const Get Entitlement DocumentGet Entitlement Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6712 Const Get Entitlements DocumentGet Entitlements Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6711 Const Get Mock Paywall DocumentGet Mock Paywall Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6717 Const Get Paywall DocumentGet Paywall Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6710 Const Get Products DocumentGet Products Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6713 Const Get Sdk Configuration DocumentGet Sdk Configuration Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6714 Const Get Subscription DocumentGet Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6708 Const Get Usage History DocumentGet Usage History Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6718 Const Get Usage History V2 DocumentGet Usage History V2 Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6719 Const Grant Promotional Entitlements DocumentGrant Promotional Entitlements Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6681 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:6634 Const Import Customer Bulk DocumentImport Customer Bulk Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6677 Const Import Customer DocumentImport Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6678 Const Import Subscriptions Bulk DocumentImport Subscriptions Bulk Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6685 Const Layout Configuration Fragment DocLayout Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6665 Const Migrate Subscription To Latest DocumentMigrate Subscription To Latest Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6698 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:6660 Const Mock Paywall Addon Fragment DocMock Paywall Addon Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6661 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:6658 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:6662 Const Mock Paywall Plan Fragment DocMock Paywall Plan Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6663 Const Mock Paywall Price Fragment DocMock Paywall Price Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6659 Const On Entitlements Updated DocumentOn Entitlements Updated Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6720 Const On Package Published DocumentOn Package Published Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6722 Const On Usage Updated DocumentOn Usage Updated Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6721 Const Overage Price Fragment DocOverage Price Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6621 Const Package Entitlement Fragment DocPackage Entitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6620 Const Package Published Payload Fragment DocPackage Published Payload Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6644 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:6667 Const Paywall Configuration Fragment DocPaywall Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6666 Const Paywall Currency Fragment DocPaywall Currency Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6664 Const Paywall Fragment DocPaywall Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6668 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:6624 Const Plan Fragment DocPlan Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6625 Const Preview Next Invoice DocumentPreview Next Invoice Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6691 Const Preview Subscription DocumentPreview Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6690 Const Price Fragment DocPrice Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6617 Const Price Tier Fragment DocPrice Tier Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6616 Const Product Fragment DocProduct Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6619 Const Promotional Entitlement Fragment DocPromotional Entitlement Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6612 Const Provision Customer DocumentProvision Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6676 Const Provision Customer Fragment DocProvision Customer Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6672 Const Provision Subscription DocumentProvision Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6683 Const Provision Subscription Fragment DocProvision Subscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6674 Const Report Entitlement Check Requested DocumentReport Entitlement Check Requested Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6696 Const Report Event DocumentReport Event Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6695 Const Report Usage Bulk DocumentReport Usage Bulk Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6694 Const Report Usage DocumentReport Usage Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6693 Const Report Usage Fragment DocReport Usage Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6675 Const Reset Period Configuration Fragment DocReset Period Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6638 Const Revoke Promotional Entitlement DocumentRevoke Promotional Entitlement Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6682 Const Schedule Variables Fragment DocSchedule Variables Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6626 Const Slim Customer Fragment DocSlim Customer Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6610 Const Slim Subscription Fragment DocSlim Subscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6671 Const Slim Subscription Fragment V2 Fragment DocSlim Subscription Fragment V2 Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6609 Const Subscription Fragment DocSubscription Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6630 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:6628 Const Subscription Invoice Fragment DocSubscription Invoice Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6614 Const Subscription Invoice Preview Fragment DocSubscription Invoice Preview Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6637 Const Subscription Preview Fragment DocSubscription Preview Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6633 Const Subscription Preview Invoice Fragment DocSubscription Preview Invoice Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6635 Const Subscription Preview V2 Fragment DocSubscription Preview V2 Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6636 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:6627 Const Subscription Trial Configuration Fragment DocSubscription Trial Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6629 Const Total Price Fragment DocTotal Price Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6618 Const Transfer Subscription DocumentTransfer Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6701 Const Transfer Subscription To Resource DocumentTransfer Subscription To Resource Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6703 Const Typography Configuration Fragment DocTypography Configuration Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6653 Const Unarchive Customer DocumentUnarchive Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6700 Const Update Customer DocumentUpdate Customer Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6679 Const Update Subscription DocumentUpdate Subscription Document: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6686 Const Usage History Fragment DocUsage History Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6669 Const Usage History V2 Fragment DocUsage History V2 Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6670 Const Usage Updated Fragment DocUsage Updated Fragment Doc: DocumentNode
Defined in node_modules/@stigg/api-client-js/src/generated/sdk.d.ts:6642
The id of the record.