@revenuecat/purchases-js 1.16.0 → 1.17.0

package/dist/Purchases.es.d.ts

@@ -260,6 +260,22 @@ export declare interface HttpConfig {
     proxyURL?: string;
 }
 
+/**
+ * Represents the result of an identify user operation.
+ * @public
+ */
+export declare interface IdentifyResult {
+    /**
+     * The customer information after the logIn attempt.
+     */
+    readonly customerInfo: CustomerInfo;
+    /**
+     * true if a new user has been registered in the backend,
+     * false if the user had already been registered.
+     */
+    readonly wasCreated: boolean;
+}
+
 /**
  * Custom log handler function type. Allows you to handle SDK log messages
  * with your own logging system.
@@ -984,544 +1000,557 @@ export declare class Purchases {
              */
             changeUser(newAppUserId: string): Promise<CustomerInfo>;
             /**
-             * @returns Whether the SDK is using a sandbox API Key.
-             */
-            isSandbox(): boolean;
-            /**
-             * @returns Whether the current user is anonymous.
-             */
-            isAnonymous(): boolean;
+             * Identifies the current user ID with the provided appUserId, as long as the
+             * previous user ID is an anonymous user ID. This will create an alias
+             * between the two user ids in RevenueCat and replace the current user ID used.
+             * If the old user ID is not anonymous, this method will change the current
+             * user ID to the given appUserId without creating an alias.
+             * @returns The customer info for the new user ID.
+             * @throws {@link PurchasesError} if there is an error while performing the aliasing or fetching the customer info.
+                 * @param appUserId - The new user ID to identify the current user as.
+                 * @experimental
+                 */
+             identifyUser(appUserId: string): Promise<IdentifyResult>;
+             private replaceUserId;
+             /**
+              * @returns Whether the SDK is using a sandbox API Key.
+              */
+             isSandbox(): boolean;
+             /**
+              * @returns Whether the current user is anonymous.
+              */
+             isAnonymous(): boolean;
+             /**
+              * Fetches the virtual currencies for the current subscriber.
+              *
+              * @returns {Promise<VirtualCurrencies>} A VirtualCurrencies object containing the subscriber's virtual currencies.
+              */
+             getVirtualCurrencies(): Promise<VirtualCurrencies>;
+             /**
+              * The currently cached {@link VirtualCurrencies} if one is available.
+              * This value will remain null until virtual currencies have been fetched at
+              * least once with {@link Purchases.getVirtualCurrencies} or an equivalent function.
+              *
+              * @returns {VirtualCurrencies | null} A {@link VirtualCurrencies} object containing the subscriber's virtual currencies,
+              * or null if no cached data is available.
+              */
+             getCachedVirtualCurrencies(): VirtualCurrencies | null;
+             /**
+              * Invalidates the cache for virtual currencies.
+              *
+              * This is useful for cases where a virtual currency's balance might have been updated
+              * in a different part of your system, like if you decreased a user's balance from the user spending a virtual currency,
+              * or if you increased the balance from your backend using the server APIs.
+              */
+             invalidateVirtualCurrenciesCache(): void;
+             /**
+              * Closes the Purchases instance. You should never have to do this normally.
+              */
+             close(): void;
+             /**
+              * Generates an anonymous app user ID that follows RevenueCat's format.
+              * This can be used when you don't have a user identifier system in place.
+              * The generated ID will be in the format: $RCAnonymousID:\<UUID without dashes\>
+              * Example: $RCAnonymousID:123e4567e89b12d3a456426614174000
+              * @returns A new anonymous app user ID string
+              * @public
+              */
+             static generateRevenueCatAnonymousAppUserId(): string;
+            }
+
             /**
-             * Fetches the virtual currencies for the current subscriber.
+             * Configuration object for initializing the Purchases SDK.
              *
-             * @returns {Promise<VirtualCurrencies>} A VirtualCurrencies object containing the subscriber's virtual currencies.
-             */
-            getVirtualCurrencies(): Promise<VirtualCurrencies>;
-            /**
-             * The currently cached {@link VirtualCurrencies} if one is available.
-             * This value will remain null until virtual currencies have been fetched at
-             * least once with {@link Purchases.getVirtualCurrencies} or an equivalent function.
+             * @example
+             * ```typescript
+             * // Object-based configuration (recommended)
+             * const purchases = Purchases.configure({
+             *   apiKey: "your_api_key",
+             *   appUserId: "user_123",
+             *   httpConfig: { additionalHeaders: { "Custom-Header": "value" } },
+             *   flags: { autoCollectUTMAsMetadata: true }
+             * });
              *
-             * @returns {VirtualCurrencies | null} A {@link VirtualCurrencies} object containing the subscriber's virtual currencies,
-             * or null if no cached data is available.
-             */
-            getCachedVirtualCurrencies(): VirtualCurrencies | null;
-            /**
-             * Invalidates the cache for virtual currencies.
+             * // Legacy separate arguments (deprecated)
+             * const purchases = Purchases.configure(
+             *   "your_api_key",
+             *   "user_123",
+             *   { additionalHeaders: { "Custom-Header": "value" } },
+             *   { autoCollectUTMAsMetadata: true }
+             * );
+             * ```
              *
-             * This is useful for cases where a virtual currency's balance might have been updated
-             * in a different part of your system, like if you decreased a user's balance from the user spending a virtual currency,
-             * or if you increased the balance from your backend using the server APIs.
+             * @public
              */
