zerosettle library
Classes
- CancelFlowAnswer
- A single answer in the cancel flow questionnaire.
- CancelFlowAnswerPayload
- A single answer within a cancel flow response.
- CancelFlowCancelled
- The user completed the flow and chose to cancel.
- CancelFlowConfig
- Cancel flow configuration returned by the backend.
- CancelFlowDismissed
- The user dismissed the sheet without completing the flow.
- CancelFlowOffer
- Save offer configuration shown to retain the user.
- CancelFlowOption
- An answer option for a single-select question.
- CancelFlowPauseConfig
- Pause configuration within the cancel flow.
- CancelFlowPaused
- The user chose to pause their subscription.
- CancelFlowPauseOption
- A single pause duration option in the cancel flow.
- CancelFlowQuestion
- A single question in the cancel flow questionnaire.
- CancelFlowResponse
- The complete response submitted at the end of a cancel flow.
- CancelFlowResponsePayload
- Payload submitted to the backend after a cancel flow completes.
- CancelFlowResult
- The outcome of a cancel flow presentation.
- CancelFlowRetained
- The user accepted the save offer and was retained.
- CancelFlowSaveOfferResult
- Result of accepting a save offer.
- CheckoutConfig
- Configuration for the checkout UI behavior.
- CheckoutTransaction
- Represents a completed or pending purchase transaction.
- Entitlement
- Represents an active entitlement from either a StoreKit or web checkout purchase.
- JurisdictionCheckoutConfig
- Per-jurisdiction checkout configuration override.
- MigrationPrompt
- Data for a migration campaign prompt.
- MigrationTipView
- A widget that displays the ZeroSettle migration tip view.
- Price
-
A price with currency information.
Mirrors the Swift
Pricestruct in ZeroSettleKit. - Product
- A product available for web checkout via ZeroSettle.
- ProductCatalog
- The result of fetching the product catalog.
- Promotion
- An active promotion for a product.
- RemoteConfig
- Remote configuration from the ZeroSettle backend.
- UpgradeOfferConfig
- Upgrade offer configuration returned by the backend.
- UpgradeOfferCurrentProduct
- The user's current subscription product within an upgrade offer.
- UpgradeOfferDeclined
- The user explicitly declined the upgrade offer.
- UpgradeOfferDismissed
- The user dismissed the sheet without completing the flow.
- UpgradeOfferDisplay
- Display copy for the upgrade offer sheet.
- UpgradeOfferProration
- Proration details for the upgrade transition.
- UpgradeOfferResponsePayload
- Payload submitted to the backend after an upgrade offer completes.
- UpgradeOfferResult
- The outcome of an upgrade offer presentation.
- UpgradeOfferTargetProduct
- The target subscription product the user can upgrade to.
- UpgradeOfferUpgraded
- The user accepted the upgrade offer and was upgraded.
- ZeroSettle
- Main entry point for the ZeroSettle Flutter SDK.
Enums
- CancelFlowOutcome
- The outcome of a cancel flow for analytics/reporting.
- CheckoutType
- The type of checkout UI to present.
- EntitlementSource
- The origin of a purchase/entitlement.
- FunnelEventType
- Funnel analytics event types for paywall and checkout tracking.
- Jurisdiction
- Geographic jurisdiction for checkout configuration.
- PromotionType
- The type of promotional discount.
- TransactionStatus
- The status of a transaction.
- ZSProductType
- Product type for in-app purchases.
- ZSSaveTheSaleResult
- The user's choice from the save-the-sale retention sheet.
Typedefs
- ZSException = ZeroSettleException
- Backward-compatible typedef. Use ZeroSettleException instead.
- ZSMigrateTipView = MigrationTipView
- Backward-compatible typedef. Use MigrationTipView instead.
- ZSProduct = Product
- Backward-compatible typedef. Use Product instead.
- ZSTransaction = CheckoutTransaction
- Backward-compatible typedef. Use CheckoutTransaction instead.
Exceptions / Errors
- ZeroSettleException
- Base exception type for the ZeroSettle SDK.
- ZSApiException
- An API or network error occurred.
- ZSCancelledException
- The user cancelled the checkout flow.
- ZSCheckoutFailedException
- The checkout flow failed.
- ZSNotConfiguredException
- The SDK has not been configured. Call ZeroSettle.configure first.
- ZSProductNotFoundException
- No product found with the given identifier.
- ZSUserIdRequiredException
- A userId is required for this product type.
- ZSWebCheckoutDisabledException
- Web checkout is disabled for the user's jurisdiction.