Interface SubscriptionInfo

Subscription purchases of the Customer.

interface SubscriptionInfo {
    billingIssuesDetectedAt: null | Date;
    expiresDate: null | Date;
    gracePeriodExpiresDate: null | Date;
    isActive: boolean;
    isSandbox: boolean;
    originalPurchaseDate: null | Date;
    ownershipType: OwnershipType;
    periodType: PeriodType;
    productIdentifier: string;
    purchaseDate: Date;
    refundedAt: null | Date;
    store: Store;
    storeTransactionId: null | string;
    unsubscribeDetectedAt: null | Date;
    willRenew: boolean;
}

Properties

billingIssuesDetectedAt expiresDate gracePeriodExpiresDate isActive isSandbox originalPurchaseDate ownershipType periodType productIdentifier purchaseDate refundedAt store storeTransactionId unsubscribeDetectedAt willRenew

Properties

ReadonlybillingIssuesDetectedAt

billingIssuesDetectedAt: null | Date

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

ReadonlyexpiresDate

expiresDate: null | Date

Date when the subscription expires/expired

ReadonlygracePeriodExpiresDate

gracePeriodExpiresDate: null | Date

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

ReadonlyisActive

isActive: boolean

Whether the subscription is currently active (at the time this object was obtained).

ReadonlyisSandbox

isSandbox: boolean

Whether or not the purchase was made in sandbox mode.

ReadonlyoriginalPurchaseDate

originalPurchaseDate: null | 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.

ReadonlyownershipType

ownershipType: OwnershipType

How the Customer received access to this subscription:

  • "PURCHASED": The customer bought the subscription.
  • "FAMILY_SHARED": The customer has access to the product via their family.

ReadonlyperiodType

periodType: PeriodType

Type of the current subscription period:

  • "normal": The product is in a normal period (default)
  • "trial": The product is in a free trial period
  • "intro": The product is in an introductory pricing period
  • "prepaid": The product is in a prepaid pricing period

ReadonlyproductIdentifier

productIdentifier: string

The product identifier.

ReadonlypurchaseDate

purchaseDate: Date

Date when the last subscription period started.

ReadonlyrefundedAt

refundedAt: null | Date

Date when RevenueCat detected a refund of this subscription.

Readonlystore

store: Store

Store where the subscription was purchased.

ReadonlystoreTransactionId

storeTransactionId: null | string

The transaction id in the store of the subscription.

ReadonlyunsubscribeDetectedAt

unsubscribeDetectedAt: null | Date

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

ReadonlywillRenew

willRenew: boolean

Whether the subscription will renew at the next billing period.

Settings

Member Visibility

On This Page

Properties