-            invalidateVirtualCurrenciesCache(): void;
+            export declare interface PurchasesConfig {
+                /**
+                 * RevenueCat API Key. Can be obtained from the RevenueCat dashboard.
+                 */
+                apiKey: string;
+                /**
+                 * Your unique id for identifying the user.
+                 */
+                appUserId: string;
+                /**
+                 * Advanced http configuration to customise the SDK usage {@link HttpConfig}.
+                 */
+                httpConfig?: HttpConfig;
+                /**
+                 * Advanced functionality configuration {@link FlagsConfig}.
+                 */
+                flags?: FlagsConfig;
+            }
+
             /**
-             * Closes the Purchases instance. You should never have to do this normally.
+             * Error class for Purchases SDK. You should handle these errors and react
+             * accordingly in your app.
+             * @public
              */
-            close(): void;
+            export declare class PurchasesError extends Error {
+                /**
+                 * Error code for the error. This is useful to appropriately react to
+                 * different error situations.
+                 */
+                readonly errorCode: ErrorCode;
+                /**
+                 * Underlying error message. This provides more details on the error and
+                 * can be useful for debugging and logging.
+                 */
+                readonly underlyingErrorMessage?: string | null | undefined;
+                /**
+                 * Contains extra information that is available in certain types of errors.
+                 */
+                readonly extra?: PurchasesErrorExtra | undefined;
+                constructor(
+                /**
+                 * Error code for the error. This is useful to appropriately react to
+                 * different error situations.
+                 */
+                errorCode: ErrorCode, 
+                /**
+                 * Message for the error. This is useful for debugging and logging.
+                 */
+                message?: string, 
+                /**
+                 * Underlying error message. This provides more details on the error and
+                 * can be useful for debugging and logging.
+                 */
+                underlyingErrorMessage?: string | null | undefined, 
+                /**
+                 * Contains extra information that is available in certain types of errors.
+                 */
+                extra?: PurchasesErrorExtra | undefined);
+                toString: () => string;
+            }
+
             /**
-             * Generates an anonymous app user ID that follows RevenueCat's format.
-             * This can be used when you don't have a user identifier system in place.
-             * The generated ID will be in the format: $RCAnonymousID:\<UUID without dashes\>
-             * Example: $RCAnonymousID:123e4567e89b12d3a456426614174000
-             * @returns A new anonymous app user ID string
+             * Extra information that is available in certain types of errors.
              * @public
              */
