adapty/com.adapty.kmp.models/AdaptyProfile/AccessLevel

AccessLevel

data class AccessLevel(val id: String, val isActive: Boolean, val vendorProductId: String, val offerId: String? = null, 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?)

Represents a premium access level assigned to a user.

Constructors

AccessLevel

constructor(id: String, isActive: Boolean, vendorProductId: String, offerId: String? = null, 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?)

Properties

activatedAt

val activatedAt: String

Activation timestamp in ISO 8601 format.

activeIntroductoryOfferType

val activeIntroductoryOfferType: String?

Type of active introductory offer, if any. If the value is not null, it means that the offer was applied during the current subscription period. Possible values: free_trial, pay_as_you_go, pay_up_front

activePromotionalOfferId

val activePromotionalOfferId: String?

ID of active promotional offer, if any.

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. Possible values: free_trial, pay_as_you_go, pay_up_front

billingIssueDetectedAt

val billingIssueDetectedAt: String?

When a billing issue was detected, if any. Subscription can still be active. Would be set to null if a charge is made.

cancellationReason

val cancellationReason: String?

Reason for cancellation, if any.

expiresAt

val expiresAt: String?

Time when the access level will expire (could be in the past and could be null for lifetime access)

val id: String

Identifier of the access level.

isActive

val isActive: Boolean

Whether this access level is currently active.

isInGracePeriod

val isInGracePeriod: Boolean

Whether the subscription is currently in grace period.

isLifetime

val isLifetime: Boolean

Whether this is a lifetime access (no expiration date).

isRefund

val isRefund: Boolean

Whether this access level was refunded.

offerId

val offerId: String? = null

Promotional or introductory offer ID, if applicable.

renewedAt

val renewedAt: String?

Time 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?

Subscription start date. Nullable.

store

val store: String

Store name (App Store, Google Play, etc.). Possible values: app_store, play_store, adapty

unsubscribedAt

val unsubscribedAt: String?

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.

vendorProductId

val vendorProductId: String

Product identifier from App Store or Google Play.

willRenew

val willRenew: Boolean

Whether the subscription will automatically renew.