@freemius/sdk 0.0.1 → 0.0.3

package/dist/index.d.mts

@@ -1,123 +1,13 @@
-import createClient from "openapi-fetch";
-import { CheckoutOptions, CheckoutPopupArbitraryParams, CheckoutPopupParams } from "@freemius/checkout";
+import createClient, { QuerySerializerOptions } from "openapi-fetch";
+import { CheckoutOptions, CheckoutPopupParams } from "@freemius/checkout";
+import * as zod from "zod";
 import * as http0 from "http";
 
-//#region src/contracts/types.d.ts
-/**
- * This file holds all generic types used across the SDK, not specific to any contract.
- */
-declare enum BILLING_CYCLE {
-  MONTHLY = "monthly",
-  YEARLY = "yearly",
-  ONEOFF = "oneoff",
-}
-interface PagingOptions {
-  count?: number;
-  offset?: number;
-}
-type ApiEntitiesFilter<T> = Omit<NonNullable<T>, 'count' | 'offset'>;
-declare enum CURRENCY {
-  USD = "USD",
-  EUR = "EUR",
-  GBP = "GBP",
-}
-type PaymentMethod = 'card' | 'paypal' | 'ideal';
-//#endregion
-//#region src/contracts/purchase.d.ts
-interface PurchaseData {
-  /**
-   * Email address of the user associated with the license. This is unique to the user and is used for communication regarding the license.
-   */
-  email: string;
-  /**
-   * First name of the user associated with the license.
-   */
-  firstName: string;
-  /**
-   * Last name of the user associated with the license.
-   */
-  lastName: string;
-  /**
-   * ID of the Freemius user.
-   */
-  userId: string;
-  /**
-   * ID of the Freemius plan the license is associated with.
-   */
-  planId: string;
-  /**
-   * ID of the Freemius pricing of the plan (used to determine the quota of the purchase).
-   */
-  pricingId: string;
-  /**
-   * ID of the Freemius license.
-   *
-   * Use this ID to make additional API calls related to the license and associated subscriptions.
-   */
-  licenseId: string;
-  /**
-   * Expiration date of the license.
-   *
-   * If `null` then the license never expires (for one-off purchases).
-   */
-  expiration: Date | null;
-  /**
-   * Indicates if the license is canceled.
-   */
-  canceled: boolean;
-  /**
-   * Quota/Units associated with the license. If `null`, then it means the license has unlimited quota.
-   */
-  quota: number | null;
-  /**
-   * ID of the Freemius subscription associated with the license, if any.
-   *
-   * This is optional and may be `null` if the license is not associated with a subscription (for one-off purchases or if the subscription is cancelled already).
-   */
-  subscriptionId: string | null;
-  /**
-   * Billing cycle of the subscription, if applicable.
-   *
-   * This is optional and may be `null` if the license is not associated with a subscription.
-   * The billing cycle could be `oneoff`, in case a subscription was created against a one-off trial.
-   */
-  billingCycle: BILLING_CYCLE | null;
-  /**
-   * Indicates if the license is currently active. Only relevant for subscriptions.
-   */
-  isActive: boolean;
-  /**
-   * Initial amount charged for the purchase, if applicable.
-   */
-  initialAmount: number | null;
-  /**
-   * Renewal amount for the subscription, if applicable.
-   */
-  renewalAmount: number | null;
-  /**
-   * Renewal date for the subscription, if applicable.
-   */
-  renewalDate: Date | null;
-  /**
-   * Currency of the purchase, if applicable.
-   */
-  currency: CURRENCY | null;
-  /**
-   * Payment method used for the purchase, if applicable.
-   */
-  paymentMethod: PaymentMethod | null;
-  /**
-   * Date when the purchase was created. This reflects the created date of the license. The subscription however can get cancelled or updated durign the life-cycle and shouldn't be used to determine the purchase date.
-   */
-  created: Date;
-}
-//#endregion
 //#region src/api/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 interface paths {
   '/developers/{developer_id}/bank_account/{bank_account_id}.json': {
     parameters: {
@@ -1623,7 +1513,7 @@ interface paths {
     post?: never;
     /**
      * Cancel a trial
-     * @description Cancel a trial associated with an specified install.
+     * @description Cancel a trial associated with a specific install.
      */
     delete: operations['installations/cancel-trial'];
     options?: never;
@@ -2248,6 +2138,37 @@ interface paths {
     patch?: never;
     trace?: never;
   };
+  '/products/{product_id}/payments/{payment_id}/invoice.pdf': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /**
+         * @description The ID of the product.
+         * @example 1234
+         */
+        product_id: components['parameters']['product_id'];
+        /**
+         * @description The ID of the payment.
+         * @example 1234
+         */
+        payment_id: components['parameters']['payment_id'];
+      };
+      cookie?: never;
+    };
+    /**
+     * Download invoice
+     * @description Download invoice of a payment.
+     */
+    get: operations['payments/download-invoice'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   '/products/{product_id}/ping.json': {
     parameters: {
       query?: never;
@@ -3918,7 +3839,7 @@ interface components {
        * @example ls
        * @enum {string}
        */
-      source_external_id?: 'freemius' | 'edd' | 'easydigitaldownloads' | 'woo' | 'wc' | 'woocommerce' | 'gumroad' | 'cc' | 'codecanyon' | 'tf' | 'themeforest' | 'appsumo' | 'sendowl' | 'whmcs' | 'ls' | 'lemonsqueezy';
+      source_external_id?: 'freemius' | 'edd' | 'others' | 'easydigitaldownloads' | 'woo' | 'wc' | 'woocommerce' | 'gumroad' | 'cc' | 'codecanyon' | 'tf' | 'themeforest' | 'appsumo' | 'sendowl' | 'whmcs' | 'ls' | 'lemonsqueezy';
       /**
        * @description
        *     The source of the migration data. To get support migrating from other platform please see our [documentation](https://freemius.com/help/documentation/migration/).
@@ -4516,6 +4437,14 @@ interface components {
        */
       is_featured?: boolean;
     };
+    FeatureEnriched: components['schemas']['Feature'] & {
+      /**
+       * @description The value of the feature associated with the plan. For example the feature name could be "AI Credits" and the value could be "1000".
+       * @example 1000 Units
+       */
+      value?: string;
+      plan_id?: components['schemas']['CommonProperties']['plan_id'];
+    };
     FeaturePlan: {
       id?: components['schemas']['CommonProperties']['id'];
       created?: components['schemas']['CommonProperties']['created'];
@@ -5872,6 +5801,8 @@ interface components {
         eur?: number;
       };
     };
+    FSEndpointDeveloperPluginSubscriptions: components['schemas']['Discount'][];
+    FSEndpointDeveloperPluginUserSubscriptions: components['schemas']['Discount'][];
   };
   responses: {
     /** @description The API has no content to send. This usually happens when some entity is deleted. */
@@ -7648,6 +7579,8 @@ interface operations {
           accepted_payments?: 0 | 1;
           /** @description `True` to expose license key to customers upon purchase/subscription. (Available for 'SaaS' products only) */
           expose_license_key?: boolean;
+          /** @description `True` to include in the after-purchase emails the customer portal login link. */
+          enable_after_purchase_email_login_link?: boolean;
         };
       };
     };
@@ -8963,6 +8896,9 @@ interface operations {
   'installations/cancel-trial': {
     parameters: {
       query?: {
+        /** @description Optional cancellation reason IDs. */
+        reason_ids?: components['schemas']['Uninstall']['reason_id'][];
+        reason?: components['schemas']['Uninstall']['reason_info'];
         /**
          * @description Comma separated list of fields to return in the response. If not specified, all fields are returned.
          * @example id,name,slug
@@ -8984,16 +8920,17 @@ interface operations {
       };
       cookie?: never;
     };
-    requestBody?: {
-      content: {
-        'application/json': {
-          reason_ids?: components['schemas']['Uninstall']['reason_id'][];
-          reason?: components['schemas']['Uninstall']['reason_info'];
+    requestBody?: never;
+    responses: {
+      /** @description The install with cancelled trial. */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['Install'];
         };
       };
-    };
-    responses: {
-      204: components['responses']['204'];
       400: components['responses']['400'];
       401: components['responses']['401'];
       402: components['responses']['402'];
@@ -10128,6 +10065,47 @@ interface operations {
       404: components['responses']['404'];
     };
   };
+  'payments/download-invoice': {
+    parameters: {
+      query?: {
+        /**
+         * @description Comma separated list of fields to return in the response. If not specified, all fields are returned.
+         * @example id,name,slug
+         */
+        fields?: components['parameters']['fields'];
+      };
+      header?: never;
+      path: {
+        /**
+         * @description The ID of the product.
+         * @example 1234
+         */
+        product_id: components['parameters']['product_id'];
+        /**
+         * @description The ID of the payment.
+         * @example 1234
+         */
+        payment_id: components['parameters']['payment_id'];
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description PDF invoice */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/pdf': unknown;
+        };
+      };
+      400: components['responses']['400'];
+      401: components['responses']['401'];
+      402: components['responses']['402'];
+      404: components['responses']['404'];
+    };
+  };
   'products/gdpr-compliance-check': {
     parameters: {
       query: {
@@ -10806,25 +10784,34 @@ interface operations {
         };
         content: {
           'application/json': {
-            plugin?: components['schemas']['Plugin'];
+            plugin?: {
+              icon?: components['schemas']['Plugin']['icon'];
+              slug?: components['schemas']['Plugin']['slug'];
+              title?: components['schemas']['Plugin']['title'];
+              type?: components['schemas']['Plugin']['type'];
+              money_back_period?: components['schemas']['Plugin']['money_back_period'];
+              refund_policy?: components['schemas']['Plugin']['refund_policy'];
+              public_key?: components['schemas']['Plugin']['public_key'];
+              parent_plugin_id?: components['schemas']['Plugin']['parent_plugin_id'];
+              /** @description The label used for the selling unit of the product, e.g., 'Credit', 'Activation', etc. The resulting object will have both singular and plural. */
+              selling_unit_label?: {
+                /**
+                 * @description The singular form of the selling unit label.
+                 * @example Credit
+                 */
+                singular?: string;
+                /**
+                 * @description The plural form of the selling unit label.
+                 * @example Credits
+                 */
+                plural?: string;
+              };
+            };
             plans?: (components['schemas']['Plan'] & {
               pricing?: components['schemas']['Pricing'][];
             } & {
-              features?: components['schemas']['Feature'][];
+              features?: components['schemas']['FeatureEnriched'][];
             })[];
-            /** @description The label used for the selling unit of the product, e.g., 'Credit', 'Activation', etc. The resulting object will have both singular and plural. */
-            selling_unit_label?: {
-              /**
-               * @description The singular form of the selling unit label.
-               * @example Credit
-               */
-              singular?: string;
-              /**
-               * @description The plural form of the selling unit label.
-               * @example Credits
-               */
-              plural?: string;
-            };
             /** @description Verified and featured reviews of the product. */
             reviews?: components['schemas']['PluginReview'][];
             /**
@@ -11422,7 +11409,13 @@ interface operations {
           [name: string]: unknown;
         };
         content: {
-          'application/json': components['schemas']['Subscription'];
+          'application/json': components['schemas']['Subscription'] & {
+            /**
+             * @description Shows whether a subscription cancellation discount was applied to the subscription.
+             * @example false
+             */
+            has_subscription_cancellation_discount?: boolean | null;
+          };
         };
       };
       401: components['responses']['401'];
@@ -11484,6 +11477,8 @@ interface operations {
         filter?: 'all' | 'active' | 'cancelled';
         /** @description When set to `true` enrich the subscriptions with the plan name, install URL & title, and user email. */
         extended?: boolean;
+        /** @description When set to `true` enrich the subscription to include any cancellation discounts applied to the subscriptions. */
+        enrich_with_cancellation_discounts?: boolean;
         /**
          * @description The number of records to return.
          * @example 10
@@ -11542,8 +11537,16 @@ interface operations {
                * @example Website title
                */
               title?: string | null;
+              /**
+               * @description Whether subscription cancellation discount was already applied. (Only available when `enrich_with_cancellation_discounts` is set to `true`.)
+               * @example true
+               */
+              has_subscription_cancellation_discount?: boolean | null;
             })[];
-            discounts?: components['schemas']['Discount'][];
+            /** @description The key represents the ID of the subscription */
+            discounts?: {
+              [key: string]: components['schemas']['Discount'][];
+            };
           };
         };
       };
