Superwall Android SDK/com.superwall.sdk.models.customer/SubscriptionTransaction

SubscriptionTransaction

@Serializable

data class SubscriptionTransaction(val transactionId: String, val productId: String, val purchaseDate: Date, val willRenew: Boolean, val isRevoked: Boolean, val isInGracePeriod: Boolean, val isInBillingRetryPeriod: Boolean, val isActive: Boolean, val expirationDate: Date?, val store: Store = Store.PLAY_STORE, val offerType: LatestPeriodType? = null, val subscriptionGroupId: String? = null)(source)

Represents a subscription transaction in the customer's purchase history.

Constructors

SubscriptionTransaction

constructor(transactionId: String, productId: String, purchaseDate: Date, willRenew: Boolean, isRevoked: Boolean, isInGracePeriod: Boolean, isInBillingRetryPeriod: Boolean, isActive: Boolean, expirationDate: Date?, store: Store = Store.PLAY_STORE, offerType: LatestPeriodType? = null, subscriptionGroupId: String? = null)

Types

object Companion

Properties

@Serializable(with = DateSerializer::class)

@SerialName(value = "expirationDate")

val expirationDate: Date?

The date that the subscription expires.

@SerialName(value = "isActive")

val isActive: Boolean

Indicates whether the subscription is active.

isInBillingRetryPeriod

@SerialName(value = "isInBillingRetryPeriod")

val isInBillingRetryPeriod: Boolean

Indicates whether the subscription is in a billing retry period state.

isInGracePeriod

@SerialName(value = "isInGracePeriod")

val isInGracePeriod: Boolean

Indicates whether the subscription is in a billing grace period state.

@SerialName(value = "isRevoked")

val isRevoked: Boolean

Indicates whether the transaction has been revoked.

@SerialName(value = "offerType")

val offerType: LatestPeriodType?

The type of offer that applied to this transaction.

@SerialName(value = "productId")

val productId: String

The product identifier of the subscription.

@Serializable(with = DateSerializer::class)

@SerialName(value = "purchaseDate")

val purchaseDate: Date

The date that the App Store charged the user's account.

@SerialName(value = "store")

val store: Store

The store from which this transaction originated.

subscriptionGroupId

@SerialName(value = "subscriptionGroupId")

val subscriptionGroupId: String?

@SerialName(value = "transactionId")

val transactionId: String

The unique identifier for the transaction.

@SerialName(value = "willRenew")

val willRenew: Boolean

Indicates whether the subscription will renew.