@stigg/react-sdk - v5.24.0

Index

Enumerations

AccessDeniedReason AccountStatus AddonSortFields AggregationFunction Alignment ApiKeySortFields ApiKeyType Auth0Region BillingAnchor BillingCadence BillingModel BillingPeriod BillingVendorIdentifier ChangeType ConditionOperation CouponSortFields CouponStatus CouponType Currency CustomerPortalIntentionType CustomerResourceSortFields CustomerSortFields CustomerSubscriptionSortFields Department DiscountDurationType DiscountType EntitlementBehavior EntitlementResetPeriod EntitySelectionMode EnvironmentProvisionStatus EnvironmentSortFields EnvironmentType ErrorCode EventActor EventEntityType EventLogSortFields EventLogType ExperimentGroupType ExperimentSortFields ExperimentStatus FeatureSortFields FeatureStatus FeatureType HookSortFields HookStatus ImportIntegrationTaskSortFields IntegrationSortFields InvoiceLineItemType LogLevel MemberSortFields MemberStatus MeterType MonthlyAccordingTo OverageBillingPeriod PackageDtoSortFields PackageEntitlementSortFields PackageGroupSortFields PackageGroupStatus PackageStatus PaymentCollection PaymentCollectionMethod PaymentMethodType PlanChangeType PlanSortFields PriceSortFields PricingType ProductSortFields PromotionalEntitlementPeriod PromotionalEntitlementSortFields PromotionalEntitlementStatus ProrationBehavior ProvisionStatus ProvisionSubscriptionStatus PublishMigrationType ScheduleStrategy SortDirection SortNulls SourceType SubscribeIntentionType SubscriptionAddonSortFields SubscriptionCancelReason SubscriptionCancellationAction SubscriptionCancellationTime SubscriptionDecisionStrategy SubscriptionEndSetup SubscriptionEntitlementSortFields SubscriptionInvoiceBillingReason SubscriptionInvoiceStatus SubscriptionMigrationTaskSortFields SubscriptionMigrationTime SubscriptionPriceSortFields SubscriptionScheduleStatus SubscriptionScheduleType SubscriptionStartSetup SubscriptionStatus SyncStatus TaskStatus TaskType TiersMode TrialPeriodUnits UnitTransformationRound UsageMeasurementSortFields UsageUpdateBehavior VendorIdentifier WeeklyAccordingTo WidgetType YearlyAccordingTo

Interfaces

Type Aliases

