adapty/com.adapty.kmp.models/AdaptyProfile/Subscription

Subscription

data class Subscription(val isActive: Boolean, val vendorProductId: String, val vendorTransactionId: String?, val vendorOriginalTransactionId: String?, val offerId: String?, val store: String, val activatedAt: String, val renewedAt: String?, val expiresAt: String?, val startsAt: String?, val isLifetime: Boolean, val activeIntroductoryOfferType: String?, val activePromotionalOfferType: String?, val activePromotionalOfferId: String?, val willRenew: Boolean, val isInGracePeriod: Boolean, val unsubscribedAt: String?, val billingIssueDetectedAt: String?, val isSandbox: Boolean, val isRefund: Boolean, val cancellationReason: String?)

Represents a subscription purchase of the user.

Constructors

Subscription

constructor(isActive: Boolean, vendorProductId: String, vendorTransactionId: String?, vendorOriginalTransactionId: String?, offerId: String?, store: String, activatedAt: String, renewedAt: String?, expiresAt: String?, startsAt: String?, isLifetime: Boolean, activeIntroductoryOfferType: String?, activePromotionalOfferType: String?, activePromotionalOfferId: String?, willRenew: Boolean, isInGracePeriod: Boolean, unsubscribedAt: String?, billingIssueDetectedAt: String?, isSandbox: Boolean, isRefund: Boolean, cancellationReason: String?)

Properties

activatedAt

val activatedAt: String

Activation date 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?

Active promotional offer ID, 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?

Time when a billing issue was detected. Subscription can still be active.

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).

isActive

val isActive: Boolean

Whether the subscription is active.

isInGracePeriod

val isInGracePeriod: Boolean

Whether the subscription is currently in grace period.

isLifetime

val isLifetime: Boolean

Whether this is a lifetime subscription.

isRefund

val isRefund: Boolean

Whether this subscription was refunded.

isSandbox

val isSandbox: Boolean

Whether this subscription was made in a sandbox environment.

offerId

val offerId: String?

Promotional or introductory offer ID, if any.

renewedAt

val renewedAt: String?

Time when the subscription was renewed. It can be null if the purchase was first in chain or it is non-renewing subscription.

startsAt

val startsAt: String?

Time when the subscription has started (could be in the future).

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 means that auto-renewal is turned off. Would be null if a user reactivates the subscription.

vendorOriginalTransactionId

val vendorOriginalTransactionId: String?

An original transaction id of the purchase in a store that unlocked this subscription. For auto-renewable subscription, this will be an id of the first transaction in this subscription

vendorProductId

val vendorProductId: String

An identifier of a product in a store that unlocked this subscription.

vendorTransactionId

val vendorTransactionId: String?

A transaction id of a purchase in a store that unlocked this subscription.

willRenew

val willRenew: Boolean

Whether the subscription will automatically renew.