-            static generateRevenueCatAnonymousAppUserId(): string;
-           }
-
-           /**
-            * Configuration object for initializing the Purchases SDK.
-            *
-            * @example
-            * ```typescript
-            * // Object-based configuration (recommended)
-            * const purchases = Purchases.configure({
-            *   apiKey: "your_api_key",
-            *   appUserId: "user_123",
-            *   httpConfig: { additionalHeaders: { "Custom-Header": "value" } },
-            *   flags: { autoCollectUTMAsMetadata: true }
-            * });
-            *
-            * // Legacy separate arguments (deprecated)
-            * const purchases = Purchases.configure(
-            *   "your_api_key",
-            *   "user_123",
-            *   { additionalHeaders: { "Custom-Header": "value" } },
-            *   { autoCollectUTMAsMetadata: true }
-            * );
-            * ```
-            *
-            * @public
-            */
-           export declare interface PurchasesConfig {
-               /**
-                * RevenueCat API Key. Can be obtained from the RevenueCat dashboard.
-                */
-               apiKey: string;
-               /**
-                * Your unique id for identifying the user.
-                */
-               appUserId: string;
-               /**
-                * Advanced http configuration to customise the SDK usage {@link HttpConfig}.
-                */
-               httpConfig?: HttpConfig;
-               /**
-                * Advanced functionality configuration {@link FlagsConfig}.
-                */
-               flags?: FlagsConfig;
-           }
-
-           /**
-            * Error class for Purchases SDK. You should handle these errors and react
-            * accordingly in your app.
-            * @public
-            */
-           export declare class PurchasesError extends Error {
-               /**
-                * Error code for the error. This is useful to appropriately react to
-                * different error situations.
-                */
-               readonly errorCode: ErrorCode;
-               /**
-                * Underlying error message. This provides more details on the error and
-                * can be useful for debugging and logging.
-                */
-               readonly underlyingErrorMessage?: string | null | undefined;
-               /**
-                * Contains extra information that is available in certain types of errors.
-                */
-               readonly extra?: PurchasesErrorExtra | undefined;
-               constructor(
-               /**
-                * Error code for the error. This is useful to appropriately react to
-                * different error situations.
-                */
-               errorCode: ErrorCode, 
-               /**
-                * Message for the error. This is useful for debugging and logging.
-                */
-               message?: string, 
-               /**
-                * Underlying error message. This provides more details on the error and
-                * can be useful for debugging and logging.
-                */
-               underlyingErrorMessage?: string | null | undefined, 
-               /**
-                * Contains extra information that is available in certain types of errors.
-                */
-               extra?: PurchasesErrorExtra | undefined);
-               toString: () => string;
-           }
-
-           /**
-            * Extra information that is available in certain types of errors.
-            * @public
-            */
-           export declare interface PurchasesErrorExtra {
-               /**
-                * If this is a request error, the HTTP status code of the response.
-                */
-               readonly statusCode?: number;
-               /**
-                * If this is a RevenueCat backend error, the error code from the servers.
-                */
-               readonly backendErrorCode?: number;
-           }
+            export declare interface PurchasesErrorExtra {
+                /**
+                 * If this is a request error, the HTTP status code of the response.
+                 */
+                readonly statusCode?: number;
+                /**
+                 * If this is a RevenueCat backend error, the error code from the servers.
+                 */
+                readonly backendErrorCode?: number;
+            }
 
-           /**
-            * This object gives you access to the purchase redemption data when
-            * the purchase can be redeemed to a mobile user, like in the case of anonymous users.
-            * @public
-            */
-           export declare interface RedemptionInfo {
-               /**
-                * The redeem url.
-                */
-               readonly redeemUrl: string | null;
-           }
+            /**
+             * This object gives you access to the purchase redemption data when
+             * the purchase can be redeemed to a mobile user, like in the case of anonymous users.
+             * @public
+             */
+            export declare interface RedemptionInfo {
+                /**
+                 * The redeem url.
+                 */
+                readonly redeemUrl: string | null;
+            }
 
