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

Subscription

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

Constructors

Subscription

fun Subscription(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?)

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 the subscription 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?

ISO 8601 datetime when a billing issue was detected. Subscription can still be active.

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

isActive

val isActive: Boolean

true if the subscription is active.

isInGracePeriod

val isInGracePeriod: Boolean

Whether the auto-renewable subscription is in a grace period.

isLifetime

val isLifetime: Boolean

true if the subscription is active for a lifetime (no expiration date).

isRefund

val isRefund: Boolean

true if the purchase was refunded.

isSandbox

val isSandbox: Boolean

true if the product was purchased in a sandbox environment.

offerId

val offerId: String?

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

renewedAt

val renewedAt: String?

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

ISO 8601 datetime when the subscription has started (could be in the future).

store

val store: String

A store of the purchase.

unsubscribedAt

val unsubscribedAt: String?

ISO 8601 datetime 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. It may contain either product_id only or "product_id:base_plan_id".

vendorTransactionId

val vendorTransactionId: String?

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

willRenew

val willRenew: Boolean

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