Superwall Android SDK/com.superwall.sdk.models.entitlements/Entitlement

Entitlement

@Serializable

data class Entitlement(val id: String, val type: Entitlement.Type = Type.SERVICE_LEVEL, val isActive: Boolean = false, val productIds: Set<String> = emptySet(), val latestProductId: String? = null, val startsAt: Date? = null, val renewedAt: Date? = null, val expiresAt: Date? = null, val isLifetime: Boolean? = null, val willRenew: Boolean? = null, val state: LatestSubscriptionState? = null, val offerType: LatestPeriodType? = null, val store: Store? = null)(source)

An entitlement that represents a subscription tier in your app.

Constructors

constructor(id: String, type: Entitlement.Type = Type.SERVICE_LEVEL, isActive: Boolean = false, productIds: Set<String> = emptySet(), latestProductId: String? = null, startsAt: Date? = null, renewedAt: Date? = null, expiresAt: Date? = null, isLifetime: Boolean? = null, willRenew: Boolean? = null, state: LatestSubscriptionState? = null, offerType: LatestPeriodType? = null, store: Store? = null)

constructor(id: String)

Convenience constructor for creating an entitlement with just an ID.

constructor(id: String, type: Entitlement.Type)

Types

object Companion

@Serializable

enum Type : Enum<Entitlement.Type>

Properties

@SerialName(value = "expiresAt")

@Serializable(with = DateSerializer::class)

val expiresAt: Date?

The expiry date of the last transaction that unlocked this entitlement.

@SerialName(value = "identifier")

The identifier for the entitlement.

@SerialName(value = "isActive")

val isActive: Boolean

Indicates whether there is any active, non-revoked, transaction for this entitlement.

isInGracePeriod

val isInGracePeriod: Boolean?

Indicates whether the last subscription transaction associated with this entitlement is in a billing grace period state.

@SerialName(value = "isLifetime")

val isLifetime: Boolean?

Indicates whether the entitlement is active for a lifetime due to the purchase of a non-consumable.

val isRevoked: Boolean?

Indicates whether the last subscription transaction associated with this entitlement was revoked.

latestProductId

@SerialName(value = "latestProductId")

val latestProductId: String?

The product identifier of the latest transaction to unlock this entitlement.

@SerialName(value = "offerType")

val offerType: LatestPeriodType?

The type of offer that applies to the last subscription transaction that unlocks this entitlement.

@SerialName(value = "productIds")

val productIds: Set<String>

All product identifiers that map to the entitlement.

@SerialName(value = "renewedAt")

@Serializable(with = DateSerializer::class)

val renewedAt: Date?

The date that the entitlement was last renewed.

val renewsAt: Date?

The Date at which the subscription renews, if at all.

@SerialName(value = "startsAt")

@Serializable(with = DateSerializer::class)

val startsAt: Date?

The purchase date of the first transaction that unlocked this entitlement.

@SerialName(value = "state")

val state: LatestSubscriptionState?

The state of the last subscription transaction associated with the entitlement.

@SerialName(value = "store")

val store: Store?

The store where the product that unlocked this entitlement was purchased.

@SerialName(value = "type")

val type: Entitlement.Type

The type of entitlement.

@SerialName(value = "willRenew")

val willRenew: Boolean?

Indicates whether the last subscription transaction associated with this entitlement will auto renew.

Functions

fun isDistinct(other: Entitlement): Boolean

Returns true if this entitlement differs from other on any field other than the product identifiers (productIds, latestProductId).