-           /**
-            * Enumeration of reserved customer attributes.
-            * @public
-            */
-           export declare enum ReservedCustomerAttribute {
-               /**
-                * The display name that should be used to reference the customer.
-                */
-               DisplayName = "$displayName",
-               /**
-                * The email address of the customer.
-                */
-               Email = "$email",
-               /**
-                * The phone number of the customer.
-                */
-               PhoneNumber = "$phoneNumber",
-               /**
-                * iOS advertising identifier UUID for the customer.
-                */
-               IDFA = "$idfa",
-               /**
-                * iOS vendor identifier UUID for the customer.
-                */
-               IDFV = "$idfv",
-               /**
-                * The advertising ID that is provided by Google Play services for the customer.
-                */
-               GPSAdId = "$gpsAdId",
-               /**
-                * The Android ID of the customer.
-                */
-               AndroidId = "$androidId",
-               /**
-                * The Amazon Advertising ID of the customer.
-                */
-               AmazonAdId = "$amazonAdId",
-               /**
-                * The IP address of the customer.
-                */
-               IP = "$ip",
-               /**
-                * The unique Adjust identifier for the customer.
-                */
-               AdjustId = "$adjustId",
-               /**
-                * The Amplitude device ID of the customer.
-                */
-               AmplitudeDeviceId = "$amplitudeDeviceId",
-               /**
-                * The Amplitude user ID of the customer.
-                */
-               AmplitudeUserId = "$amplitudeUserId",
-               /**
-                * Appsflyer Id. The unique Appsflyer identifier for the customer.
-                */
-               AppsflyerId = "$appsflyerId",
-               /**
-                * The AppsFlyer sharing filter of the customer.
-                */
-               AppsflyerSharingFilter = "$appsflyerSharingFilter",
-               /**
-                * The Branch ID of the customer.
-                */
-               BranchId = "$branchId",
-               /**
-                * The Braze 'alias_name' in User Alias Object.
-                */
-               BrazeAliasName = "$brazeAliasName",
-               /**
-                * The Braze 'alias_label' in User Alias Object.
-                */
-               BrazeAliasLabel = "$brazeAliasLabel",
-               /**
-                * The CleverTap ID of the customer.
-                */
-               ClevertapId = "$clevertapId",
-               /**
-                * The Facebook anonymous ID of the customer.
-                */
-               FbAnonId = "$fbAnonId",
-               /**
-                * The unique mParticle user identifier (mpid).
-                */
-               MparticleId = "$mparticleId",
-               /**
-                * The OneSignal Player Id for the customer.
-                */
-               OnesignalId = "$onesignalId",
-               /**
-                * The OneSignal user ID of the customer.
-                */
-               OnesignalUserId = "$onesignalUserId",
-               /**
-                * The Intercom contact ID of the customer.
-                */
-               IntercomContactId = "$intercomContactId",
-               /**
-                * The media source of the customer.
-                */
-               MediaSource = "$mediaSource",
-               /**
-                * The campaign of the customer.
-                */
-               Campaign = "$campaign",
-               /**
-                * The ad group of the customer.
-                */
-               AdGroup = "$adGroup",
-               /**
-                * The Ad ID of the customer.
-                */
-               AdId = "$ad",
-               /**
-                * The keyword of the customer.
-                */
-               Keyword = "$keyword",
-               /**
-                * The creative of the customer.
-                */
-               Creative = "$creative",
-               /**
-                * Apple push notification tokens for the customer.
-                */
-               APNSTokens = "$apnsTokens",
-               /**
-                * Google push notification tokens for the customer.
-                */
-               FCMTokens = "$fcmTokens",
-               /**
-                * The Airship channel ID of the customer.
-                */
-               AirshipChannelId = "$airshipChannelId",
-               /**
-                * The segment ID of the customer.
-                */
-               SegmentId = "$segmentId",
-               /**
-                * The Iterable user ID of the customer.
-                */
-               IterableUserId = "$iterableUserId",
-               /**
-                * The Iterable campaign ID of the customer.
-                */
-               IterableCampaignId = "$iterableCampaignId",
-               /**
-                * The Iterable template ID of the customer.
-                */
-               IterableTemplateId = "$iterableTemplateId",
-               /**
-                * The Firebase app instance ID of the customer.
-                */
-               FirebaseAppInstanceId = "$firebaseAppInstanceId",
-               /**
-                * The Mixpanel distinct ID of the customer.
-                */
-               MixpanelDistinctId = "$mixpanelDistinctId",
-               /**
-                * Apple App Tracking Transparency consent status for the customer.
-                */
-               ATTConsentStatus = "$attConsentStatus",
-               /**
-                * The unique Kochava device identifier of the customer.
-                */
-               KochavaDeviceId = "$kochavaDeviceId",
-               /**
-                * The device version of the customer.
-                */
-               DeviceVersion = "$deviceVersion",
-               /**
-                * The PostHog user ID of the customer.
-                */
-               PosthogUserId = "$posthogUserId",
-               /**
-                * The Telemetry Deck user ID of the customer.
-                */
-               TelemetryDeckUserId = "$telemetryDeckUserId",
-               /**
-                * The Telemetry Deck app ID of the customer.
-                */
-               TelemetryDeckAppId = "$telemetryDeckAppId",
-               /**
-                * The Apple refund handling preference of the customer.
-                */
-               AppleRefundHandlingPreference = "$appleRefundHandlingPreference",
-               /**
-                * The customer.io ID of the customer.
-                */
-               CustomerioId = "$customerioId",
-               /**
-                * The Tenjin ID of the customer.
-                */
-               TenjinId = "$tenjinId"
-           }
+            /**
+             * Enumeration of reserved customer attributes.
+             * @public
+             */
+            export declare enum ReservedCustomerAttribute {
+                /**
+                 * The display name that should be used to reference the customer.
+                 */
+                DisplayName = "$displayName",
+                /**
+                 * The email address of the customer.
+                 */
+                Email = "$email",
+                /**
+                 * The phone number of the customer.
+                 */
+                PhoneNumber = "$phoneNumber",
+                /**
+                 * iOS advertising identifier UUID for the customer.
+                 */
+                IDFA = "$idfa",
+                /**
+                 * iOS vendor identifier UUID for the customer.
+                 */
+                IDFV = "$idfv",
+                /**
+                 * The advertising ID that is provided by Google Play services for the customer.
+                 */
+                GPSAdId = "$gpsAdId",
+                /**
+                 * The Android ID of the customer.
+                 */
+                AndroidId = "$androidId",
+                /**
+                 * The Amazon Advertising ID of the customer.
+                 */
+                AmazonAdId = "$amazonAdId",
+                /**
+                 * The IP address of the customer.
+                 */
+                IP = "$ip",
+                /**
+                 * The unique Adjust identifier for the customer.
+                 */
+                AdjustId = "$adjustId",
+                /**
+                 * The Amplitude device ID of the customer.
+                 */
+                AmplitudeDeviceId = "$amplitudeDeviceId",
+                /**
+                 * The Amplitude user ID of the customer.
+                 */
+                AmplitudeUserId = "$amplitudeUserId",
+                /**
+                 * Appsflyer Id. The unique Appsflyer identifier for the customer.
+                 */
+                AppsflyerId = "$appsflyerId",
+                /**
+                 * The AppsFlyer sharing filter of the customer.
+                 */
+                AppsflyerSharingFilter = "$appsflyerSharingFilter",
+                /**
+                 * The Branch ID of the customer.
+                 */
+                BranchId = "$branchId",
+                /**
+                 * The Braze 'alias_name' in User Alias Object.
+                 */
+                BrazeAliasName = "$brazeAliasName",
+                /**
+                 * The Braze 'alias_label' in User Alias Object.
+                 */
+                BrazeAliasLabel = "$brazeAliasLabel",
+                /**
+                 * The CleverTap ID of the customer.
+                 */
+                ClevertapId = "$clevertapId",
+                /**
+                 * The Facebook anonymous ID of the customer.
+                 */
+                FbAnonId = "$fbAnonId",
+                /**
+                 * The unique mParticle user identifier (mpid).
+                 */
+                MparticleId = "$mparticleId",
+                /**
+                 * The OneSignal Player Id for the customer.
+                 */
+                OnesignalId = "$onesignalId",
+                /**
+                 * The OneSignal user ID of the customer.
+                 */
+                OnesignalUserId = "$onesignalUserId",
+                /**
+                 * The Intercom contact ID of the customer.
+                 */
+                IntercomContactId = "$intercomContactId",
+                /**
+                 * The media source of the customer.
+                 */
+                MediaSource = "$mediaSource",
+                /**
+                 * The campaign of the customer.
+                 */
+                Campaign = "$campaign",
+                /**
+                 * The ad group of the customer.
+                 */
+                AdGroup = "$adGroup",
+                /**
+                 * The Ad ID of the customer.
+                 */
+                AdId = "$ad",
+                /**
+                 * The keyword of the customer.
+                 */
+                Keyword = "$keyword",
+                /**
+                 * The creative of the customer.
+                 */
+                Creative = "$creative",
+                /**
+                 * Apple push notification tokens for the customer.
+                 */
+                APNSTokens = "$apnsTokens",
+                /**
+                 * Google push notification tokens for the customer.
+                 */
+                FCMTokens = "$fcmTokens",
+                /**
+                 * The Airship channel ID of the customer.
+                 */
+                AirshipChannelId = "$airshipChannelId",
+                /**
+                 * The segment ID of the customer.
+                 */
+                SegmentId = "$segmentId",
+                /**
+                 * The Iterable user ID of the customer.
+                 */
+                IterableUserId = "$iterableUserId",
+                /**
+                 * The Iterable campaign ID of the customer.
+                 */
+                IterableCampaignId = "$iterableCampaignId",
+                /**
+                 * The Iterable template ID of the customer.
+                 */
+                IterableTemplateId = "$iterableTemplateId",
+                /**
+                 * The Firebase app instance ID of the customer.
+                 */
+                FirebaseAppInstanceId = "$firebaseAppInstanceId",
+                /**
+                 * The Mixpanel distinct ID of the customer.
+                 */
+                MixpanelDistinctId = "$mixpanelDistinctId",
+                /**
+                 * Apple App Tracking Transparency consent status for the customer.
+                 */
+                ATTConsentStatus = "$attConsentStatus",
+                /**
+                 * The unique Kochava device identifier of the customer.
+                 */
+                KochavaDeviceId = "$kochavaDeviceId",
+                /**
+                 * The device version of the customer.
+                 */
+                DeviceVersion = "$deviceVersion",
+                /**
+                 * The PostHog user ID of the customer.
+                 */
+                PosthogUserId = "$posthogUserId",
+                /**
+                 * The Telemetry Deck user ID of the customer.
+                 */
+                TelemetryDeckUserId = "$telemetryDeckUserId",
+                /**
+                 * The Telemetry Deck app ID of the customer.
+                 */
+                TelemetryDeckAppId = "$telemetryDeckAppId",
+                /**
+                 * The Apple refund handling preference of the customer.
+                 */
+                AppleRefundHandlingPreference = "$appleRefundHandlingPreference",
+                /**
+                 * The customer.io ID of the customer.
+                 */
+                CustomerioId = "$customerioId",
+                /**
+                 * The Tenjin ID of the customer.
+                 */
+                TenjinId = "$tenjinId"
+            }
 
