purchases/com.revenuecat.purchases/SubscriptionInfo

SubscriptionInfo

class SubscriptionInfo(val productIdentifier: String, val purchaseDate: Date, val originalPurchaseDate: Date?, val expiresDate: Date?, val store: Store, val unsubscribeDetectedAt: Date?, val isSandbox: Boolean, val billingIssuesDetectedAt: Date?, val gracePeriodExpiresDate: Date?, val ownershipType: OwnershipType = OwnershipType.UNKNOWN, val periodType: PeriodType, val refundedAt: Date?, val storeTransactionId: String?, requestDate: Date)

Subscription purchases of the Customer.

Constructors

SubscriptionInfo

constructor(productIdentifier: String, purchaseDate: Date, originalPurchaseDate: Date?, expiresDate: Date?, store: Store, unsubscribeDetectedAt: Date?, isSandbox: Boolean, billingIssuesDetectedAt: Date?, gracePeriodExpiresDate: Date?, ownershipType: OwnershipType = OwnershipType.UNKNOWN, periodType: PeriodType, refundedAt: Date?, storeTransactionId: String?, requestDate: Date)

Functions

toString

open override fun toString(): String

Properties

billingIssuesDetectedAt

val billingIssuesDetectedAt: Date?

Date when RevenueCat detected any billing issues with this subscription. If and when the billing issue gets resolved, this field is set to nil. Note the subscription may still be active, check the `expiresDate` attribute.

expiresDate

val expiresDate: Date?

Date when the subscription expires/expired

gracePeriodExpiresDate

val gracePeriodExpiresDate: Date?

Date when any grace period for this subscription expires/expired. nil if the customer has never been in a grace period.

isActive

val isActive: Boolean

Whether the subscription is currently active.

isSandbox

val isSandbox: Boolean

Whether or not the purchase was made in sandbox mode.

originalPurchaseDate

val originalPurchaseDate: Date?

Date when this subscription first started. This property does not update with renewals. This property also does not update for product changes within a subscription group or re-subscriptions by lapsed subscribers.

ownershipType

val ownershipType: OwnershipType

How the Customer received access to this subscription:

periodType

val periodType: PeriodType

Type of the current subscription period:

productIdentifier

val productIdentifier: String

The product identifier.

purchaseDate

val purchaseDate: Date

Date when the last subscription period started.

refundedAt

val refundedAt: Date?

Date when RevenueCat detected a refund of this subscription.

store

val store: Store

Store where the subscription was purchased.

storeTransactionId

val storeTransactionId: String?

The transaction id in the store of the subscription.

unsubscribeDetectedAt

val unsubscribeDetectedAt: Date?

Date when RevenueCat detected that auto-renewal was turned off for this subscription. Note the subscription may still be active, check the `expiresDate` attribute.

willRenew

val willRenew: Boolean

Whether the subscription will renew at the next billing period.