Kotlin Multiplatform SDK Models

Models

AdaptyOnboardingScreenParameters

Parameters for logging onboarding screen events.

Name	Type	Description
onboardingName	string (optional)	Name of the onboarding flow
onboardingScreenName	string (optional)	Name of the onboarding screen
onboardingScreenOrder	number	Order of the onboarding screen (minimum: 1)

AdaptyPaywallProduct

An information about a product.

Name	Type	Description
vendorProductId	string	Unique identifier of a product from App Store Connect or Google Play Console
adaptyProductId	string	Unique identifier of the product in Adapty
paywallVariationId	string	Same as variationId property of the parent AdaptyPaywall
paywallABTestName	string	Same as abTestName property of the parent AdaptyPaywall
paywallName	string	Same as name property of the parent AdaptyPaywall
paywallProductIndex	number	The index of the product in the paywall
audienceName	string (optional)	Name of the audience this product belongs to
localizedDescription	string	A description of the product
localizedTitle	string	The name of the product
isFamilyShareable	boolean	Boolean value that indicates whether the product is available for family sharing in App Store Connect. iOS Only.
regionCode	string (optional)	The region code of the locale used to format the price of the product. ISO 3166 ALPHA-2 (US, DE). iOS Only.
price	AdaptyPrice	The cost of the product in the local currency
subscription	AdaptyPaywallProductSubscription (optional)	Detailed information about subscription (intro, offers, etc.)
payloadData	string (optional)	Additional data associated with the product

AdaptyPrice

Name	Type	Description
amount	number	Price as number
currencyCode	string (optional)	The currency code of the locale used to format the price of the product. The ISO 4217 (USD, EUR)
currencySymbol	string (optional)	The currency symbol of the locale used to format the price of the product. ($, €)
localizedString	string (optional)	A price's language is determined by the preferred language set on the device. On Android, the formatted price from Google Play as is

AdaptyPaywallProductSubscription

Name	Type	Description
groupIdentifier	string (optional)	An identifier of the subscription group to which the subscription belongs. iOS Only.
period	AdaptySubscriptionPeriod	The period details for products that are subscriptions
localizedPeriod	string (optional)	The period's language is determined by the preferred language set on the device
offer	AdaptySubscriptionOffer (optional)	A subscription offer if available for the auto-renewable subscription
renewalType	AdaptyRenewalType	The renewal type. Android Only.
basePlanId	string (optional)	The identifier of the base plan. Android Only.

AdaptySubscriptionPeriod

Name	Type	Description
numberOfUnits	number	A number of period units
unit	AdaptyPeriodUnit	A unit of time that a subscription period is specified in. The possible values are: day, week, month, year

AdaptySubscriptionOffer

Name	Type	Description
identifier	string	Unique identifier of a discount offer for a product
phases	array of AdaptySubscriptionPhase	A list of discount phases available for this offer

AdaptySubscriptionPhase

Name	Type	Description
localizedNumberOfPeriods	string (optional)	A formatted number of periods of a discount for a user's locale
localizedSubscriptionPeriod	string (optional)	A formatted subscription period of a discount for a user's locale
numberOfPeriods	number	A number of periods this product discount is available
price	AdaptyPrice	Discount price of a product in a local currency
subscriptionPeriod	AdaptySubscriptionPeriod	An information about period for a product discount
paymentMode	AdaptySubscriptionOfferPaymentMode	A payment mode for this product discount. Possible values: free_trial, pay_as_you_go, pay_up_front

AdaptyPaywall

An information about a paywall.

Name	Type	Description
placementId	string	ID of a placement configured in Adapty Dashboard
instanceIdentity	string	Unique identifier of the paywall configuration
name	string	A paywall name
audienceName	string	A name of an audience to which the paywall belongs
abTestName	string	Parent A/B test name
variationId	string	An identifier of a variation, used to attribute purchases to this paywall
revision	number	Current revision (version) of a paywall. Every change within a paywall creates a new revision
hasViewConfiguration	boolean	If true, it is possible to fetch the view object and use it with AdaptyUI library
remoteConfig	AdaptyPaywallRemoteConfig (optional)	A remote config configured in Adapty Dashboard for this paywall
payloadData	string (optional)	Additional data associated with the paywall