-           /**
-            * The store where the user originally subscribed.
-            * @public
-            */
-           export declare type Store = "app_store" | "mac_app_store" | "play_store" | "amazon" | "stripe" | "rc_billing" | "promotional" | "paddle" | "test_store" | "unknown";
+            /**
+             * The store where the user originally subscribed.
+             * @public
+             */
+            export declare type Store = "app_store" | "mac_app_store" | "play_store" | "amazon" | "stripe" | "rc_billing" | "promotional" | "paddle" | "test_store" | "unknown";
 
-           /**
-            * Represents a transaction made in the store.
-            * @public
-            */
-           export declare interface StoreTransaction {
-               /**
-                * The unique identifier for the store transaction.
-                */
-               readonly storeTransactionId: string;
-               /**
-                * The identifier of the product purchased in the transaction.
-                */
-               readonly productIdentifier: string;
-               /**
-                * The date when the transaction was made.
-                */
-               readonly purchaseDate: Date;
-           }
+            /**
+             * Represents a transaction made in the store.
+             * @public
+             */
+            export declare interface StoreTransaction {
+                /**
+                 * The unique identifier for the store transaction.
+                 */
+                readonly storeTransactionId: string;
+                /**
+                 * The identifier of the product purchased in the transaction.
+                 */
+                readonly productIdentifier: string;
+                /**
+                 * The date when the transaction was made.
+                 */
+                readonly purchaseDate: Date;
+            }
 