@@ -12715,6 +12718,8 @@ interface operations {
         sort?: 'id' | 'next_payment';
         /** @description Search by subscription ID, external subscription ID or user email. */
         search?: string;
+        /** @description When set to `true` enrich the subscription to include any cancellation discounts applied to the subscriptions. */
+        enrich_with_cancellation_discounts?: boolean;
       };
       header?: never;
       path: {
@@ -12761,8 +12766,16 @@ interface operations {
                * @example Website title
                */
               title?: string | null;
+              /**
+               * @description Shows whether a renewal discount was already applied to the subscription.
+               * @example false
+               */
+              has_subscription_cancellation_discount?: boolean | null;
             })[];
-            discounts?: components['schemas']['Discount'][];
+            /** @description The key represents the ID of the subscription */
+            discounts?: {
+              [key: string]: components['schemas']['Discount'][];
+            };
           };
         };
       };
@@ -12897,6 +12910,13 @@ type ApiAuthParams = {
 type FSId = string | number | bigint;
 type SubscriptionEntity = components['schemas']['Subscription'];
 type SubscriptionFilterOptions = ApiEntitiesFilter<operations['subscriptions/list']['parameters']['query']>;
+type UserSubscriptionEntity = NonNullable<operations['users/list-subscriptions']['responses'][200]['content']['application/json']['subscriptions']>[number];
+type SubscriptionDiscountEntity = NonNullable<operations['users/list-subscriptions']['responses'][200]['content']['application/json']['discounts']>[string][number];
+type UserSubscriptionWithDiscounts = UserSubscriptionEntity & {
+  discounts: SubscriptionDiscountEntity[];
+};
+type SubscriptionCancellationResult = operations['subscriptions/cancel']['responses'][200]['content']['application/json'];
+type SubscriptionRenewalCouponResult = operations['subscriptions/update']['responses'][200]['content']['application/json'];
 type UserEntity = components['schemas']['User'];
 type UserFilterOptions = ApiEntitiesFilter<operations['users/list']['parameters']['query']>;
 type UserBillingEntity = components['schemas']['Billing'];
@@ -12907,56 +12927,249 @@ type UserPluginEntity = components['schemas']['UserPluginEnriched'];
 type LicenseEntity = components['schemas']['License'];
 type LicenseFilterOptions = ApiEntitiesFilter<operations['licenses/list']['parameters']['query']>;
 type PaymentEntity = components['schemas']['Payment'];
+type PaymentFilterOptions = ApiEntitiesFilter<operations['payments/list']['parameters']['query']>;
 type ProductEntity = components['schemas']['Plugin'];
 type PricingTableData = operations['products/retrieve-pricing-table-data']['responses'][200]['content']['application/json'];
 type PricingEntity = components['schemas']['Pricing'];
+type PlanEntity = components['schemas']['Plan'];
 type BillingEntity = components['schemas']['Billing'];
+type BillingUpdatePayload = operations['users/update-or-create-billing']['requestBody']['content']['application/json'];
 type EventEntity = components['schemas']['EventLog'];
 type InstallEntity = components['schemas']['Install'];
 type BillingCycleApiEnum = components['schemas']['CommonEnums']['BillingCycle'];
 type CurrencyApiEnum = components['schemas']['CommonEnums']['Currency'];
+type SellingUnit = Required<NonNullable<NonNullable<operations['products/retrieve-pricing-table-data']['responses']['200']['content']['application/json']['plugin']>['selling_unit_label']>>;
+type CouponEntityEnriched = components['schemas']['CouponEntityEnriched'];
+type SubscriptionCancellationReasonType = components['schemas']['Uninstall']['reason_id'];
 //#endregion
-//#region src/contracts/portal.d.ts
-interface PortalSubscription {
-  subscriptionId: string;
-  licenseId: string;
-  planId: string;
-  pricingId: string;
-  planTitle: string;
-  renewalAmount: number;
-  initialAmount: number;
-  billingCycle: BILLING_CYCLE | null;
-  isActive: boolean;
-  renewalDate: Date | null;
-  currency: CURRENCY;
-  cancelledAt?: Date | null;
-  createdAt: Date;
-  checkoutUpgradeAuthorization?: string | null;
-  quota: number | null;
-  paymentMethod: PaymentMethod | null;
+//#region src/contracts/types.d.ts
+/**
+ * This file holds all generic types used across the SDK, not specific to any contract.
+ */
+declare enum BILLING_CYCLE {
+  MONTHLY = "monthly",
+  YEARLY = "yearly",
+  ONEOFF = "oneoff",
 }
-type PortalPlans = NonNullable<operations['products/retrieve-pricing-table-data']['responses']['200']['content']['application/json']['plans']>;
-type PortalPayment = PaymentEntity & {
-  invoiceUrl: string;
-  paymentMethod: PaymentMethod;
-  createdAt: Date;
-  quota: number | null;
-  planTitle: string;
-};
-type SellingUnit = NonNullable<operations['products/retrieve-pricing-table-data']['responses']['200']['content']['application/json']['selling_unit_label']>;
-interface PortalData {
-  user: UserEntity;
-  subscriptions: {
-    primary: PortalSubscription | null;
-    active: PortalSubscription[];
-    past: PortalSubscription[];
-  };
-  billing: BillingEntity | null;
+interface PagingOptions {
+  count?: number;
+  offset?: number;
+}
+type ApiEntitiesFilter<T> = Omit<NonNullable<T>, 'count' | 'offset'>;
+declare enum CURRENCY {
+  USD = "USD",
+  EUR = "EUR",
+  GBP = "GBP",
+}
+type PaymentMethod = 'card' | 'paypal' | 'ideal';
+type UserRetriever = () => Promise<{
+  id: FSId;
+  primaryLicenseId?: FSId;
+  email?: string;
+} | {
+  email: string;
+} | null>;
+/**
+ * @todo - Add a more unified way to get handlers so that we can simplify the Checkout & Customer Portal request processors.
+ */
+interface RequestProcessor<Config> {
+  createProcessor(config: Config): (request: Request) => Promise<Response>;
+  process(config: Config, request: Request): Promise<Response>;
+}
+//#endregion
+//#region src/contracts/purchase.d.ts
+interface PurchaseData {
+  /**
+   * Email address of the user associated with the license. This is unique to the user and is used for communication regarding the license.
+   */
+  email: string;
+  /**
+   * First name of the user associated with the license.
+   */
+  firstName: string;
+  /**
+   * Last name of the user associated with the license.
+   */
+  lastName: string;
+  /**
+   * ID of the Freemius user.
+   */
+  userId: string;
+  /**
+   * ID of the Freemius plan the license is associated with.
+   */
+  planId: string;
+  /**
+   * ID of the Freemius pricing of the plan (used to determine the quota of the purchase).
+   */
+  pricingId: string;
+  /**
+   * ID of the Freemius license.
+   *
+   * Use this ID to make additional API calls related to the license and associated subscriptions.
+   */
+  licenseId: string;
+  /**
+   * Expiration date of the license.
+   *
+   * If `null` then the license never expires (for one-off purchases).
+   */
+  expiration: Date | null;
+  /**
+   * Indicates if the license is canceled.
+   */
+  canceled: boolean;
+  /**
+   * Quota/Units associated with the license. If `null`, then it means the license has unlimited quota.
+   */
+  quota: number | null;
+  /**
+   * ID of the Freemius subscription associated with the license, if any.
+   *
+   * This is optional and may be `null` if the license is not associated with a subscription (for one-off purchases or if the subscription is cancelled already).
+   */
+  subscriptionId: string | null;
+  /**
+   * Billing cycle of the subscription, if applicable.
+   *
+   * This is optional and may be `null` if the license is not associated with a subscription.
+   * The billing cycle could be `oneoff`, in case a subscription was created against a one-off trial.
+   */
+  billingCycle: BILLING_CYCLE | null;
+  /**
+   * Indicates if the license is currently active. Only relevant for subscriptions.
+   */
+  isActive: boolean;
+  /**
+   * Initial amount charged for the purchase, if applicable.
+   */
+  initialAmount: number | null;
+  /**
+   * Renewal amount for the subscription, if applicable.
+   */
+  renewalAmount: number | null;
+  /**
+   * Renewal date for the subscription, if applicable.
+   */
+  renewalDate: Date | null;
+  /**
+   * Currency of the purchase, if applicable.
+   */
+  currency: CURRENCY | null;
+  /**
+   * Payment method used for the purchase, if applicable.
+   */
+  paymentMethod: PaymentMethod | null;
+  /**
+   * Date when the purchase was created. This reflects the created date of the license. The subscription however can get cancelled or updated durign the life-cycle and shouldn't be used to determine the purchase date.
+   */
+  created: Date;
+}
+type PurchaseEntitlementType = 'subscription' | 'oneoff';
+/**
+ * Data structure representing a purchase entitlement, which links a user to a specific license and plan within the Freemius system.
+ * This is what is typically stored in your own database to keep track of user entitlements.
+ */
+interface PurchaseEntitlementData {
+  /**
+   * The unique identifier of the user in the Freemius system.
+   */
+  fsLicenseId: string;
+  /**
+   * The unique identifier of the plan in the Freemius system.
+   */
+  fsPlanId: string;
+  /**
+   * The unique identifier of the pricing in the Freemius system.
+   */
+  fsPricingId: string;
+  /**
+   * The unique identifier of the user in the Freemius system.
+   */
+  fsUserId: string;
+  /**
+   * The type of entitlement, which can be either 'subscription' or 'oneoff'.
+   */
+  type: PurchaseEntitlementType;
+  /**
+   * The expiration date of the entitlement. If `null`, the entitlement does not expire.
+   * If you are passing a string, then it must of the format "YYYY-MM-DD HH:mm:ss" in UTC.
+   */
+  expiration: Date | null | string;
+  /**
+   * The date when the entitlement was created. This is useful for record-keeping and auditing purposes.
+   */
+  createdAt: Date | string;
+  /**
+   * Indicates whether the entitlement has been canceled.
+   */
+  isCanceled: boolean;
+}
+//#endregion
+//#region src/contracts/portal.d.ts
+interface PortalSubscription {
+  subscriptionId: string;
+  licenseId: string;
+  planId: string;
+  pricingId: string;
+  planTitle: string;
+  renewalAmount: number;
+  initialAmount: number;
+  billingCycle: BILLING_CYCLE | null;
+  isActive: boolean;
+  renewalDate: Date | null;
+  currency: CURRENCY;
+  cancelledAt?: Date | null;
+  createdAt: Date;
+  checkoutUpgradeAuthorization?: string | null;
+  quota: number | null;
+  paymentMethod: PaymentMethod | null;
+  upgradeUrl?: string;
+  isTrial: boolean;
+  trialEnds: Date | null;
+  isFreeTrial: boolean;
+  applyRenewalCancellationCouponUrl: string | null;
+  cancelRenewalUrl: string;
+}
+type PortalPlans = NonNullable<operations['products/retrieve-pricing-table-data']['responses']['200']['content']['application/json']['plans']>;
+type PortalPayment = PaymentEntity & {
+  invoiceUrl: string;
+  paymentMethod: PaymentMethod;
+  createdAt: Date;
+  quota: number | null;
+  planTitle: string;
+};
+type PortalBilling = (BillingEntity | null) & {
+  updateUrl: string;
+};
+type PortalSubscriptions = {
+  primary: PortalSubscription | null;
+  active: PortalSubscription[];
+  past: PortalSubscription[];
+};
+interface PortalData {
+  user: UserEntity;
+  endpoint: string;
+  subscriptions: PortalSubscriptions;
+  billing: PortalBilling;
   payments: PortalPayment[] | null;
   plans: PortalPlans;
   sellingUnit: SellingUnit;
   productId: string;
   checkoutOptions: CheckoutOptions;
+  cancellationCoupons: Pick<CouponEntityEnriched, 'has_renewals_discount' | 'type' | 'coupon_id' | 'discount' | 'discount_type' | 'discounts'>[] | null;
+}
+/**
+ * Interface for actions that can be processed in the customer portal.
+ */
+interface PortalAction {
+  createAuthenticatedUrl(id: string, userId: FSId, endpoint: string): string;
+  verifyAuthentication(request: Request): boolean;
+  canHandle(request: Request): boolean;
+  /**
+   * Process the action and return a response.
+   */
+  processAction(request: Request): Promise<Response>;
 }
 //#endregion
 //#region src/contracts/checkout.d.ts
@@ -13037,6 +13250,87 @@ interface CheckoutRedirectData {
    */
   payment_id: string | null;
 }
+type CheckoutBuilderUserOptions = {
+  email: string;
+  firstName?: string;
+  lastName?: string;
+  name?: string;
+} | null | undefined;
+type CheckoutBuilderOptions = {
+  /**
+   * The user for whom the checkout is being created.
+   * This should be an object containing user details like email, ID, etc.
+   * If not provided, the checkout will be created without user context.
+   */
+  user?: CheckoutBuilderUserOptions;
+  /**
+   * Whether to use sandbox mode for the checkout.
+   *
+   * @default false
+   */
+  isSandbox?: boolean;
+  /**
+   * Whether to include the recommended option in the checkout for maximum conversion.
+   *
+   * @default true
+   */
+  withRecommendation?: boolean;
+  /**
+   * The title of the checkout modal.
+   */
+  title?: string;
+  /**
+   * Image to display in the checkout modal. Must be a valid https URL.
+   */
+  image?: string;
+  /**
+   * Optional plan ID to use for the checkout.
+   * If provided, this will be used as the default plan for the checkout, instead of the first paid plan.
+   */
+  planId?: string;
+  /**
+   * Optional quota to set for the checkout.
+   *
+   * This is useful when purchasing credits or similar resources.
+   */
+  quota?: number;
+  /**
+   * Optional trial period configuration.
+   *
+   * This can be used to set a trial period for the checkout.
+   * If not provided, the checkout will not have a trial period.
+   */
+  trial?: CheckoutOptions['trial'];
+};
+/**
+ * Interface for actions that can be processed during the checkout flow.
+ */
+interface CheckoutAction {
+  /**
+   * Determine if the action can be handled by this processor.
+   */
+  canHandle(request: Request): boolean;
+  /**
+   * Process the action and return a response.
+   */
+  processAction(request: Request): Promise<Response>;
+}
+//#endregion
+//#region src/contracts/pricing.d.ts
+type PricingData = {
+  /**
+   * Product's pricing plans to display in the paywall.
+   */
+  plans: PortalPlans;
+  /**
+   * Optional plan ID to use for top-up purchases.
+   */
+  topupPlan?: PortalPlans[number] | null;
+  /**
+   * The selling unit label for the product (e.g., "Credits", "Messages", etc.).
+   */
+  sellingUnit: SellingUnit;
+};
 //#endregion
 //#region src/api/parser.d.ts
 declare function idToNumber(id: FSId): number;
@@ -13055,7 +13349,7 @@ type FsApiClient = ReturnType<typeof createApiClient>;
 //#endregion
 //#region src/api/ApiBase.d.ts
 declare abstract class ApiBase<EntityType, FilterType extends Record<string, unknown> = Record<string, unknown>> {
-  readonly client: FsApiClient;
+  protected readonly client: FsApiClient;
   readonly productId: number;
   constructor(productId: FSId, client: FsApiClient);
   abstract retrieve(id: FSId): Promise<EntityType | null>;
@@ -13078,6 +13372,10 @@ declare abstract class ApiBase<EntityType, FilterType extends Record<string, unk
   };
   getIdForPath(id: FSId): number;
   isGoodResponse(response: Response): boolean;
+  /**
+   * @note - We must use this serializer when sending arrays as query parameter to our API.
+   */
+  getQuerySerializerForArray(): QuerySerializerOptions;
 }
 //#endregion
 //#region src/api/License.d.ts
@@ -13144,6 +13442,7 @@ declare class Product extends ApiBase<ProductEntity, never> {
   retrieve(): Promise<ProductEntity | null>;
   retrieveMany(): Promise<ProductEntity[]>;
   retrievePricingData(): Promise<PricingTableData | null>;
+  retrieveSubscriptionCancellationCoupon(): Promise<CouponEntityEnriched[] | null>;
 }
 //#endregion
 //#region src/api/Subscription.d.ts
@@ -13222,7 +13521,10 @@ declare class Subscription extends ApiBase<SubscriptionEntity, SubscriptionFilte
     email?: string | null;
     url?: string | null;
     title?: string | null;
+    has_subscription_cancellation_discount?: boolean | null;
   })[]>;