AdaptyPlacement

Name	Type	Description
abTestName	string	Parent A/B test name
audienceName	string	A name of an audience to which the paywall belongs
id	string	ID of a placement configured in Adapty Dashboard
revision	number	Current revision (version) of a paywall. Every change within a paywall creates a new revision
isTrackingPurchases	boolean (optional)	Whether the placement is tracking purchases
audienceVersionId	string	Version ID of the audience

AdaptyPaywallRemoteConfig

Name	Type	Description
lang	string	Identifier of a paywall locale
data	object	A custom dictionary configured in Adapty Dashboard for this paywall
dataString	string	A custom JSON string configured in Adapty Dashboard for this paywall

AdaptyProfile

An information about a user's subscription status and purchase history.

Name	Type	Description
profileId	string	An identifier of the user in Adapty
customerUserId	string (optional)	An identifier of the user in your system
customAttributes	object	Previously set user custom attributes with the updateProfile method. Can contain string and number values.
accessLevels	object<string, AdaptyProfile.AccessLevel>	The keys are access level identifiers configured by you in Adapty Dashboard. The values are AccessLevel objects. Can be null if the customer has no access levels
subscriptions	object<string, AdaptyProfile.Subscription>	The keys are product ids from App Store Connect. The values are Subscription objects. Can be null if the customer has no subscriptions
nonSubscriptions	object<string, array of AdaptyProfile.NonSubscription>	The keys are product ids from App Store Connect. The values are arrays of NonSubscription objects. Can be null if the customer has no purchases

AdaptyProfile.AccessLevel

Information about the user's access level.

Name	Type	Description
id	string	Unique identifier of the access level configured by you in Adapty Dashboard
isActive	boolean	Whether the access level is active. Generally, you have to check just this property to determine if the user has access to premium features
vendorProductId	string	The identifier of the product in the App Store Connect that unlocked this access level
store	string	The store of the purchase that unlocked this access level. The possible values are: app_store, play_store, adapty
activatedAt	string	The time when the access level was activated (ISO 8601 format)
renewedAt	string (optional)	The time when the access level was renewed (ISO 8601 format)
expiresAt	string (optional)	The time when the access level will expire (ISO 8601 format, could be in the past and could be null for lifetime access)
isLifetime	boolean	Whether the access level is active for a lifetime (no expiration date). If set to true you shouldn't check expires_at, or you could just check isActive
activeIntroductoryOfferType	string (optional)	The type of active introductory offer. Possible values are: free_trial, pay_as_you_go, pay_up_front. If the value is not null, it means that the offer was applied during the current subscription period
activePromotionalOfferType	string (optional)	The type of active promotional offer. Possible values are: free_trial, pay_as_you_go, pay_up_front. If the value is not null, it means that the offer was applied during the current subscription period
activePromotionalOfferId	string (optional)	An identifier of active promotional offer
offerId	string (optional)	Offer identifier
willRenew	boolean	Whether the auto-renewable subscription is set to renew
isInGracePeriod	boolean	Whether the auto-renewable subscription is in the grace period
unsubscribedAt	string (optional)	The time when the auto-renewable subscription was cancelled. Subscription can still be active, it just means that auto-renewal turned off. Will be set to null if the user reactivates the subscription (ISO 8601 format)
billingIssueDetectedAt	string (optional)	The time when billing issue was detected. Subscription can still be active. Will be set to null if the charge will be made (ISO 8601 format)
startsAt	string (optional)	The time when this access level has started (ISO 8601 format, could be in the future)
cancellationReason	string (optional)	The reason why the subscription was cancelled. Possible values are: voluntarily_cancelled, billing_error, refund, price_increase, product_was_not_available, unknown
isRefund	boolean	Whether the purchase was refunded

AdaptyProfile.Subscription

Information about the user's subscription.