-           /**
-            * Subscription purchases of the Customer.
-            * @public
-            */
-           export declare interface SubscriptionInfo {
-               /**
-                * The product identifier.
-                */
-               readonly productIdentifier: string;
-               /**
-                * Date when the last subscription period started.
-                */
-               readonly purchaseDate: 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.
-                */
-               readonly originalPurchaseDate: Date | null;
-               /**
-                * Date when the subscription expires/expired
-                */
-               readonly expiresDate: Date | null;
-               /**
-                * Store where the subscription was purchased.
-                */
-               readonly store: Store;
-               /**
-                * Date when RevenueCat detected that auto-renewal was turned off for this subscription.
-                * Note the subscription may still be active, check the {@link SubscriptionInfo.expiresDate} attribute.
-                */
-               readonly unsubscribeDetectedAt: Date | null;
-               /**
-                * Whether or not the purchase was made in sandbox mode.
-                */
-               readonly isSandbox: boolean;
-               /**
-                * 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 {@link SubscriptionInfo.expiresDate} attribute.
-                */
-               readonly billingIssuesDetectedAt: Date | null;
-               /**
-                * Date when any grace period for this subscription expires/expired.
-                * null if the customer has never been in a grace period.
-                */
-               readonly gracePeriodExpiresDate: Date | null;
-               /**
-                * 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.
-                */
-               readonly ownershipType: OwnershipType;
-               /**
-                * 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
-                */
-               readonly periodType: PeriodType;
-               /**
-                * Date when RevenueCat detected a refund of this subscription.
-                */
-               readonly refundedAt: Date | null;
-               /**
-                * The transaction id in the store of the subscription.
-                */
-               readonly storeTransactionId: string | null;
-               /**
-                * Whether the subscription is currently active
-                * (at the time this object was obtained).
-                */
-               readonly isActive: boolean;
-               /**
-                * Whether the subscription will renew at the next billing period.
-                */
-               readonly willRenew: boolean;
-           }
+            /**
+             * Subscription purchases of the Customer.
+             * @public
+             */
+            export declare interface SubscriptionInfo {
+                /**
+                 * The product identifier.
+                 */
+                readonly productIdentifier: string;
+                /**
+                 * Date when the last subscription period started.
+                 */
+                readonly purchaseDate: 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.
+                 */
+                readonly originalPurchaseDate: Date | null;
+                /**
+                 * Date when the subscription expires/expired
+                 */
+                readonly expiresDate: Date | null;
+                /**
+                 * Store where the subscription was purchased.
+                 */
+                readonly store: Store;
+                /**
+                 * Date when RevenueCat detected that auto-renewal was turned off for this subscription.
+                 * Note the subscription may still be active, check the {@link SubscriptionInfo.expiresDate} attribute.
+                 */
+                readonly unsubscribeDetectedAt: Date | null;
+                /**
+                 * Whether or not the purchase was made in sandbox mode.
+                 */
+                readonly isSandbox: boolean;
+                /**
+                 * 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 {@link SubscriptionInfo.expiresDate} attribute.
+                 */
+                readonly billingIssuesDetectedAt: Date | null;
+                /**
+                 * Date when any grace period for this subscription expires/expired.
+                 * null if the customer has never been in a grace period.
+                 */
+                readonly gracePeriodExpiresDate: Date | null;
+                /**
+                 * 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.
+                 */
+                readonly ownershipType: OwnershipType;
+                /**
+                 * 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
+                 */
+                readonly periodType: PeriodType;
+                /**
+                 * Date when RevenueCat detected a refund of this subscription.
+                 */
+                readonly refundedAt: Date | null;
+                /**
+                 * The transaction id in the store of the subscription.
+                 */
+                readonly storeTransactionId: string | null;
+                /**
+                 * Whether the subscription is currently active
+                 * (at the time this object was obtained).
+                 */
+                readonly isActive: boolean;
+                /**
+                 * Whether the subscription will renew at the next billing period.
+                 */
+                readonly willRenew: boolean;
+            }
 
