Android SDK Models

This page has been deprecated. For SDK models, go to this reference.

Interfaces

AdaptyOnboarding

Information about an onboarding.

Name	Type	Description
placement	AdaptyPlacement	A placement, configured in Adapty Dashboard
hasViewConfiguration	boolean	If true, it is possible to fetch the view object and use it with AdaptyUI library
name	string	Name of the onboarding flow
remoteConfig	AdaptyRemoteConfig (optional)	A remote config configured in Adapty Dashboard for this onboarding
variationId	string	An identifier of a variation, used to attribute purchases to this onboarding

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
localizedDescription	string	A description of the product
localizedTitle	string	The name of the product
price	AdaptyPaywallProduct.Price (optional)	The cost of the product in the local currency
subscriptionDetails	AdaptyProductSubscriptionDetails (optional)	Detailed information about subscription (intro, offers, etc.)
productDetails	ProductDetails	Underlying system representation of the product

AdaptyPaywallProduct.Price

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

AdaptyProductSubscriptionDetails

Name	Type	Description
subscriptionPeriod	AdaptyProductSubscriptionPeriod	The period details for products that are subscriptions. Will be null for iOS version below 11.2 and macOS version below 10.14.4.
localizedSubscriptionPeriod	string (optional)	The period’s language is determined by the preferred language set on the device
offer	AdaptyProductDiscountPhase (optional)	A subscription offer if available for the auto-renewable subscription
basePlanId	string	The identifier of the base plan. Android Only.
renewalType	AdaptyProductSubscriptionDetails.RenewalType	The renewal type. Android Only.
offerId	string (optional)	A discount offer for this basePlanId
offerTags	array of strings	Tags defined in Google Play console for current basePlanId and offerId
introductoryOfferEligibility	AdaptyEligibility	User’s eligibility for your introductory offer
introductoryOfferPhases	array of AdaptyProductDiscountPhase	A list that can contain up to two discount phases: the free trial phase and the introductory price phase

AdaptyProductSubscriptionPeriod

Name	Type	Description
numberOfUnits	number	A number of period units
unit	AdaptyPeriodUnit	A unit of time that a subscription period is specified in

AdaptyProductDiscountPhase

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	AdaptyPaywallProduct.Price	Discount price of a product in a local currency
subscriptionPeriod	AdaptyProductSubscriptionPeriod	An information about period for a product discount
paymentMode	AdaptyProductDiscountPhase.PaymentMode	A payment mode for this product discount

AdaptyPaywall

An information about a paywall.

Name	Type	Description
placement	AdaptyPlacement	A placement, configured in Adapty Dashboard
hasViewConfiguration	boolean	If true, it is possible to fetch the view object and use it with AdaptyUI library
name	string	A paywall name
remoteConfig	AdaptyRemoteConfig (optional)	A remote config configured in Adapty Dashboard for this paywall
variationId	string	An identifier of a variation, used to attribute purchases to this paywall
vendorProductIds	array of strings	Array of related products ids

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

AdaptyRemoteConfig

Name	Type	Description
locale	string	Identifier of a paywall locale
dataMap	object	A custom dictionary configured in Adapty Dashboard for this paywall (same as jsonString)
jsonString	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
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: play_store, adapty
activatedAt	string (ISO 8601 datetime)	The time when the access level was activated
renewedAt	string (ISO 8601 datetime) (optional)	The time when the access level was renewed
expiresAt	string (ISO 8601 datetime) (optional)	The time when the access level will expire (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)	An identifier of a discount offer in Google Play that unlocked this access level
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 (ISO 8601 datetime) (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
billingIssueDetectedAt	string (ISO 8601 datetime) (optional)	The time when billing issue was detected. Subscription can still be active. Will be set to null if the charge will be made
startsAt	string (ISO 8601 datetime) (optional)	The time when this access level has started (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: 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 (ISO 8601 datetime)	The time when the subscription was activated
renewedAt	string (ISO 8601 datetime) (optional)	The time when the subscription was renewed
expiresAt	string (ISO 8601 datetime) (optional)	The time when the subscription will expire (could be in the past and could be null for lifetime access)
startsAt	string (ISO 8601 datetime) (optional)	The time when the subscription has started (could be in the future)
unsubscribedAt	string (ISO 8601 datetime) (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
billingIssueDetectedAt	string (ISO 8601 datetime) (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
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)	An identifier of a discount offer in Google Play that unlocked this subscription
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: 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 (ISO 8601 datetime)	The time when the product was purchased
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

AdaptyPlacementFetchPolicy

Sealed class for placement fetch policies.

Name	Type	Description
ReloadRevalidatingCacheData	class	Always reload data from server
ReturnCacheDataElseLoad	class	Return cached data if available, otherwise load from server
ReturnCacheDataIfNotExpiredElseLoad	class	Return cached data if not expired, otherwise load from server

AdaptyEligibility

Enum representing eligibility status.

Value	Description
`ELIGIBLE`	User is eligible for the offer
`INELIGIBLE`	User is not eligible for the offer
`NOT_APPLICABLE`	Offer is not applicable

AdaptyPeriodUnit

Enum representing the unit of time for subscription periods.

Value	Description
`DAY`	Daily period unit
`WEEK`	Weekly period unit
`MONTH`	Monthly period unit
`YEAR`	Yearly period unit
`UNKNOWN`	Unknown period unit

Enums

OfferType

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

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

AdaptyProductDiscountPhase.PaymentMode

PAY_AS_YOU_GO - Pay as you go (recurring payments)
PAY_UPFRONT - Pay up front (one-time payment for multiple periods)
FREE_TRIAL - Free trial (no payment required)
UNKNOWN - Unknown payment mode

AdaptyProductSubscriptionDetails.RenewalType

AUTORENEWABLE - Auto-renewable subscription
PREPAID - Prepaid subscription