AddCompatibleAddonsToPlanInput Addon AddonArchiveInput AddonAssociatedEntitiesInput AddonCreateInput AddonDependencyFragment AddonFilter AddonFragment AddonSort AddonUpdateInput Address AggregatedEventsByCustomerInput ApiKeyFilter ApiKeySort ApplySubscription ApplySubscriptionFragment ApplySubscriptionInput ApplySubscriptionMutation ApplySubscriptionMutationVariables ApplySubscriptionResults ArchiveCouponInput ArchiveCustomerInput ArchiveCustomerMutation ArchiveCustomerMutationVariables ArchiveEnvironmentInput ArchiveFeatureInput ArchivePackageGroup ArchivePlanInput AttachCustomerPaymentMethodInput Auth0CredentialsInput AutoCancellationRuleInput AwsMarketplaceCredentialsInput BaseEntitlement BasePlan BigQueryCredentialsInput BillableFeature BillableFeatureInput BillingAddress BillingCadenceFilterComparison BillingInformation BillingModelFilterComparison BillingPeriodFilterComparison BooleanEntitlementFallback BooleanEntitlementOptions BooleanFieldComparison BudgetConfigurationInput CancelSubscriptionMutation CancelSubscriptionMutationVariables CancelSubscriptionUpdatesMutation CancelSubscriptionUpdatesMutationVariables ChargeSubscriptionUsageInput CheckoutAddon CheckoutBillingIntegration CheckoutConfiguration CheckoutConfigurationFragment CheckoutConfigurationInput CheckoutContainerProps CheckoutContentInput CheckoutLocalization CheckoutMockProps CheckoutOptions CheckoutPaletteInput CheckoutProps CheckoutProviderProps CheckoutResult CheckoutStateFragment CheckoutStateInput CheckoutStatePlan CheckoutTheme ClearCustomerPersistentCacheInput ClientConfiguration CompatiblePackageGroup CompatiblePackageGroupOptions Coupon CouponFilter CouponFilterCustomerFilter CouponFragment CouponSort CouponStatusFilterComparison CouponTypeFilterComparison CreateCouponInput CreateEnvironment CreateEnvironmentOptions CreateExperimentInput CreateHook CreateIntegrationInput CreateManyPackageEntitlementsInput CreateManyPromotionalEntitlementsInput CreateMeter CreateOneEnvironmentInput CreateOneHookInput CreateOneIntegrationInput CreateOneProductInput CreateOrUpdateAwsMarketplaceProductInput CreatePackageGroup CreateSubscriptionMutation CreateSubscriptionMutationVariables CurrentPlanParams CursorPaging Customer CustomerBillingInfo CustomerFilter CustomerFilterCustomerSubscriptionFilter CustomerFilterPromotionalEntitlementFilter CustomerFragment CustomerInput CustomerPortalBillingInformation CustomerPortalBillingInformationFragment CustomerPortalColorsPaletteInput CustomerPortalConfiguration CustomerPortalConfigurationFragment CustomerPortalConfigurationInput CustomerPortalEntitlement CustomerPortalEntitlementFragment CustomerPortalFragment CustomerPortalInput CustomerPortalLocalization CustomerPortalPromotionalEntitlement CustomerPortalPromotionalEntitlementFragment CustomerPortalProps CustomerPortalSection CustomerPortalSubscription CustomerPortalSubscriptionAddon CustomerPortalSubscriptionAddonFragment CustomerPortalSubscriptionFragment CustomerPortalSubscriptionPriceFragment CustomerPortalSubscriptionScheduledUpdateDataFragment CustomerPortalTheme CustomerResource CustomerResourceFilter CustomerResourceFilterCustomerFilter CustomerResourceFilterCustomerSubscriptionFilter CustomerResourceFragment CustomerResourceSort CustomerSearchQueryFilterComparison CustomerSort CustomerState CustomerStatisticsFragment CustomerSubscriptionFilter CustomerSubscriptionFilterCustomerFilter CustomerSubscriptionFilterCustomerResourceFilter CustomerSubscriptionFilterPlanFilter CustomerSubscriptionFilterSubscriptionAddonFilter CustomerSubscriptionFilterSubscriptionEntitlementFilter CustomerSubscriptionFilterSubscriptionPriceFilter CustomerSubscriptionSort CustomerUsageDataProps CustomerWithSubscriptionsFragment DateFieldComparison DateFieldComparisonBetween DateRange DefaultTrialConfig DefaultTrialConfigInputDto DeleteFeatureInput DeleteOneHookInput DeleteOneIntegrationInput DeleteOnePackageEntitlementInput DeleteOnePriceInput DeleteOneProductInput DeleteOnePromotionalEntitlementInput DependencyAddon DetachCustomerPaymentMethodInput DetachCustomerPaymentMethodMutation DetachCustomerPaymentMethodMutationVariables DimensionsMappingInput DiscardPackageDraftInput DoesFeatureExist DumpEnvironmentForForMergeComparisonInput DumpEnvironmentProductCatalogInput DuplicateProductInput EditPackageGroupDetailsInput EligibleForTrial Entitlement EntitlementCheckRequested EntitlementCheckResult EntitlementFeature EntitlementFragment EntitlementOptions EntitlementUsageUpdatedFragment EntitlementsFallback EntitlementsUpdatedPayloadFragment EnvironmentFilter EnvironmentInput EnvironmentSort EstimateSubscription EstimateSubscriptionInput EstimateSubscriptionMutation EstimateSubscriptionMutationVariables EstimateSubscriptionUpdate EstimateSubscriptionUpdateInput EstimateSubscriptionUpdateMutation EstimateSubscriptionUpdateMutationVariables EventLogCreatedAtFilterComparison EventLogEntityIdFilterComparison EventLogEnvironmentIdFilterComparison EventLogEventLogTypeFilterComparison EventLogFilter EventLogIdFilterComparison EventLogParentEntityIdFilterComparison EventLogSort EventsFieldsInput Exact ExperimentFilter ExperimentFilterCustomerFilter ExperimentInfo ExperimentSort ExperimentStatsQuery ExperimentStatusFilterComparison FeatureAssociatedLatestPackages FeatureFilter FeatureFragment FeatureInput FeatureSort FeatureStatusFilterComparison FeatureTypeFilterComparison FetchEntitlementQuery FetchEntitlementsQuery FetchUsageHistory FontVariant FontVariantFragment FontVariantInput FontWeight GetActiveSubscriptions GetActiveSubscriptionsInput GetActiveSubscriptionsListQuery GetActiveSubscriptionsListQueryVariables GetActiveSubscriptionsQuery GetActiveSubscriptionsQueryVariables GetBooleanEntitlement GetCheckoutState GetCheckoutStateQuery GetCheckoutStateQueryVariables GetCheckoutStateResults GetCouponsQuery GetCouponsQueryVariables GetCustomerByIdQuery GetCustomerByIdQueryVariables GetCustomerByRefIdInput GetCustomerPortal GetCustomerPortalByRefIdQuery GetCustomerPortalByRefIdQueryVariables GetCustomerStatisticsQuery GetCustomerStatisticsQueryVariables GetEntitlementQuery GetEntitlementQueryVariables GetEntitlementsQuery GetEntitlementsQueryVariables GetMeteredEntitlement GetMockPaywallQuery GetMockPaywallQueryVariables GetNumericEntitlement GetPackageByRefIdInput GetPackageGroup GetPaywall GetPaywallInput GetPaywallQuery GetPaywallQueryVariables GetProductsQuery GetProductsQueryVariables GetSdkConfigurationQuery GetSdkConfigurationQueryVariables GetSubscription GetSubscriptionInput GetSubscriptionQuery GetSubscriptionQueryVariables GetUsageHistoryQuery GetUsageHistoryQueryVariables GetWidgetConfigurationInput GrantPromotionalEntitlementInput GrantPromotionalEntitlementsInput GrantPromotionalEntitlementsMutation GrantPromotionalEntitlementsMutationVariables HookFilter HookSort HookStatusFilterComparison HorizontalAlignment HubspotCredentialsInput ImmediateSubscriptionPreviewInvoice ImmediateSubscriptionPreviewInvoiceFragment ImportCustomerBulkInput ImportCustomerBulkMutation ImportCustomerBulkMutationVariables ImportCustomerInput ImportCustomerMutation ImportCustomerMutationVariables ImportIntegrationCatalogInput ImportIntegrationCustomersInput ImportIntegrationTaskFilter ImportIntegrationTaskSort ImportSubscriptionInput ImportSubscriptionsBulkInput ImportSubscriptionsBulkMutation ImportSubscriptionsBulkMutationVariables InitAddStripeCustomerPaymentMethodInput InputMaybe IntFieldComparison IntFieldComparisonBetween IntegrationFilter IntegrationSort LayoutConfigurationFragment ListAwsProductDimensionsInput ListAwsProductsInput MakeMaybe MakeOptional MarkInvoiceAsPaidInput Maybe MemberFilter MemberSort MergeEnvironmentInput MeterAggregation MeterConditionInput MeterFilterDefinitionInput MeterTypeFilterComparison MeteredEntitlementFallback MeteredEntitlementOptions MigrateSubscriptionToLatestMutation MigrateSubscriptionToLatestMutationVariables MinimumSpendInput MockCheckoutPreviewCallback MockCheckoutStateCallback MockPaywallAddonDependencyFragment MockPaywallAddonFragment MockPaywallPackageEntitlementFragment MockPaywallPlanCompatiblePackageGroupsFragment MockPaywallPlanFragment MockPaywallPriceFragment Money MoneyInputDto MonthlyResetPeriodConfigInput NumberFieldComparison NumberFieldComparisonBetween NumericEntitlementFallback NumericEntitlementOptions OnBuyMoreCallbackFn OnCheckoutCompletedParams OnCheckoutParams OnEntitlementsUpdatedSubscription OnEntitlementsUpdatedSubscriptionVariables OnManageSubscriptionFn OnPackagePublishedSubscription OnPackagePublishedSubscriptionVariables OnPlanSelectedCallbackFn OnUsageUpdatedSubscription OnUsageUpdatedSubscriptionVariables OpenFgaCredentialsInput OverageEntitlementCreateInput OveragePriceFragment OveragePricingModelCreateInput PackageDtoFilter PackageDtoSort PackageEntitlement PackageEntitlementFilter PackageEntitlementFilterFeatureFilter PackageEntitlementFilterPackageDtoFilter PackageEntitlementFragment PackageEntitlementInput PackageEntitlementSort PackageEntitlementUpdateInput PackageGroupFilter PackageGroupFilterProductFilter PackageGroupSort PackageGroupStatusFilterComparison PackagePricingInput PackagePublishInput PackagePublishedPayloadFragment PackageStatusFilterComparison PaymentCollectionFilterComparison PaymentMethodDetails PaywallCalculatedPricePoint PaywallCalculatedPricePointsFragment PaywallColorsPaletteInput PaywallConfiguration PaywallConfigurationFragment PaywallConfigurationInput PaywallCurrency PaywallCurrencyFragment PaywallData PaywallFragment PaywallLayoutConfigurationInput PaywallLocalization PaywallPlan PaywallProps Plan PlanCompatiblePackageGroupsFragment PlanCreateInput PlanFilter PlanFilterAddonFilter PlanFilterProductFilter PlanFragment PlanPriceText PlanSort PlanUpdateInput PreparePaymentMethodFormInput PreviewNextInvoiceInput PreviewNextInvoiceMutation PreviewNextInvoiceMutationVariables PreviewSubscription PreviewSubscriptionInput PreviewSubscriptionMutation PreviewSubscriptionMutationVariables Price PriceFilter PriceFilterPackageDtoFilter PriceFragment PriceOverrideInput PricePeriodInput PriceSort PriceTierFragment PriceTierInput PricingModelCreateInput PricingTypeFilterComparison Product ProductCreateInput ProductFilter ProductFragment ProductSettingsInput ProductSort ProductUpdateInput PromotionalEntitlement PromotionalEntitlementFilter PromotionalEntitlementFragment PromotionalEntitlementInput PromotionalEntitlementSort PromotionalEntitlementStatusFilterComparison PromotionalEntitlementUpdateInput ProvisionCustomerFragment ProvisionCustomerInput ProvisionCustomerMutation ProvisionCustomerMutationVariables ProvisionCustomerSubscriptionInput ProvisionSandboxInput ProvisionSubscription ProvisionSubscriptionFragment ProvisionSubscriptionInput ProvisionSubscriptionMutation ProvisionSubscriptionMutationVariables RecalculateEntitlementsInput RecalculateEntitlementsSideEffectsOptionsInput RemoveBasePlanFromPlanInput RemoveCompatibleAddonsFromPlanInput RemoveCouponFromCustomerInput RemoveCouponFromCustomerSubscriptionInput RemoveExperimentFromCustomerInput RemoveExperimentFromCustomerSubscriptionInput ReportEntitlementCheckRequestedMutation ReportEntitlementCheckRequestedMutationVariables ReportEventMutation ReportEventMutationVariables ReportUsageBaseInput ReportUsageBulkInput ReportUsageBulkMutation ReportUsageBulkMutationVariables ReportUsageFragment ReportUsageInput ReportUsageMutation ReportUsageMutationVariables ResetPeriodConfigurationFragment ResetSettings ResyncIntegrationInput RevokePromotionalEntitlementInput RevokePromotionalEntitlementMutation RevokePromotionalEntitlementMutationVariables SalesforceCredentialsInput Scalars ScheduleVariablesFragment Sdk SdkFunctionWrapper SelectDefaultTierIndexFn SetBasePlanOnPlanInput SetCompatibleAddonsOnPlanInput SetCouponOnCustomerInput SetCouponOnCustomerSubscriptionInput SetExperimentOnCustomerInput SetExperimentOnCustomerSubscriptionInput SetPackageGroupAddons SetPlanCompatiblePackageGroup SetPlanCompatiblePackageGroupOptions SetPlanCompatiblePackageGroups ShouldHidePlanFn SlimCustomer SlimCustomerFragment SlimSubscriptionFragment SlimSubscriptionFragmentV2Fragment SnowflakeCredentialsInput StartExperimentInput StiggProviderProps StiggTheme StopExperimentInput StringFieldComparison StripeCredentialsInput StripeCustomerSearchInput StripeProductSearchInput StripeSubscriptionSearchInput Subscription SubscriptionAddon SubscriptionAddonFilter SubscriptionAddonFilterCustomerSubscriptionFilter SubscriptionAddonFilterPriceFilter SubscriptionAddonInput SubscriptionAddonSort SubscriptionBillingInfo SubscriptionCancelReasonFilterComparison SubscriptionCancellationInput SubscriptionCouponInput SubscriptionEntitlementFilter SubscriptionEntitlementFilterCustomerSubscriptionFilter SubscriptionEntitlementFilterFeatureFilter SubscriptionEntitlementInput SubscriptionEntitlementSort SubscriptionEstimationAddon SubscriptionFragment SubscriptionFutureUpdateDataFragment SubscriptionInput SubscriptionInvoiceFragment SubscriptionInvoicePreviewFragment SubscriptionMigrationInput SubscriptionMigrationTaskFilter SubscriptionMigrationTaskSort SubscriptionMinimumSpendValueInput SubscriptionPreviewCredits SubscriptionPreviewDiscount SubscriptionPreviewFragment SubscriptionPreviewInvoice SubscriptionPreviewInvoiceFragment SubscriptionPreviewProration SubscriptionPreviewTaxDetails SubscriptionPreviewV2Fragment SubscriptionPrice SubscriptionPriceFilter SubscriptionPriceFilterCustomerSubscriptionFilter SubscriptionPriceFilterPriceFilter SubscriptionPricePreview SubscriptionPriceSort SubscriptionScheduledUpdateDataFragment SubscriptionStatusFilterComparison SubscriptionUpdateScheduleCancellationInput SubscriptionsOverviewProps SyncTaxRatesInput TaskStatusFilterComparison TaskTypeFilterComparison TaxDetailsInput TaxExempt TestHookInput TextAlignment Theme TiersModeFilterComparison TotalPriceFragment TransferSubscriptionInput TransferSubscriptionMutation TransferSubscriptionMutationVariables TrialOverrideConfigurationInput TrialedPlan TriggerSubscriptionBillingMonthEndsSoonWebhookInput TriggerSubscriptionMigrationInput TriggerSubscriptionUsageSyncInput TypographyConfiguration TypographyConfigurationFragment TypographyConfigurationInput UnarchiveCustomerInput UnarchiveCustomerMutation UnarchiveCustomerMutationVariables UnarchiveEnvironmentInput UnitTransformationInput UpdateAccountInput UpdateCouponInput UpdateCustomerInput UpdateCustomerMutation UpdateCustomerMutationVariables UpdateExperimentInput UpdateFeatureInput UpdateHook UpdateIntegrationInput UpdateOneEnvironmentInput UpdateOneHookInput UpdateOneIntegrationInput UpdateOnePackageEntitlementInput UpdateOneProductInput UpdateOnePromotionalEntitlementInput UpdatePackageEntitlementOrderInput UpdatePackageEntitlementOrderItemInput UpdateSubscriptionEntitlementInput UpdateSubscriptionInput UpdateSubscriptionMutation UpdateSubscriptionMutationVariables UpdateUserInput UsageEventReportInput UsageEventsInput UsageEventsReportInput UsageHistoryFragment UsageHistoryInput UsageHistoryPoint UsageMeasurementCreateInput UsageMeasurementFilter UsageMeasurementFilterCustomerFilter UsageMeasurementFilterFeatureFilter UsageMeasurementSort UsageUpdatedFragment ValidateMergeEnvironmentInput VendorIdentifierFilterComparison WaitForCheckoutCompleted WeeklyResetPeriodConfigInput WidgetConfigurationUpdateInput YearlyResetPeriodConfigInput ZuoraCredentialsInput