-           /**
-            * Represents a possible option to purchase a subscription product.
-            * @public
-            */
-           export declare interface SubscriptionOption extends PurchaseOption {
-               /**
-                * The base phase for a SubscriptionOption, represents
-                * the price that the customer will be charged after all the discounts have
-                * been consumed and the period at which it will renew.
-                */
-               readonly base: PricingPhase;
-               /**
-                * The trial information for this subscription option if available.
-                */
-               readonly trial: PricingPhase | null;
-               /**
-                * The introductory price period for this subscription option if available.
-                */
-               readonly introPrice: PricingPhase | null;
-           }
+            /**
+             * Represents a possible option to purchase a subscription product.
+             * @public
+             */
+            export declare interface SubscriptionOption extends PurchaseOption {
+                /**
+                 * The base phase for a SubscriptionOption, represents
+                 * the price that the customer will be charged after all the discounts have
+                 * been consumed and the period at which it will renew.
+                 */
+                readonly base: PricingPhase;
+                /**
+                 * The trial information for this subscription option if available.
+                 */
+                readonly trial: PricingPhase | null;
+                /**
+                 * The introductory price period for this subscription option if available.
+                 */
+                readonly introPrice: PricingPhase | null;
+            }
 
-           /**
-            * Contains information about the targeting context used to obtain an object.
-            * @public
-            */
-           export declare interface TargetingContext {
-               /**
-                * The rule id from the targeting used to obtain this object.
-                */
-               readonly ruleId: string;
-               /**
-                * The revision of the targeting used to obtain this object.
-                */
-               readonly revision: number;
-           }
+            /**
+             * Contains information about the targeting context used to obtain an object.
+             * @public
+             */
+            export declare interface TargetingContext {
+                /**
+                 * The rule id from the targeting used to obtain this object.
+                 */
+                readonly ruleId: string;
+                /**
+                 * The revision of the targeting used to obtain this object.
+                 */
+                readonly revision: number;
+            }
 