Name	Type	Description
store	string	The store of the purchase. The possible values are: app_store, play_store, adapty
vendorProductId	string	The identifier of the product in the App Store Connect
vendorTransactionId	string	Transaction id from the App Store
vendorOriginalTransactionId	string	Original transaction id from the App Store. For auto-renewable subscription, this will be the id of the first transaction in the subscription
isActive	boolean	Whether the subscription is active
isLifetime	boolean	Whether the subscription is active for a lifetime (no expiration date). If set to true you shouldn't check expires_at, or you could just check isActive
activatedAt	string	The time when the subscription was activated (ISO 8601 format)
renewedAt	string (optional)	The time when the subscription was renewed (ISO 8601 format)
expiresAt	string (optional)	The time when the subscription will expire (ISO 8601 format, could be in the past and could be null for lifetime access)
startsAt	string (optional)	The time when the subscription has started (ISO 8601 format, could be in the future)
unsubscribedAt	string (optional)	The time when the auto-renewable subscription was cancelled. Subscription can still be active, it just means that auto-renewal turned off. Will be set to null if a user reactivates the subscription (ISO 8601 format)
billingIssueDetectedAt	string (optional)	The time when billing issue was detected (Apple was not able to charge the card). Subscription can still be active. Will be set to null if the charge will be made (ISO 8601 format)
isInGracePeriod	boolean	Whether the auto-renewable subscription is in the grace period
isSandbox	boolean	Whether the product was purchased in the sandbox environment
isRefund	boolean	Whether the purchase was refunded
willRenew	boolean	Whether the auto-renewable subscription is set to renew
activeIntroductoryOfferType	string (optional)	The type of active introductory offer. Possible values are: free_trial, pay_as_you_go, pay_up_front. If the value is not null, it means that the offer was applied during the current subscription period
activePromotionalOfferType	string (optional)	The type of active promotional offer. Possible values are: free_trial, pay_as_you_go, pay_up_front. If the value is not null, it means that the offer was applied during the current subscription period
activePromotionalOfferId	string (optional)	An identifier of active promotional offer
offerId	string (optional)	Offer identifier
cancellationReason	string (optional)	The reason why the subscription was cancelled. Possible values are: voluntarily_cancelled, billing_error, refund, price_increase, product_was_not_available, unknown

AdaptyProfile.NonSubscription

Information about the user's non-subscription purchases.

Name	Type	Description
purchaseId	string	The identifier of the purchase in Adapty. You can use it to ensure that you've already processed this purchase (for example tracking one time products)
store	string	The store of the purchase. The possible values are: app_store, play_store, adapty
vendorProductId	string	The identifier of the product in the App Store Connect
vendorTransactionId	string (optional)	Transaction id from the App Store
purchasedAt	string	The time when the product was purchased (ISO 8601 format)
isSandbox	boolean	Whether the product was purchased in the sandbox environment
isRefund	boolean	Whether the purchase was refunded
isConsumable	boolean	Whether the product should only be processed once. If true, the purchase will be returned by Adapty API one time only

AdaptyAndroidSubscriptionUpdateParameters

Parameters to change one subscription to another.

Name	Type	Description
oldSubVendorProductId	string	The product id for current subscription to change
replacementMode	AdaptyAndroidSubscriptionUpdateReplacementMode	The proration mode for subscription update

Enums

AdaptyPeriodUnit

• day - Day period
• week - Week period
• month - Month period
• year - Year period

AdaptySubscriptionOfferPaymentMode

• free_trial - Free trial
• pay_as_you_go - Pay as you go
• pay_up_front - Pay up front

AdaptyRenewalType

• prepaid - Prepaid subscription
• autorenewable - Auto-renewable subscription

AdaptyProfile.Gender

• f - Female
• m - Male
• o - Other

AdaptyAndroidSubscriptionUpdateReplacementMode

• immediate_with_time_proration - Immediate with time proration
• immediate_and_charge_prorated_price - Immediate and charge prorated price
• immediate_without_proration - Immediate without proration
• deferred - Deferred
• immediate_and_charge_full_price - Immediate and charge full price