Adapty SDK/com.adapty.models/AdaptyProfile/AccessLevel

AccessLevel

class AccessLevel(val id: String, val isActive: Boolean, val vendorProductId: String, val offerId: String?, val store: String, val activatedAt: String, val startsAt: String?, val renewedAt: String?, val expiresAt: String?, val isLifetime: Boolean, val cancellationReason: String?, val isRefund: Boolean, val activeIntroductoryOfferType: String?, val activePromotionalOfferType: String?, val activePromotionalOfferId: String?, val willRenew: Boolean, val isInGracePeriod: Boolean, val unsubscribedAt: String?, val billingIssueDetectedAt: String?)

Constructors

AccessLevel

fun AccessLevel(id: String, isActive: Boolean, vendorProductId: String, offerId: String?, store: String, activatedAt: String, startsAt: String?, renewedAt: String?, expiresAt: String?, isLifetime: Boolean, cancellationReason: String?, isRefund: Boolean, activeIntroductoryOfferType: String?, activePromotionalOfferType: String?, activePromotionalOfferId: String?, willRenew: Boolean, isInGracePeriod: Boolean, unsubscribedAt: String?, billingIssueDetectedAt: String?)

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

activatedAt

val activatedAt: String

ISO 8601 datetime when this access level was activated.

activeIntroductoryOfferType

val activeIntroductoryOfferType: String?

A type of an active introductory offer. If the value is not null, it means that the offer was applied during the current subscription period.

activePromotionalOfferId

val activePromotionalOfferId: String?

An id of active promotional offer.

activePromotionalOfferType

val activePromotionalOfferType: String?

A type of an active promotional offer. If the value is not null, it means that the offer was applied during the current subscription period.

billingIssueDetectedAt

val billingIssueDetectedAt: String?

cancellationReason

val cancellationReason: String?

A reason why a subscription was cancelled.

expiresAt

val expiresAt: String?

ISO 8601 datetime when the access level will expire (could be in the past and could be null for lifetime access).

val id: String

Unique identifier of the access level configured by you in Adapty Dashboard.

isActive

val isActive: Boolean

true if this access level is active. Generally, you can check this property to determine whether a user has an access to premium features.

isInGracePeriod

val isInGracePeriod: Boolean

true if this auto-renewable subscription is in the grace period.

isLifetime

val isLifetime: Boolean

true if this access level is active for a lifetime (no expiration date).

isRefund

val isRefund: Boolean

true if this purchase was refunded.

offerId

val offerId: String?

An identifier of a discount offer in Google Play that unlocked this access level.

renewedAt

val renewedAt: String?

ISO 8601 datetime when the access level was renewed. It can be null if the purchase was first in chain or it is non-renewing subscription / non-consumable (e.g. lifetime).

startsAt

val startsAt: String?

ISO 8601 datetime when this access level has started (could be in the future).

store

val store: String

A store of the purchase that unlocked this access level.

unsubscribedAt

val unsubscribedAt: String?

ISO 8601 datetime 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.

vendorProductId

val vendorProductId: String

An identifier of a product in a store that unlocked this access level. It may contain either product_id only or "product_id:base_plan_id".

willRenew

val willRenew: Boolean

true if this auto-renewable subscription is set to renew.