-           /**
-            * Error indicating that the SDK was accessed before it was initialized.
-            * @public
-            */
-           export declare class UninitializedPurchasesError extends Error {
-               constructor();
-           }
+            /**
+             * Error indicating that the SDK was accessed before it was initialized.
+             * @public
+             */
+            export declare class UninitializedPurchasesError extends Error {
+                constructor();
+            }
 
-           /**
-            * The VirtualCurrencies object contains all the virtual currencies associated to the user.
-            *
-            * @public
-            */
-           export declare interface VirtualCurrencies {
-               /**
-                * Map of all {@link VirtualCurrency} objects keyed by virtual currency code.
-                */
-               readonly all: {
-                   [key: string]: VirtualCurrency;
-               };
-           }
+            /**
+             * The VirtualCurrencies object contains all the virtual currencies associated to the user.
+             *
+             * @public
+             */
+            export declare interface VirtualCurrencies {
+                /**
+                 * Map of all {@link VirtualCurrency} objects keyed by virtual currency code.
+                 */
+                readonly all: {
+                    [key: string]: VirtualCurrency;
+                };
+            }
 
-           /**
-            * The VirtualCurrency object represents information about a virtual currency in the app.
-            * Use this object to access information about a virtual currency, such as its current balance.
-            *
-            * @public
-            */
-           export declare interface VirtualCurrency {
-               /**
-                * The virtual currency's balance.
-                */
-               readonly balance: number;
-               /**
-                * The virtual currency's name.
-                */
-               readonly name: string;
-               /**
-                * The virtual currency's code.
-                */
-               readonly code: string;
-               /**
-                * The virtual currency's description defined in the RevenueCat dashboard.
-                */
-               readonly serverDescription: string | null;
-           }
+            /**
+             * The VirtualCurrency object represents information about a virtual currency in the app.
+             * Use this object to access information about a virtual currency, such as its current balance.
+             *
+             * @public
+             */
+            export declare interface VirtualCurrency {
+                /**
+                 * The virtual currency's balance.
+                 */
+                readonly balance: number;
+                /**
+                 * The virtual currency's name.
+                 */
+                readonly name: string;
+                /**
+                 * The virtual currency's code.
+                 */
+                readonly code: string;
+                /**
+                 * The virtual currency's description defined in the RevenueCat dashboard.
+                 */
+                readonly serverDescription: string | null;
+            }
 
-           export { }
+            export { }