Variables

AddonDependencyFragmentDoc AddonFragmentDoc ApplySubscriptionDocument ApplySubscriptionFragmentDoc ArchiveCustomerDocument CancelSubscriptionDocument CancelSubscriptionUpdatesDocument CheckoutConfigurationFragmentDoc CheckoutStateFragmentDoc CouponFragmentDoc CreateSubscriptionDocument CustomerFragmentDoc CustomerPortalBillingInformationFragmentDoc CustomerPortalConfigurationFragmentDoc CustomerPortalEntitlementFragmentDoc CustomerPortalFragmentDoc CustomerPortalPromotionalEntitlementFragmentDoc CustomerPortalSubscriptionAddonFragmentDoc CustomerPortalSubscriptionFragmentDoc CustomerPortalSubscriptionPriceFragmentDoc CustomerPortalSubscriptionScheduledUpdateDataFragmentDoc CustomerResourceFragmentDoc CustomerStatisticsFragmentDoc CustomerWithSubscriptionsFragmentDoc DetachCustomerPaymentMethodDocument EntitlementFragmentDoc EntitlementUsageUpdatedFragmentDoc EntitlementsUpdatedPayloadFragmentDoc EstimateSubscriptionDocument EstimateSubscriptionUpdateDocument FeatureFragmentDoc FontVariantFragmentDoc GetActiveSubscriptionsDocument GetActiveSubscriptionsListDocument GetCheckoutStateDocument GetCouponsDocument GetCustomerByIdDocument GetCustomerPortalByRefIdDocument GetCustomerStatisticsDocument GetEntitlementDocument GetEntitlementsDocument GetMockPaywallDocument GetPaywallDocument GetProductsDocument GetSdkConfigurationDocument GetSubscriptionDocument GetUsageHistoryDocument GrantPromotionalEntitlementsDocument ImmediateSubscriptionPreviewInvoiceFragmentDoc ImportCustomerBulkDocument ImportCustomerDocument ImportSubscriptionsBulkDocument LayoutConfigurationFragmentDoc MigrateSubscriptionToLatestDocument MockPaywallAddonDependencyFragmentDoc MockPaywallAddonFragmentDoc MockPaywallPackageEntitlementFragmentDoc MockPaywallPlanCompatiblePackageGroupsFragmentDoc MockPaywallPlanFragmentDoc MockPaywallPriceFragmentDoc OnEntitlementsUpdatedDocument OnPackagePublishedDocument OnUsageUpdatedDocument OveragePriceFragmentDoc PackageEntitlementFragmentDoc PackagePublishedPayloadFragmentDoc PaywallCalculatedPricePointsFragmentDoc PaywallConfigurationFragmentDoc PaywallCurrencyFragmentDoc PaywallFragmentDoc PlanCompatiblePackageGroupsFragmentDoc PlanFragmentDoc PreviewNextInvoiceDocument PreviewSubscriptionDocument PriceFragmentDoc PriceTierFragmentDoc ProductFragmentDoc PromotionalEntitlementFragmentDoc ProvisionCustomerDocument ProvisionCustomerFragmentDoc ProvisionSubscriptionDocument ProvisionSubscriptionFragmentDoc ReportEntitlementCheckRequestedDocument ReportEventDocument ReportUsageBulkDocument ReportUsageDocument ReportUsageFragmentDoc ResetPeriodConfigurationFragmentDoc RevokePromotionalEntitlementDocument ScheduleVariablesFragmentDoc SlimCustomerFragmentDoc SlimSubscriptionFragmentDoc SlimSubscriptionFragmentV2FragmentDoc StiggContext SubscriptionFragmentDoc SubscriptionFutureUpdateDataFragmentDoc SubscriptionInvoiceFragmentDoc SubscriptionInvoicePreviewFragmentDoc SubscriptionPreviewFragmentDoc SubscriptionPreviewInvoiceFragmentDoc SubscriptionPreviewV2FragmentDoc SubscriptionScheduledUpdateDataFragmentDoc TotalPriceFragmentDoc TransferSubscriptionDocument TypographyConfigurationFragmentDoc UnarchiveCustomerDocument UpdateCustomerDocument UpdateSubscriptionDocument UsageHistoryFragmentDoc UsageUpdatedFragmentDoc

Functions