+  applyRenewalCoupon(subscriptionId: FSId, couponId: string, logAutoRenew: boolean): Promise<SubscriptionRenewalCouponResult | null>;
+  cancel(subscriptionId: FSId, feedback?: string, reasonIds?: SubscriptionCancellationReasonType[]): Promise<SubscriptionCancellationResult | null>;
 }
 //#endregion
 //#region src/api/User.d.ts
@@ -13269,12 +13571,58 @@ declare class User extends ApiBase<UserEntity, UserFilterOptions> {
   }[]>;
   retrieveByEmail(email: string): Promise<UserEntity | null>;
   retrieveBilling(userId: FSId): Promise<UserBillingEntity | null>;
-  retrieveSubscriptions(userId: FSId, filters?: UserSubscriptionFilterOptions, pagination?: PagingOptions): Promise<SubscriptionEntity[]>;
+  retrieveSubscriptions(userId: FSId, filters?: UserSubscriptionFilterOptions, pagination?: PagingOptions): Promise<UserSubscriptionWithDiscounts[]>;
   retrieveLicenses(userId: FSId, filters?: UserLicenseFilterOptions, pagination?: PagingOptions): Promise<LicenseEntity[]>;
   retrievePayments(userId: FSId, filters?: UserPaymentFilterOptions, pagination?: PagingOptions): Promise<PaymentEntity[]>;
