@revenuecat/purchases-typescript-internal 19.7.0 → 19.9.0

package/dist/offerings.d.ts

@@ -69,6 +69,12 @@ export declare enum INTRO_ELIGIBILITY_STATUS {
 export interface PurchasesStoreProduct {
     /**
      * Product Id.
+     *
+     * For Google Play subscriptions with a base plan, this is `productId:basePlanId`.
+     *
+     * For App Store products with a billing plan
+     * (like monthly subscriptions with a 12-month commitment), this is
+     * `productId:billingPlan` (like `productId:monthly`).
      */
     readonly identifier: string;
     /**
@@ -82,11 +88,17 @@ export interface PurchasesStoreProduct {
     /**
      * Price of the product in the local currency.
      * Contains the price value of defaultOption for Google Play.
+     *
+     * For monthly subscriptions with a 12-month commitment on the Apple App Store, the
+     * price will reflect the total amount paid across the commitment.
      */
     readonly price: number;
     /**
      * Formatted price of the item, including its currency sign.
      * Contains the formatted price value of defaultOption for Google Play.
+     *
+     * For monthly subscriptions with a 12-month commitment on the Apple App Store, the
+     * price string will reflect the total amount paid across the commitment.
      */
     readonly priceString: string;
     /**
@@ -183,6 +195,13 @@ export interface PurchasesStoreProduct {
      * Null if not using offerings or if fetched directly from store via getProducts.
      */
     readonly presentedOfferingContext: PresentedOfferingContext | null;
+    /**
+     * For installment subscriptions, the details of the installment plan the customer commits to.
+     * Null for non-installment subscriptions.
+     * iOS only. Always null on Android, use the installmentsInfo of the defaultOption or
+     * subscriptionOptions instead.
+     */
+    readonly installmentsInfo: InstallmentsInfo | null;
 }
 /**
  * Enum indicating possible product categories.
@@ -662,7 +681,26 @@ export interface SubscriptionOption {
     readonly installmentsInfo: InstallmentsInfo | null;
 }
 /**
- * Type containing information of installment subscriptions. Currently only supported in Google Play.
+ * Enum indicating the billing plan type of an installment subscription. iOS only.
+ * @public
+ */
+export declare enum BILLING_PLAN_TYPE {
+    /**
+     * The customer pays in full when purchasing the product.
+     */
+    UP_FRONT = "UP_FRONT",
+    /**
+     * The customer pays in monthly installments.
+     */
+    MONTHLY = "MONTHLY",
+    /**
+     * Unable to determine the billing plan type.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * Type containing information of installment subscriptions.
+ * Supported in Google Play (via SubscriptionOption) and iOS (via PurchasesStoreProduct).
  * @public
  */
 export interface InstallmentsInfo {
@@ -672,8 +710,44 @@ export interface InstallmentsInfo {
     readonly commitmentPaymentsCount: number;
     /**
      * After the commitment payments are complete, the number of payments the user commits to upon a renewal.
+     * On iOS this is always equal to commitmentPaymentsCount.
      */
     readonly renewalCommitmentPaymentsCount: number;
+    /**
+     * Duration of each installment, specified in ISO 8601 format. For example, P1M equates to one month.
+     * iOS only. Null on Android.
+     */
+    readonly commitmentInstallmentPeriod: string | null;
+    /**
+     * Price charged for each installment billing period.
+     * iOS only. Null on Android.
+     */
+    readonly installmentBillingPrice: number | null;
+    /**
+     * Formatted price charged for each installment billing period, including its currency sign.
+     * iOS only. Null on Android.
+     */
+    readonly installmentBillingPriceString: string | null;
+    /**
+     * Total duration of the customer's installment commitment, specified in ISO 8601 format.
+     * iOS only. Null on Android.
+     */
+    readonly commitmentTotalPeriod: string | null;
+    /**
+     * Total price the customer commits to paying across all installments.
+     * iOS only. Null on Android.
+     */
+    readonly commitmentTotalPrice: number | null;
+    /**
+     * Formatted total price the customer commits to paying across all installments, including its currency sign.
+     * iOS only. Null on Android.
+     */
+    readonly commitmentTotalPriceString: string | null;
+    /**
+     * The billing plan used for the installments.
+     * iOS only. Null on Android.
+     */
+    readonly billingPlanType: BILLING_PLAN_TYPE | null;
 }
 /**
  * Contains all the details associated with a PricingPhase

package/dist/offerings.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PERIOD_UNIT = exports.OFFER_PAYMENT_MODE = exports.RECURRENCE_MODE = exports.STORE_REPLACEMENT_MODE = exports.PRORATION_MODE = exports.PRODUCT_TYPE = exports.PRODUCT_CATEGORY = exports.INTRO_ELIGIBILITY_STATUS = exports.PACKAGE_TYPE = void 0;
+exports.PERIOD_UNIT = exports.OFFER_PAYMENT_MODE = exports.RECURRENCE_MODE = exports.BILLING_PLAN_TYPE = exports.STORE_REPLACEMENT_MODE = exports.PRORATION_MODE = exports.PRODUCT_TYPE = exports.PRODUCT_CATEGORY = exports.INTRO_ELIGIBILITY_STATUS = exports.PACKAGE_TYPE = void 0;
 /**
  * Enum indicating possible package types.
  * @public
@@ -191,6 +191,25 @@ var STORE_REPLACEMENT_MODE;
      */
     STORE_REPLACEMENT_MODE["DEFERRED"] = "DEFERRED";
 })(STORE_REPLACEMENT_MODE || (exports.STORE_REPLACEMENT_MODE = STORE_REPLACEMENT_MODE = {}));
+/**
+ * Enum indicating the billing plan type of an installment subscription. iOS only.
+ * @public
+ */
+var BILLING_PLAN_TYPE;
+(function (BILLING_PLAN_TYPE) {
+    /**
+     * The customer pays in full when purchasing the product.
+     */
+    BILLING_PLAN_TYPE["UP_FRONT"] = "UP_FRONT";
+    /**
+     * The customer pays in monthly installments.
+     */
+    BILLING_PLAN_TYPE["MONTHLY"] = "MONTHLY";
+    /**
+     * Unable to determine the billing plan type.
+     */
+    BILLING_PLAN_TYPE["UNKNOWN"] = "UNKNOWN";
+})(BILLING_PLAN_TYPE || (exports.BILLING_PLAN_TYPE = BILLING_PLAN_TYPE = {}));
 /**
  * Recurrence mode for a pricing phase
  * @public

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@revenuecat/purchases-typescript-internal",
   "title": "Purchases typescript internal shared code",
-  "version": "19.7.0",
+  "version": "19.9.0",
   "description": "Typescript code to be used by RevenueCat's hybrid SDKs. Not meant for external usage.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",