Adapty Resources

Custom Actions

All Adapty actions are custom actions for FlutterFlow.

Custom Action	Description	Action Arguments	Adapty Data Types - Action Output Variable
activate	Initializes the Adapty SDK	None
getPaywall	Retrieves a paywall. It does not return paywall products. Use the getPaywallProducts action to get the actual products	Placement_ID Locale	AdaptyPaywall
getPaywallProducts	Returns a list of actual paywall products	AdaptyPaywall
getProductsIntroductoryOfferEligibility	Checks if the user qualifies for an introductory iOS subscription offer	AdaptyPaywallProduct	AdaptyEligibilityEnum
getProfile	Retrieves the current app user's profile. This allows you to set access levels and other parameters If it fails (e.g., due to no internet), cached data will be returned. Adapty regularly updates the profile cache to ensure the information stays as current as possible	None	AdaptyProfile
identify	Identifies the user using your system's customerUserId	customerUserId	None
logShowPaywall	Logs when a specific paywall is shown to the user	AdaptyPaywall	None
logout	Logs the current user out of your app	None	None
makePurchase	Completes a purchase and unlocks content. If a paywall has a promotional offer, Adapty automatically applies it at checkout	product: an AdaptyPaywallProduct object retrieved from the paywall. subscriptionUpdateParams: an AdaptySubscriptionUpdateParameters object used to upgrade or downgrade a subscription (use for Android). isOfferPersonalized: Specifies whether the offer is personalized to the buyer (use for Android).	AdaptyProfile
presentCodeRedemptionSheet	Displays a sheet that allows users to redeem codes (iOS only)	None	None
restorePurchases	Restores any purchases the user has made	None	AdaptyProfile

Data Types

AdaptyAccessLevel

Information about the user's access level.

Field name	Type	Description
activatedAt	DateTime	The time when this access level was activated
activeIntroductoryOfferType	String	The type of an active introductory offer. If not `null, it means an offer was applied during this subscription period
activePromotionalOfferId	String	The ID of an active promotional offer (use for iOS)
activePromotionalOfferType	String	The type of an active promotional offer (use for iOS). If not null, it means an offer was applied during this subscription period
billingIssueDetectedAt	DateTime	The time when a billing issue was detected. The subscription can still be active. Set to null if payment is successfully processed
cancellationReason	String	The reason why the subscription was canceled
expiresAt	DateTime	The access level expiration time (could be in the past or null for lifetime access)
id	String	Text
isActive	Boolean	True if this access level is active. Generally, you can check this property to determine if a user has an access to premium features
isInGracePeriod	Boolean	True if this auto-renewable subscription is in the grace period
isLifetime	Boolean	True if this access level is active for a lifetime (no expiration date)
isRefund	Boolean	True if this purchase was refunded
offerId	String	The ID of an active promotional offer (use for Android)
renewedAt	DateTime	The time when the access level was last renewed
startsAt	DateTime	The start time of this access level (could be in the future)
store	String	The store where the purchase was made
unsubscribedAt	DateTime	The time when auto-renewal was turned off for the subscription. The subscription can still be active. Null if the user reactivated the subscription
vendorProductId	String	The product ID from the store that unlocked this access level
willRenew	Boolean	True if this auto-renewable subscription is set to renew

AdaptyAccessLevelIdentifiers

Field name	Type	Description
accessLevelIdentifier	String	The ID of the access level
accessLevel	Data (AdaptyAccessLevel)	Contains the associated AdaptyAccessLevel

AdaptyCustomDoubleAttribute

Field name	Type	Description
key	String	The ID of the custom double attribute
value	Double	Value of the custom double attribute

AdaptyCustomStringAttribute

Field name	Type	Description
key	String	The ID of the custom string attribute
value	String	Value of the custom string attribute

AdaptyError

CContains details about an error. For a complete list of error codes, refer to Flutter, React Native, Unity - Handle errors.

Field name	Type	Description
errorMessage	String	A human-readable description of the error
errorCode	Integer	Numeric code identifying the error

AdaptyGetIntroEligibilitiesResult

Contains the result of the getProductsIntroductoryOfferEligibility custom action.

Field name	Type	Description
value	List < Data (AdaptyProductIntroEligibility) >	List of the user's eligibility for promotional offers
error	Data (AdaptyError)	Contains details about the error via AdaptyError

AdaptyGetPaywallResult

Contains the result of the getPaywall custom action.

Field name	Type	Description
value	Data (AdaptyPaywall)	Contains a list of [AdaptyPaywall](ff-resources#adaptypaywall) objects
error	Data (AdaptyError)	Contains error information via AdaptyError

AdaptyGetProductsResult

Contains the result of the getPaywallProducts custom action.

Field name	Type	Description
value	List < Data (AdaptyPaywallProduct) >	Contains a list of AdaptyPaywallProduct
error	Data (AdaptyError)	Contains error information via AdaptyError

AdaptyGetProfileResult

Contains the result of the getProfile custom action.

Field name	Type	Description
value	Data (AdaptyProfile)	Contains the user profile as an AdaptyProfile
error	Data (AdaptyError)	Contains error information via AdaptyError

AdaptyMakePurchaseResult

Contains the result of the makePurchase custom action.

Field name	Type	Description
value	Data (AdaptyProfile)	CContains the user's profile as an AdaptyProfile
error	Data (AdaptyError)	Contains error information via AdaptyError

AdaptyNonSubscription

Information about non-subscription purchases. These can be one-time (consumable) products, unlocks (like new map unlock in the game), etc

Field name	Type	Description
isConsumable	Boolean	Indicates whether the product is consumable
isOneTime	Boolean	Indicates if the product is a one-time purchase (e.g., if true, the purchase is processed only once)
isRefund	Boolean	Indicates if the product has been refunded
isSandbox	Boolean	Indicates if the product was purchased in a sandbox environment
purchasedAt	DateTime	The time when the product was purchased
purchaseId	String	The ID of the purchase in Adapty. Can be used for tracking one-time products
store	String	The store where the product was purchased (e.g., App Store, Google Play)
vendorProductId	String	ID of the product in vendor's system
vendorTransactionId	String	Transaction ID in the vendor's system

AdaptyPaywall

Information about a paywall.

Field name	Type	Description
abTestName	String	The name of the parent A/B test
hasViewConfiguration	Boolean	Indicates if there is a view configuration for the paywall
locale	String	The locale ID of the paywall
name	String	Paywall name
placementId	String	The ID of the parent placement
remoteConfigString	String	A custom dictionary from Adapty Dashboard associated with this paywall
revision	Integer	The current revision/version of the paywall. Every change generates a new revision
variationId	String	The variation ID used to attribute purchases to this paywall
vendorProductIds	String	Array of product IDs related to the paywall

Enums

AdaptyEligibilityEnum

Defines if the user qualifies for an introductory offer for an iOS subscription.

Field name	Description
eligible	The user is eligible for an intro offer, it is safe to reflect this info in your UI
ineligible	he user is not eligible to get any offer, you shouldn't present it in your UI
notApplicable	This product is not configured to have an offer