+  updateBilling(userId: FSId, payload: BillingUpdatePayload): Promise<UserBillingEntity | null>;
+}
+//#endregion
+//#region src/api/Payment.d.ts
+declare class Payment extends ApiBase<PaymentEntity, PaymentFilterOptions> {
+  retrieve(paymentId: FSId): Promise<PaymentEntity | null>;
+  retrieveMany(filter?: PaymentFilterOptions, pagination?: PagingOptions): Promise<({
+    user_id?: components["schemas"]["CommonProperties"]["user_id"];
+    install_id?: components["schemas"]["CommonProperties"]["install_id_nullable"];
+    plan_id?: components["schemas"]["CommonProperties"]["plan_id"];
+    pricing_id?: components["schemas"]["CommonProperties"]["pricing_id_nullable"];
+    license_id?: components["schemas"]["CommonProperties"]["license_id"];
+    ip?: components["schemas"]["CommonProperties"]["ip_nullable"];
+    country_code?: components["schemas"]["CommonProperties"]["country_code"];
+    zip_postal_code?: components["schemas"]["CommonProperties"]["zip_postal_code_nullable"];
+    vat_id?: components["schemas"]["CommonProperties"]["vat_id_nullable"];
+    coupon_id?: components["schemas"]["CommonProperties"]["coupon_id_nullable"];
+    user_card_id?: string;
+    source?: components["schemas"]["Migration"]["source"];
+    plugin_id?: components["schemas"]["CommonProperties"]["plugin_id"];
+    external_id?: string;
+    gateway?: string | null;
+    environment?: components["schemas"]["CommonProperties"]["environment"];
+    id?: components["schemas"]["CommonProperties"]["id"];
+    created?: components["schemas"]["CommonProperties"]["created"];
+    updated?: components["schemas"]["CommonProperties"]["updated"];
+    currency?: components["schemas"]["CommonEnums"]["Currency"];
+    refund_reason?: string | null;
+    subscription_id?: components["schemas"]["CommonProperties"]["subscription_id_nullable"];
+    gross?: number;
+    bound_payment_id?: string;
+    gateway_fee: number;
+    vat?: components["schemas"]["CommonProperties"]["vat"];
+    is_renewal: boolean;
+    type?: components["schemas"]["CommonEnums"]["PaymentType"];
+  } & {
+    email?: components["schemas"]["User"]["email"];
+    url?: components["schemas"]["Install"]["url"];
+    billing_cycle?: components["schemas"]["Subscription"]["billing_cycle"];
+    plan_name?: string;
+    refund_reason?: string;
+  })[]>;
+  retrieveInvoice(paymentId: FSId): Promise<Blob | null>;
 }
 //#endregion
 //#region src/services/ApiService.d.ts
+/**
+ * @todo - Add a proper user-agent string with SDK version.
+ */
 declare class ApiService {
   private readonly secretKey;
   private readonly publicKey;
@@ -13284,6 +13632,7 @@ declare class ApiService {
   readonly license: License;
   readonly product: Product;
   readonly subscription: Subscription;
+  readonly payment: Payment;
   readonly baseUrl: string;
   constructor(productId: FSId, apiKey: string, secretKey: string, publicKey: string);
   /**
@@ -13293,9 +13642,10 @@ declare class ApiService {
    * For regular operations, prefer using the provided services like `User`, `Subscription`, `License` etc.
    */
   get __unstable_ApiClient(): FsApiClient;
+  createSignedUrl(path: string): string;
   createUrl(path: string): string;
   /**
-   * Generate signed URL for the given full URL
+   * Generate signed URL for the given full URL. The authentication is valid for 15 minutes only.
    */
   getSignedUrl(fullUrl: string): string;
   /**
@@ -13312,35 +13662,32 @@ declare class ApiService {
   private toDateTimeString;
 }
 //#endregion
-//#region src/models/CheckoutBuilder.d.ts
-type CheckoutBuilderUserOptions = {
-  email: string;
-  firstName?: string;
-  lastName?: string;
-  name?: string;
-} | null | undefined;
+//#region src/checkout/Checkout.d.ts
+type CheckoutSerialized = {
+  options: CheckoutOptions;
+  link: string;
+  baseUrl: string;
+};
 /**
  * A builder class for constructing checkout parameters. This class provides a fluent
  * API to create Checkout parameters for a product with various configurations.
  *
- *
- *
- * Every method returns a new instance of the builder with the updated options,
- * allowing for method chaining. The final `toOptions()` method returns the constructed
- * `CheckoutOptions` object. So the class itself is immutable and does not modify the original instance.
+ * Every method returns the existing instance of the builder for chainability,
+ * The final `getOptions()` method returns the constructed `CheckoutOptions` object.
  */
-declare class CheckoutBuilder {
-  private readonly options;
+declare class Checkout {
   private readonly productId;
-  private readonly publicKey?;
-  private readonly secretKey?;
-  constructor(options: Omit<CheckoutPopupParams, 'plugin_id'> & CheckoutPopupArbitraryParams, productId: string, publicKey?: string | undefined, secretKey?: string | undefined);
+  private readonly publicKey;
+  private readonly secretKey;
+  static createSandboxToken(productId: string, secretKey: string, publicKey: string): NonNullable<CheckoutPopupParams['sandbox']>;
+  private options;
+  constructor(productId: string, publicKey: string, secretKey: string);
   /**
    * Enables sandbox mode for testing purposes.
    *
    * @returns A new builder instance with sandbox configuration
    */
-  inSandbox(): CheckoutBuilder;
+  setSandbox(): Checkout;
   /**
    * Sets user information for the checkout session.
    *
@@ -13349,30 +13696,30 @@ declare class CheckoutBuilder {
    *
    * @returns A new builder instance with user configuration
    */
-  withUser(user: CheckoutBuilderUserOptions, readonly?: boolean): CheckoutBuilder;
+  setUser(user: CheckoutBuilderUserOptions, readonly?: boolean): Checkout;
   /**
    * Applies recommended UI settings for better user experience.
    * This includes fullscreen mode, upsells, refund badge, and reviews display.
    *
    * @returns A new builder instance with recommended UI settings
    */
-  withRecommendation(): CheckoutBuilder;
+  setRecommendations(): Checkout;
   /**
    * Sets the plan ID for the checkout.
    *
    * @param planId The plan ID to purchase
    * @returns A new builder instance with plan ID set
    */
-  withPlan(planId: string | number): CheckoutBuilder;
+  setPlan(planId: string | number): Checkout;
   /**
    * Sets the number of licenses to purchase.
    *
    * @param count Number of licenses
    * @returns A new builder instance with license count set
    */
-  withQuota(count: number): CheckoutBuilder;
-  withPricing(pricingId: string | number): CheckoutBuilder;
-  withTitle(title: string): CheckoutBuilder;
+  setQuota(count: number): Checkout;
+  setPricing(pricingId: string | number): Checkout;
+  setTitle(title: string): Checkout;
   /**
    * Sets a coupon code for the checkout.
    *
@@ -13380,42 +13727,42 @@ declare class CheckoutBuilder {
    * @param hideUI Whether to hide the coupon input field from users
    * @returns A new builder instance with coupon configuration
    */
-  withCoupon(options: {
+  setCoupon(options: {
     code: string;
     hideUI?: boolean;
-  }): CheckoutBuilder;
+  }): Checkout;
   /**
    * Enables trial mode for the checkout.
    *
    * @param mode Trial type - true/false for plan default, or specific 'free'/'paid' mode
    * @returns A new builder instance with trial configuration
    */
-  inTrial(mode?: 'free' | 'paid' | boolean): CheckoutBuilder;
+  setTrial(mode?: 'free' | 'paid' | boolean): Checkout;
   /**
    * Configures the visual layout and appearance of the checkout.
    *
    * @param options Appearance configuration options
    * @returns A new builder instance with appearance configuration
    */
-  withAppearance(options: {
+  setAppearance(options: {
     layout?: 'vertical' | 'horizontal' | null;
     formPosition?: 'left' | 'right';
     fullscreen?: boolean;
     modalTitle?: string;
     id?: string;
-  }): CheckoutBuilder;
+  }): Checkout;
   /**
    * Configures discount display settings.
    *
    * @param options Discount configuration options
    * @returns A new builder instance with discount configuration
    */
-  withDiscounts(options: {
+  setDiscounts(options: {
     annual?: boolean;
     multisite?: boolean | 'auto';
     bundle?: boolean | 'maximize';
     showMonthlySwitch?: boolean;
-  }): CheckoutBuilder;
+  }): Checkout;
   /**
    * Configures billing cycle selector interface.
    *
@@ -13423,26 +13770,26 @@ declare class CheckoutBuilder {
    * @param defaultCycle Default billing cycle to select
    * @returns A new builder instance with billing cycle configuration
    */
-  withBillingCycle(defaultCycle: 'monthly' | 'annual' | 'lifetime', selector?: 'list' | 'responsive_list' | 'dropdown'): CheckoutBuilder;
+  setBillingCycle(defaultCycle: 'monthly' | 'annual' | 'lifetime', selector?: 'list' | 'responsive_list' | 'dropdown'): Checkout;
   /**
    * Sets the language/locale for the checkout.
    *
    * @param locale Language setting - 'auto', 'auto-beta', or specific locale like 'en_US'
    * @returns A new builder instance with locale configuration
    */
-  withLanguage(locale?: 'auto' | 'auto-beta' | string): CheckoutBuilder;
+  setLanguage(locale?: 'auto' | 'auto-beta' | string): Checkout;
   /**
    * Configures review and badge display settings.
    *
    * @param options Review and badge configuration
    * @returns A new builder instance with reviews and badges configuration
    */
-  withReviewsAndBadges(options: {
+  setSocialProofing(options: {
     showReviews?: boolean;
     reviewId?: number;
     showRefundBadge?: boolean;
     refundPolicyPosition?: 'below_form' | 'below_breakdown' | 'dynamic';
-  }): CheckoutBuilder;
+  }): Checkout;
   /**
    * Enhanced currency configuration.
    *
@@ -13451,7 +13798,7 @@ declare class CheckoutBuilder {
    * @param showInlineSelector Whether to show inline currency selector
    * @returns A new builder instance with currency configuration
    */
-  withCurrency(currency: 'usd' | 'eur' | 'gbp' | 'auto', defaultCurrency?: 'usd' | 'eur' | 'gbp', showInlineSelector?: boolean): CheckoutBuilder;
+  setCurrency(currency: 'usd' | 'eur' | 'gbp' | 'auto', defaultCurrency?: 'usd' | 'eur' | 'gbp', showInlineSelector?: boolean): Checkout;
   /**
    * Configures navigation and cancel behavior.
    *
@@ -13459,35 +13806,141 @@ declare class CheckoutBuilder {
    * @param cancelIcon Custom cancel icon URL
    * @returns A new builder instance with navigation configuration
    */
-  withNavigation(cancelUrl?: string, cancelIcon?: string): CheckoutBuilder;
+  setCancelButton(cancelUrl?: string, cancelIcon?: string): Checkout;
   /**
    * Associates purchases with an affiliate account.
    *
    * @param userId Affiliate user ID
    * @returns A new builder instance with affiliate configuration
    */
-  withAffiliate(userId: number): CheckoutBuilder;
+  setAffiliate(userId: number): Checkout;
   /**
    * Sets a custom image/icon for the checkout.
    *
    * @param imageUrl Secure HTTPS URL to the image
    * @returns A new builder instance with custom image
    */
-  withImage(imageUrl: string): CheckoutBuilder;
+  setImage(imageUrl: string): Checkout;
   /**
    * Configures the checkout for license renewal.
    *
    * @param licenseKey The license key to renew
    * @returns A new builder instance configured for renewal
    */
-  forRenewal(licenseKey: string): CheckoutBuilder;
+  setLicenseRenewal(licenseKey: string): Checkout;
   /**
    * Builds and returns the final checkout options to be used with the `@freemius/checkout` package.
    *
+   * @note - This is async by purpose so that we can allow for future enhancements that might require async operations.
+   *
    * @returns The constructed CheckoutOptions object
    */
-  toOptions(additionalOptions?: Omit<CheckoutPopupParams, 'plugin_id'> & CheckoutPopupArbitraryParams): CheckoutOptions;
-  toLink(): string;
+  getOptions(): CheckoutOptions;
+  /**
+   * Generates a checkout link based on the current builder state.
+   *
+   * @note - This is async by purpose so that we can allow for future enhancements that might require async operations.
+   */
+  getLink(): string;
+  serialize(): CheckoutSerialized;
+  private getBaseUrl;
+}
+//#endregion
+//#region src/models/PurchaseInfo.d.ts
+declare class PurchaseInfo implements PurchaseData {
+  readonly email: string;
+  readonly firstName: string;
+  readonly lastName: string;
+  readonly userId: string;
+  readonly planId: string;
+  readonly pricingId: string;
+  readonly licenseId: string;
+  readonly expiration: Date | null;
+  readonly canceled: boolean;
+  readonly subscriptionId: string | null;
+  readonly billingCycle: BILLING_CYCLE | null;
+  readonly quota: number | null;
+  readonly initialAmount: number | null;
+  readonly renewalAmount: number | null;
+  readonly currency: CURRENCY | null;
+  readonly renewalDate: Date | null;
+  readonly paymentMethod: 'card' | 'paypal' | 'ideal' | null;
+  readonly created: Date;
+  constructor(user: UserEntity, license: LicenseEntity, subscription: SubscriptionEntity | null);
+  isPlan(planId: FSId): boolean;
+  isFromPlans(planIds: FSId[]): boolean;
+  toData(): PurchaseData;
+  /**
+   * A convenience method to convert the purchase info to a format suitable for database storage.
+   */
+  toEntitlementRecord<T extends Record<string, unknown>>(additionalData?: T): PurchaseEntitlementData & T;
+  get isActive(): boolean;
+  isSubscription(): boolean;
+  isAnnual(): boolean;
+  isMonthly(): boolean;
+  isOneOff(): boolean;
+  getPlanTitle(pricingData: PricingTableData | null): string;
+}
+//#endregion
+//#region src/services/PurchaseService.d.ts
+declare class PurchaseService {
+  private readonly api;
+  constructor(api: ApiService);
+  /**
+   * Retrieve purchase information from the Freemius API based on the license ID.
+   *
+   * The license is the primary entitlement for a purchase, and it may or may not be associated with a subscription.
+   * With this method, you can retrieve detailed information about the purchase, including user details, plan, expiration, and more.
+   */
+  retrievePurchase(licenseId: FSId): Promise<PurchaseInfo | null>;
+  /**
+   * A helper method to retrieve raw purchase data instead of a full PurchaseInfo object.
+   *
+   * This is useful when passing data from server to client in frameworks like Next.js, where only serializable data should be sent.
+   */
+  retrievePurchaseData(licenseId: FSId): Promise<PurchaseData | null>;
+  retrievePurchases(userOrEntity: FSId | UserEntity, pagination?: PagingOptions): Promise<PurchaseInfo[]>;
+  retrievePurchasesData(userOrEntity: FSId | UserEntity, pagination?: PagingOptions): Promise<PurchaseData[]>;
+  /**
+   * Retrieve a list of active subscriptions for a user. You can use this method to find or sync subscriptions from freemius to your system.
+   */
+  retrieveSubscriptions(userOrEntity: FSId | UserEntity, pagination?: PagingOptions): Promise<PurchaseInfo[]>;
+  /**
+   * Retrieve a list of purchase data for a user.
+   *
+   * This is a convenience method that returns the purchase data in a format suitable for client-side rendering or serialization.
+   */
+  retrieveSubscriptionsData(userId: FSId, pagination?: PagingOptions): Promise<PurchaseData[]>;
+  retrieveBySubscription(subscription: SubscriptionEntity, subscriptionUser?: UserEntity): Promise<PurchaseInfo | null>;
+  retrieveSubscriptionsByEmail(email: string, pagination?: PagingOptions): Promise<PurchaseInfo[]>;
+  retrievePurchasesByEmail(email: string, pagination?: PagingOptions): Promise<PurchaseInfo[]>;
+}
+//#endregion
+//#region src/services/PricingService.d.ts
+declare class PricingService {
+  private readonly api;
+  constructor(api: ApiService);
+  retrieve(topupPlanId?: FSId): Promise<PricingData>;
+  findTopupPlan(plans?: PortalPlans, planId?: FSId): PortalPlans[number] | null;
+  private isValidPricing;
+}
+//#endregion
+//#region src/checkout/PricingRetriever.d.ts
+declare class PricingRetriever implements CheckoutAction {
+  private readonly pricing;
+  constructor(pricing: PricingService);
+  canHandle(request: Request): boolean;
+  processAction(request: Request): Promise<Response>;
+}
+//#endregion
+//#region src/checkout/PurchaseProcessor.d.ts
+type PurchaseCallback = (purchase: PurchaseInfo) => Promise<Response | void>;
+declare class PurchaseProcessor implements CheckoutAction {
+  private readonly purchase;
+  private readonly callback?;
+  constructor(purchase: PurchaseService, callback?: PurchaseCallback | undefined);
+  canHandle(request: Request): boolean;
+  processAction(request: Request): Promise<Response>;
 }
 //#endregion
 //#region src/models/CheckoutRedirectInfo.d.ts
@@ -13512,12 +13965,95 @@ declare class CheckoutRedirectInfo implements CheckoutRedirectData {
   toData(): CheckoutRedirectData;
 }
 //#endregion
+//#region src/checkout/RedirectProcessor.d.ts
+type RedirectCallback = (info: CheckoutRedirectInfo) => Promise<Response | void>;
+declare class RedirectProcessor implements CheckoutAction {
+  private readonly secretKey;
+  private readonly proxyUrl?;
+  private readonly callback?;
+  private readonly afterProcessUrl?;
+  constructor(secretKey: string, proxyUrl?: string | undefined, callback?: RedirectCallback | undefined, afterProcessUrl?: string | undefined);
+  canHandle(request: Request): boolean;
+  processAction(request: Request): Promise<Response>;
+  getRedirectInfo(currentUrl: string): Promise<CheckoutRedirectInfo | null>;
+  getCleanUrl(url: string): string;
+}
+//#endregion
+//#region src/checkout/CheckoutRequestProcessor.d.ts
+type CheckoutRequestConfig = {
+  /**
+   * The real public/proxy URL where the application is accessible from the internet.
+   * This is useful for authenticating the Checkout Redirection requests.
+   */
+  proxyUrl?: string;
+  /**
+   * The function to be called when a purchase is made.
+   */
+  onPurchase?: PurchaseCallback;
+  /**
+   * The function to be called when a redirect is made after checkout.
+   */
+  onRedirect?: RedirectCallback;
+  /**
+   * Specifies a URL to redirect to after processing the redirect action. If not provided, it will redirect to the `proxyUrl` or the original request URL.
+   */
+  afterProcessUrl?: string;
+};
+declare class CheckoutRequestProcessor implements RequestProcessor<CheckoutRequestConfig> {
+  private readonly purchase;
+  private readonly pricing;
+  private readonly secretKey;
+  constructor(purchase: PurchaseService, pricing: PricingService, secretKey: string);
+  createProcessor(config: CheckoutRequestConfig): (request: Request) => Promise<Response>;
+  process(config: CheckoutRequestConfig, request: Request): Promise<Response>;
+  /**
+   * Processes the redirect from Freemius Checkout.
+   *
+   * This method verifies the signature in the URL and returns a CheckoutRedirectInfo object if successful.
+   *
+   * For nextjs like applications, make sure to replace the URL from the `Request` object with the right hostname to take care of the proxy.
+   *
+   * For example, if you have put the nextjs application behind nginx proxy (or ngrok during local development), then nextjs will still see the `request.url` as `https://localhost:3000/...`.
+   * In this case, you should replace it with the actual URL of your application, like `https://xyz.ngrok-free.app/...`.
+   *
+   * @example
+   * ```ts
+   * export async function GET(request: Request) {
+   *     // Replace the URL with the actual hostname of your application
+   *     // This is important for the signature verification to work correctly.
+   *     const data = await freemius.checkout.action.getRedirectProcessor({
+   *          proxyUrl: 'https://xyz.ngrok-free.app',
+   *          async callback(info) {
+   *              // Handle the redirect info here, like creating a license, etc.
+   *              // Return a Response object to override the default redirect behavior.
+   *              return Response.redirect('/custom-success-page', 302);
+   *          },
+   *      });
+   *
+   *     return data.processAction(request);
+   * }
+   * ```
+   */
+  getRedirectProcessor(config: {
+    proxyUrl?: string | undefined;
+    callback?: RedirectCallback | undefined;
+    afterProcessUrl?: string | undefined;
+  }): RedirectProcessor;
+  getPurchaseProcessor(config: {
+    callback?: PurchaseCallback | undefined;
+  }): PurchaseProcessor;
+  getPricingRetriever(): PricingRetriever;
+}
+//#endregion
 //#region src/services/CheckoutService.d.ts
 declare class CheckoutService {
   private readonly productId;
   private readonly publicKey;
   private readonly secretKey;
-  constructor(productId: FSId, publicKey: string, secretKey: string);
+  private readonly purchase;
+  private readonly pricing;
+  readonly request: CheckoutRequestProcessor;
+  constructor(productId: FSId, publicKey: string, secretKey: string, purchase: PurchaseService, pricing: PricingService);
   /**
    * Use this to build a Checkout for your product.
    * You can build a Checkout link or options for the popup.
@@ -13529,63 +14065,28 @@ declare class CheckoutService {
    * @example
    * Basic usage:
    * ```typescript
-   * const options = freemius.checkout.params()
-   *   .withUser(session?.user)
-   *   .inSandbox()
-   *   .withRecommendation()
-   *   .toOptions(); // Or .toLink() for a hosted checkout link
+   * const checkout = await freemius.checkout.create({user: session?.user})
+   *   .getOptions(); // Or .getLink() for a hosted checkout link
    * ```
    *
    * @example
-   * Advanced configuration:
+   * Advanced configuration: You can also skip the convenience options and rather use the builder directly to configure the checkout.
+   *
    * ```typescript
-   * const checkoutOptions = freemius.checkout.params()
-   *   .withUser(user, true)
-   *   .withPlan('1234')
-   *   .withQuota(5)
-   *   .withCurrency('eur')
-   *   .withCoupon({
+   * const checkout = freemius.checkout.create()
+   *   .setUser(user, true)
+   *   .setPlan('1234')
+   *   .setCoupon({
    *     code: 'DISCOUNT2023',
    *     hideUI: false
    *   })
-   *   .inTrial('paid')
-   *   .withAppearance({
-   *     layout: 'horizontal',
-   *     formPosition: 'left',
-   *     fullscreen: true,
-   *     modalTitle: 'Upgrade Now'
-   *   })
-   *   .withDiscounts({
-   *     annual: true,
-   *     multisite: 'auto',
-   *     bundle: 'maximize',
-   *     showMonthlySwitch: true
-   *   })
-   *   .withReviewsAndBadges({
-   *     showReviews: true,
-   *     showRefundBadge: true,
-   *     refundPolicyPosition: 'below_form'
-   *   })
-   *   .withBillingCycle('dropdown', 'annual')
-   *   .withLocale('en_US')
-   *   .withAffiliate(12345)
-   *   .inSandbox()
-   *   .toOptions();
+   *   .setSandbox()
+   *   .getOptions();
    * ```
-   */
-  create(withRecommendation?: boolean): CheckoutBuilder;
-  /**
-   * Convenience method to create checkout options for a specific user with or without sandbox mode.
    *
-   * Useful for generating recommended checkout options for SaaS.
-   */
-  createUserOptions(user: CheckoutBuilderUserOptions, isSandbox?: boolean): CheckoutOptions;
-  /**
-   * Convenience method to create a checkout link for a specific user with or without sandbox mode.
-   *
-   * Useful for generating recommended checkout links for SaaS.
+   * @example
    */
-  createUserLink(user: CheckoutBuilderUserOptions, isSandbox?: boolean): string;
+  create(options?: CheckoutBuilderOptions): Promise<Checkout>;
   /**
    * Retrieves the sandbox parameters for the checkout.
    *
@@ -13598,110 +14099,268 @@ declare class CheckoutService {
    */
   getSandboxParams(): Promise<NonNullable<CheckoutPopupParams['sandbox']>>;
   /**
-   * Processes the redirect from Freemius Checkout.
+   * Processes a redirect URL and returns the checkout redirect information if valid.
    *
-   * This method verifies the signature in the URL and returns a CheckoutRedirectInfo object if successful.
+   * This is useful for handling redirects from the checkout portal back to your application.
    *
-   * For nextjs like applications, make sure to replace the URL from the `Request` object with the right hostname to take care of the proxy.
+   * @param url The current URL to process.
+   * @param proxyUrl Optional proxy URL to replace parts of the URL for signature verification.
    *
-   * For example, if you have put the nextjs application behind nginx proxy (or ngrok during local development), then nextjs will still see the `request.url` as `https://localhost:3000/...`.
-   * In this case, you should replace it with the actual URL of your application, like `https://xyz.ngrok-free.app/...`.
+   * @returns A promise that resolves to the checkout redirect information or null if invalid.
    *
    * @example
-   * ```ts
-   * export async function GET(request: Request) {
-   *     // Replace the URL with the actual hostname of your application
-   *     // This is important for the signature verification to work correctly.
-   *     const data = await freemius.checkout.processRedirect(
-   *         request.url.replace('https://localhost:3000', 'https://xyz.ngrok-free.app')
-   *     );
+   * ```typescript
+   * const redirectInfo = await freemius.checkout.processRedirect(window.location.href);
+   *
+   * if (redirectInfo) {
+   *   // Handle valid redirect info
+   * } else {
+   *   // Handle invalid or missing redirect info
    * }
    * ```
    */
-  processRedirect(currentUrl: string): Promise<CheckoutRedirectInfo | null>;
-  private getCleanUrl;
+  processRedirect(url: string, proxyUrl?: string): Promise<CheckoutRedirectInfo | null>;
 }
 //#endregion
-//#region src/services/CustomerPortalService.d.ts
-declare class CustomerPortalService {
-  private readonly api;
-  private readonly checkout;
-  constructor(api: ApiService, checkout: CheckoutService);
+//#region src/services/AuthService.d.ts
+declare class AuthService {
+  private readonly productId;
+  private readonly secretKey;
+  private static readonly TOKEN_SEPARATOR;
+  private static readonly DEFAULT_EXPIRY_MINUTES;
+  constructor(productId: FSId, secretKey: string);
   /**
-   * Retrieves the customer portal data for a user, including subscriptions, billing, and payments.
+   * Creates a secure token for a specific action that can be performed by a user.
    *
-   * @param userId The ID of the user for whom to retrieve portal data.
-   * @param primaryLicenseId Optional primary license ID to include in the portal data. If present then the `primary` field will be populated with related information which our `@freemius/saas-starter` package uses to display the primary purchase information.
+   * @param action The action identifier (e.g., 'download_invoice', 'update_billing')
+   * @param userId The ID of the user who can perform this action
+   * @param expiryMinutes Optional expiry time in minutes (default: 60 minutes)
+   * @returns A secure token string
    */
-  retrieveData(userId: FSId, primaryLicenseId?: FSId | null, sandbox?: boolean): Promise<PortalData | null>;
+  createActionToken(action: string, userId: FSId, expiryMinutes?: number): string;
   /**
-   * @todo - Implement this method to handle actions like get cancel coupon, cancel subscription, update billing, get upgrade auth for Checkout etc.
+   * Verifies and validates an action token.
+   *
+   * @param token The token to verify
+   * @param action The expected action
+   * @param userId The expected user ID
+   * @returns true if valid, false otherwise
    */
-  private getPlanTitleById;
-  private getPricingById;
+  verifyActionToken(token: string, action: string, userId: FSId): boolean;
+  private encodeTokenPayload;
+  private decodeTokenPayload;
+  private signData;
+  private constantTimeEqual;
 }
 //#endregion
-//#region src/models/PurchaseInfo.d.ts
-declare class PurchaseInfo implements PurchaseData {
-  readonly email: string;
-  readonly firstName: string;
-  readonly lastName: string;
-  readonly userId: string;
-  readonly planId: string;
-  readonly pricingId: string;
-  readonly licenseId: string;
-  readonly expiration: Date | null;
-  readonly canceled: boolean;
-  readonly subscriptionId: string | null;
-  readonly billingCycle: BILLING_CYCLE | null;
-  readonly quota: number | null;
-  readonly initialAmount: number | null;
-  readonly renewalAmount: number | null;
-  readonly currency: CURRENCY | null;
-  readonly renewalDate: Date | null;
-  readonly paymentMethod: 'card' | 'paypal' | 'ideal' | null;
-  readonly created: Date;
-  constructor(user: UserEntity, license: LicenseEntity, subscription: SubscriptionEntity | null);
-  isPlan(planId: FSId): boolean;
-  isFromPlans(planIds: FSId[]): boolean;
-  toData(): PurchaseData;
-  get isActive(): boolean;
-  hasSubscription(): boolean;
-  isAnnual(): boolean;
-  isMonthly(): boolean;
-  isOneOff(): boolean;
-  getPlanTitle(pricingData: PricingTableData | null): string;
+//#region src/customer-portal/BillingAction.d.ts
+declare const schema$2: zod.ZodObject<{
+  business_name: zod.ZodOptional<zod.ZodString>;
+  tax_id: zod.ZodOptional<zod.ZodString>;
+  phone: zod.ZodOptional<zod.ZodString>;
+  address_apt: zod.ZodOptional<zod.ZodString>;
+  address_street: zod.ZodOptional<zod.ZodString>;
+  address_city: zod.ZodOptional<zod.ZodString>;
+  address_state: zod.ZodOptional<zod.ZodString>;
+  address_country_code: zod.ZodOptional<zod.ZodString>;
+  address_zip: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strip>;
+type BillingRequest = zod.infer<typeof schema$2>;
+declare class BillingAction implements PortalAction {
+  private readonly api;
+  private readonly auth;
+  private readonly actionName;
+  constructor(api: ApiService, auth: AuthService);
+  private createAction;
+  createAuthenticatedUrl(id: string, userId: string, endpoint: string): string;
+  verifyAuthentication(request: Request): boolean;
+  canHandle(request: Request): boolean;
+  processAction(request: Request): Promise<Response>;
 }
 //#endregion
-//#region src/services/PurchaseService.d.ts
-declare class PurchaseService {
+//#region src/customer-portal/InvoiceAction.d.ts
+declare class InvoiceAction implements PortalAction {
   private readonly api;
-  constructor(api: ApiService);
+  private readonly auth;
+  private readonly actionName;
+  constructor(api: ApiService, auth: AuthService);
+  private createAction;
+  createAuthenticatedUrl(id: string, userId: string, endpoint: string): string;
+  verifyAuthentication(request: Request): boolean;
+  canHandle(request: Request): boolean;
+  processAction(request: Request): Promise<Response>;
+}
+//#endregion
+//#region src/customer-portal/SubscriptionCancellationAction.d.ts
+declare const schema$1: zod.ZodObject<{
+  feedback: zod.ZodOptional<zod.ZodString>;
+  reason_ids: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+    1: "1";
+    2: "2";
+    3: "3";
+    4: "4";
+    5: "5";
+    6: "6";
+    7: "7";
+    8: "8";
+    9: "9";
+    10: "10";
+    11: "11";
+    12: "12";
+    13: "13";
+    14: "14";
+    15: "15";
+  }>>>;
+}, zod.z.core.$strip>;
+type SubscriptionCancellationRequest = zod.infer<typeof schema$1>;
+declare class SubscriptionCancellationAction implements PortalAction {
+  private readonly api;
+  private readonly auth;
+  private readonly actionName;
+  constructor(api: ApiService, auth: AuthService);
+  private createAction;
+  createAuthenticatedUrl(id: string, userId: FSId, endpoint: string): string;
+  verifyAuthentication(request: Request): boolean;
+  canHandle(request: Request): boolean;
+  processAction(request: Request): Promise<Response>;
+}
+//#endregion
+//#region src/customer-portal/SubscriptionRenewalCouponAction.d.ts
+declare const schema: zod.ZodObject<{
+  couponId: zod.ZodString;
+}, zod.z.core.$strip>;
+type ApplyRenewalCouponRequest = zod.infer<typeof schema>;
+declare class SubscriptionRenewalCouponAction implements PortalAction {
+  private readonly api;
+  private readonly auth;
+  private readonly actionName;
+  constructor(api: ApiService, auth: AuthService);
+  private createAction;
+  createAuthenticatedUrl(id: string, userId: FSId, endpoint: string): string;
+  verifyAuthentication(request: Request): boolean;
+  canHandle(request: Request): boolean;
+  processAction(request: Request): Promise<Response>;
+}
+//#endregion
+//#region src/customer-portal/CustomerPortalActionService.d.ts
+declare class CustomerPortalActionService {
+  private readonly api;
+  private readonly authService;
+  readonly invoice: InvoiceAction;
+  readonly billing: BillingAction;
+  readonly renewalCoupon: SubscriptionRenewalCouponAction;
+  readonly cancelRenewal: SubscriptionCancellationAction;
+  constructor(api: ApiService, authService: AuthService);
+  getAllHandlers(): PortalAction[];
+}
+//#endregion
+//#region src/customer-portal/PortalDataRepository.d.ts
+type CustomerPortalDataOption = {
   /**
-   * Retrieve purchase information from the Freemius API based on the license ID.
-   *
-   * The license is the primary entitlement for a purchase, and it may or may not be associated with a subscription.
-   * With this method, you can retrieve detailed information about the purchase, including user details, plan, expiration, and more.
+   * The API endpoint for which secure authenticated signed URLs will be created where the customer portal will send requests to fetch additional data (e.g., invoices, licenses, subscriptions). This should be an endpoint in your SaaS application that you will implement to handle these requests.
    */
-  retrievePurchase(licenseId: FSId): Promise<PurchaseInfo | null>;
+  endpoint: string;
   /**
-   * A helper method to retrieve raw purchase data instead of a full PurchaseInfo object.
-   *
-   * This is useful when passing data from server to client in frameworks like Next.js, where only serializable data should be sent.
+   * ID of the primary licenses, in case your software has pricing model supporting multiple active subscriptions. If not provided the first active subscription will be used instead.
    */
-  retrievePurchaseData(licenseId: FSId): Promise<PurchaseData | null>;
+  primaryLicenseId?: FSId | null;
   /**
-   * Retrieve a list of active subscriptions for a user. You can use this method to find or sync subscriptions from freemius to your system.
+   * Whether to create actions in sandbox mode (For example Checkout, Upgrade etc).
    */
-  retrieveSubscriptions(userId: FSId, pagination?: PagingOptions): Promise<PurchaseInfo[]>;
+  sandbox?: boolean;
+};
+type CustomerPortalDataWithUserOption = {
   /**
-   * Retrieve a list of purchase data for a user.
+   * ID of the user from Freemius.
+   */
+  userId: FSId;
+} & CustomerPortalDataOption;
+type CustomerPortalDataWithEmailOption = {
+  /**
+   * The email address of the user from Freemius.
+   */
+  email: string;
+} & CustomerPortalDataOption;
+declare class PortalDataRepository {
+  private readonly api;
+  private readonly action;
+  private readonly checkout;
+  constructor(api: ApiService, action: CustomerPortalActionService, checkout: CheckoutService);
+  retrievePortalDataByEmail(config: CustomerPortalDataWithEmailOption): Promise<PortalData | null>;
+  retrievePortalDataByUserId(config: CustomerPortalDataWithUserOption): Promise<PortalData | null>;
+  retrievePortalData(config: {
+    user: UserEntity;
+    endpoint: string;
+    primaryLicenseId?: FSId | null;
+    sandbox?: boolean;
+  }): Promise<PortalData | null>;
+  retrieveApiData(userId: FSId): Promise<{
+    pricingData: PricingTableData;
+    subscriptions: UserSubscriptionEntity[];
+    payments: PaymentEntity[];
+    billing: BillingEntity | null;
+    coupons: CouponEntityEnriched[] | null;
+  } | null>;
+  getPayments(payments: PaymentEntity[], plans: Map<string, PlanEntity>, pricings: Map<string, PricingEntity>, userId: FSId, endpoint: string): PortalPayment[];
+  getPlansById(pricingData: PricingTableData): Map<string, PlanEntity>;
+  getPricingById(pricingData: PricingTableData): Map<string, PricingEntity>;
+  getBilling(billing: BillingEntity | null, userId: FSId, endpoint: string): PortalBilling;
+  getSubscriptions(subscriptions: UserSubscriptionEntity[], plans: Map<string, PlanEntity>, pricings: Map<string, PricingEntity>, primaryLicenseId: (FSId | null) | undefined, endpoint: string): Promise<PortalSubscriptions>;
+  /**
+   * Check if coupon application is impossible due to certain conditions.
+   * This function can be used to determine if a coupon can be applied to a subscription.
+   * Introduced initially for PayPal subscriptions with a renewal date less than 48 hours in the future.
    *
-   * This is a convenience method that returns the purchase data in a format suitable for client-side rendering or serialization.
+   * @author @DanieleAlessandra
+   * @author @swashata (Ported to SDK)
+   *
+   * @returns boolean
    */
-  retrieveSubscriptionsData(userId: FSId, pagination?: PagingOptions): Promise<PurchaseData[]>;
-  retrieveBySubscription(subscription: SubscriptionEntity, subscriptionUser?: UserEntity): Promise<PurchaseInfo | null>;
-  retrieveActiveSubscriptionByEmail(email: string, pagination?: PagingOptions): Promise<PurchaseInfo[] | null>;
+  isRenewalCancellationCouponApplicable(subscription: UserSubscriptionEntity): boolean;
+}
+//#endregion
+//#region src/customer-portal/PurchaseRestorer.d.ts
+type RestoreCallback = (purchases: PurchaseInfo[]) => Promise<Response | void>;
+//#endregion
+//#region src/customer-portal/PortalRequestProcessor.d.ts
+type PortalRequestConfig = {
+  getUser: UserRetriever;
+  onRestore?: RestoreCallback;
+  restoreSubscriptionsOnly?: boolean;
+  isSandbox?: boolean;
+  portalEndpoint: string;
+};
+declare class PortalRequestProcessor implements RequestProcessor<PortalRequestConfig> {
+  private readonly repository;
+  private readonly action;
+  private readonly purchase;
+  constructor(repository: PortalDataRepository, action: CustomerPortalActionService, purchase: PurchaseService);
+  createProcessor(config: PortalRequestConfig): (request: Request) => Promise<Response>;
+  /**
+   * Process actions done by the user in the customer portal.
+   */
+  process(config: PortalRequestConfig, request: Request): Promise<Response>;
+}
+//#endregion
+//#region src/services/CustomerPortalService.d.ts
+declare class CustomerPortalService {
+  private readonly api;
+  private readonly checkout;
+  private readonly authService;
+  private readonly purchase;
+  private readonly repository;
+  readonly action: CustomerPortalActionService;
+  readonly request: PortalRequestProcessor;
+  constructor(api: ApiService, checkout: CheckoutService, authService: AuthService, purchase: PurchaseService);
+  /**
+   * Retrieves the customer portal data for a user, including subscriptions, billing, and payments.
+   */
+  retrieveData(option: CustomerPortalDataWithUserOption): Promise<PortalData | null>;
+  retrieveDataByEmail(option: CustomerPortalDataWithEmailOption): Promise<PortalData | null>;
+  /**
+   * Creates a restorer function that processes an array of purchases by invoking the provided callback for each purchase.
+   */
+  createRestorer(callback: (purchase: PurchaseInfo) => Promise<void>): (purchases: PurchaseInfo[]) => Promise<void>;
 }
 //#endregion
 //#region src/webhook/license.events.d.ts
@@ -13739,6 +14398,8 @@ interface LicenseEventDataMap {
       to: string;
       /** Unique identifier for the license */
       license_id: string;
+      /** Determines if the license was renewed due to the renewal of the associated subscription */
+      is_renewal?: boolean;
     };
   };
   'license.shortened': {
@@ -13907,16 +14568,32 @@ interface SubscriptionEventDataMap {
 }
 //#endregion
 //#region src/webhook/events.d.ts
-interface EventDataMap extends LicenseEventDataMap, SubscriptionEventDataMap {}
-type FreemiusEventType = keyof EventDataMap;
-type FreemiusEvent<T extends FreemiusEventType = FreemiusEventType> = {
+/**
+ * We unify all event data maps into a single map for easier reference.
+ */
+interface WebhookEventDataMap extends LicenseEventDataMap, SubscriptionEventDataMap {}
+/**
+ * All possible webhook event types. For example `'license.created'`, `subscription.created`, etc.
+ */
+type WebhookEventType = keyof WebhookEventDataMap;
+/**
+ * The structure of a webhook event received from Freemius.
+ *
+ * The `data` and `objects` properties are dynamically typed based on the event type.
+ *
+ * @template T The type of the webhook event.
+ */
+type WebhookEvent<T extends WebhookEventType = WebhookEventType> = {
   id: string;
   type: T;
   created: string;
   updated: string | null;
   state: NonNullable<EventEntity['state']>;
-} & EventDataMap[T];
-type EventHandler<T extends FreemiusEventType> = (event: FreemiusEvent<T>) => Promise<void>;
+} & WebhookEventDataMap[T];
+/**
+ * A handler function for a specific webhook event type.
+ */
+type WebhookEventHandler<T extends WebhookEventType> = (event: WebhookEvent<T>) => Promise<void>;
 //#endregion
 //#region src/webhook/WebhookListener.d.ts
 interface NormalizedRequest {
@@ -13936,16 +14613,17 @@ declare class WebhookListener {
   private readonly onError;
   private eventHandlers;
   constructor(secretKey: string, onError?: (error: unknown) => void);
-  on<T extends FreemiusEventType>(type: T, handler: EventHandler<T>): this;
-  off<T extends FreemiusEventType>(type: T, handler: EventHandler<T>): this;
-  onMultiple<T extends FreemiusEventType>(handlers: Partial<Record<T, EventHandler<T>>>): this;
-  removeAll<T extends FreemiusEventType>(type: T): this;
-  getHandlerCount<T extends FreemiusEventType>(type: T): number;
+  on<T extends WebhookEventType>(type: T, handler: WebhookEventHandler<T>): this;
+  on<T extends WebhookEventType>(types: T[], handler: WebhookEventHandler<T>): this;
+  off<T extends WebhookEventType>(type: T, handler: WebhookEventHandler<T>): this;
+  off<T extends WebhookEventType>(types: T[], handler: WebhookEventHandler<T>): this;
+  removeAll<T extends WebhookEventType>(typeOrTypes: T | T[]): this;
+  getHandlerCount<T extends WebhookEventType>(type: T): number;
   getEventTypeCount(): number;
-  getRegisteredEventTypes(): FreemiusEventType[];
-  hasHandlers<T extends FreemiusEventType>(type: T): boolean;
-  hasHandler<T extends FreemiusEventType>(type: T, handler: EventHandler<T>): boolean;
-  getHandlers<T extends FreemiusEventType>(type: T): Set<EventHandler<FreemiusEventType>>;
+  getRegisteredEventTypes(): WebhookEventType[];
+  hasHandlers<T extends WebhookEventType>(type: T): boolean;
+  hasHandler<T extends WebhookEventType>(type: T, handler: WebhookEventHandler<T>): boolean;
+  getHandlers<T extends WebhookEventType>(type: T): Set<WebhookEventHandler<WebhookEventType>>;
   getTotalHandlerCount(): number;
   /**
    * Verify hex HMAC signature against the raw body.
@@ -13964,6 +14642,7 @@ declare class WebhookService {
   private readonly secretKey;
   constructor(secretKey: string);
   createListener(onError?: (error: unknown) => void): WebhookListener;
+  createRequestProcessor(listener: WebhookListener): (request: Request) => Promise<Response>;
   /**
    * WHATWG Fetch API adapter for modern JavaScript environments.
    *
@@ -14023,15 +14702,58 @@ declare class WebhookService {
   processNodeHttp(listener: WebhookListener, req: http0.IncomingMessage, res: http0.ServerResponse): Promise<void>;
 }
 //#endregion
+//#region src/services/EntitlementService.d.ts
+declare class EntitlementService {
+  /**
+   * Get the active subscription entitlement from a list of entitlements stored in your own database.
+   *
+   * @param entitlements - Array of entitlements to filter
+   * @returns The single active entitlement, or null if none found
+   * @throws Error if multiple active entitlements are found
+   */
+  getActive<T extends PurchaseEntitlementData>(entitlements: T[] | null): T | null;
+  /**
+   * Get all active subscription entitlements from a list of entitlements stored in your own database.
+   *
+   * @param entitlements - Array of entitlements to filter
+   * @returns Array of active entitlements, or null if none found
+   */
+  getActives<T extends PurchaseEntitlementData>(entitlements: T[] | null): T[] | null;
+  getFsUser(entitlement: PurchaseEntitlementData | null, email?: string): Awaited<ReturnType<UserRetriever>>;
+  /**
+   * Calculates the number of complete months elapsed since the entitlement subscription was created.
+   *
+   * @param entitlement - The entitlement to check
+   * @returns Number of complete months elapsed, or -1 if entitlement is null
+   */
+  getElapsedMonth(entitlement: PurchaseEntitlementData | null): number;
+  /**
+   * Calculates the number of complete years elapsed since the entitlement subscription was created.
+   *
+   * @param entitlement - The entitlement to check
+   * @returns Number of complete years elapsed, or -1 if entitlement is null
+   */
+  getElapsedYear(entitlement: PurchaseEntitlementData | null): number;
+}
+//#endregion
 //#region src/Freemius.d.ts
+type FreemiusConfig = {
+  productId: FSId;
+  apiKey: string;
+  secretKey: string;
+  publicKey: string;
+};
 declare class Freemius {
   readonly api: ApiService;
   readonly checkout: CheckoutService;
   readonly purchase: PurchaseService;
   readonly customerPortal: CustomerPortalService;
   readonly webhook: WebhookService;
-  constructor(productId: FSId, apiKey: string, secretKey: string, publicKey: string);
+  readonly pricing: PricingService;
+  readonly entitlement: EntitlementService;
+  private readonly auth;
+  constructor(config: FreemiusConfig);
 }
 //#endregion
-export { ApiAuthParams, ApiEntitiesFilter, type ApiService, BILLING_CYCLE, BillingCycleApiEnum, BillingEntity, CURRENCY, CheckoutRedirectData, type CheckoutService, CurrencyApiEnum, type CustomerPortalService, EventEntity, FSId, Freemius, InstallEntity, LicenseEntity, LicenseFilterOptions, PagingOptions, PaymentEntity, PaymentMethod, PortalData, PortalPayment, PortalPlans, PortalSubscription, PricingEntity, PricingTableData, ProductEntity, PurchaseData, PurchaseInfo, type PurchaseService, SellingUnit, SubscriptionEntity, SubscriptionFilterOptions, UserBillingEntity, UserEntity, UserFilterOptions, UserLicenseFilterOptions, UserPaymentFilterOptions, UserPluginEntity, UserSubscriptionFilterOptions, type WebhookService, idToNumber, idToString, isIdsEqual, parseBillingCycle, parseCurrency, parseDate, parseDateTime, parseNumber, parsePaymentMethod };
+export { ApiAuthParams, ApiEntitiesFilter, type ApiService, type ApplyRenewalCouponRequest, BILLING_CYCLE, BillingCycleApiEnum, BillingEntity, type BillingRequest, BillingUpdatePayload, CURRENCY, type Checkout, CheckoutAction, type CheckoutRequestConfig as CheckoutActionConfig, CheckoutBuilderOptions, CheckoutBuilderUserOptions, CheckoutRedirectData, type CheckoutRedirectInfo, type CheckoutSerialized, type CheckoutService, CouponEntityEnriched, CurrencyApiEnum, type CustomerPortalDataWithEmailOption, type CustomerPortalDataWithUserOption, type CustomerPortalService, EventEntity, FSId, Freemius, FreemiusConfig, InstallEntity, LicenseEntity, LicenseFilterOptions, PagingOptions, PaymentEntity, PaymentFilterOptions, PaymentMethod, PlanEntity, PortalAction, PortalBilling, PortalData, PortalPayment, PortalPlans, type PortalRequestConfig, PortalSubscription, PortalSubscriptions, PricingData, PricingEntity, type PricingService, PricingTableData, ProductEntity, PurchaseData, PurchaseEntitlementData, PurchaseEntitlementType, type PurchaseInfo, type PurchaseService, RequestProcessor, SellingUnit, SubscriptionCancellationReasonType, type SubscriptionCancellationRequest, SubscriptionCancellationResult, SubscriptionDiscountEntity, SubscriptionEntity, SubscriptionFilterOptions, SubscriptionRenewalCouponResult, UserBillingEntity, UserEntity, UserFilterOptions, UserLicenseFilterOptions, UserPaymentFilterOptions, UserPluginEntity, UserRetriever, UserSubscriptionEntity, UserSubscriptionFilterOptions, UserSubscriptionWithDiscounts, type WebhookEvent, type WebhookEventDataMap, type WebhookEventHandler, type WebhookEventType, type WebhookService, idToNumber, idToString, isIdsEqual, parseBillingCycle, parseCurrency, parseDate, parseDateTime, parseNumber, parsePaymentMethod };
 //# sourceMappingURL=index.d.mts.map