[2026-07-rc] Adding in types for purchaseType and recurringCycleLimit fields

Author: andrewmcgov

.changeset/add-purchase-type-and-recurring-cycle-limit.md

@@ -0,0 +1,5 @@
+---
+'@shopify/ui-extensions': minor
+---
+
+Add purchaseType and recurringCycleLimit subscribable fields to the DiscountsApi for discount function settings extensions.

packages/ui-extensions-tester/src/admin/README.md

@@ -64,6 +64,20 @@ extension.shopify.discounts.updateDiscountClasses =
     .mockReturnValue(
       createResult('updateDiscountClasses'),
     );
+
+extension.shopify.discounts.updatePurchaseType =
+  vi
+    .fn()
+    .mockReturnValue(
+      createResult('updatePurchaseType'),
+    );
+
+extension.shopify.discounts.updateRecurringCycleLimit =
+  vi
+    .fn()
+    .mockReturnValue(
+      createResult('updateRecurringCycleLimit'),
+    );
 ```
 
 ## 📂 Example
@@ -82,7 +96,9 @@ Creates a typed mock result for an admin mutation API.
 
 Supported mutations:
 
-| Mutation                  | Default                      |
-| ------------------------- | ---------------------------- |
-| `'applyMetafieldChange'`  | `{type: 'success'}`          |
-| `'updateDiscountClasses'` | `{success: true, value: []}` |
+| Mutation                      | Default                                       |
+| ----------------------------- | --------------------------------------------- |
+| `'applyMetafieldChange'`      | `{type: 'success'}`                           |
+| `'updateDiscountClasses'`     | `{success: true, value: []}`                  |
+| `'updatePurchaseType'`        | `{success: true, value: 'one_time_purchase'}` |
+| `'updateRecurringCycleLimit'` | `{success: true, value: null}`                |

packages/ui-extensions-tester/src/admin/factories.ts

@@ -260,6 +260,11 @@ function createDiscountFunctionSettingsMock<T extends ExtensionTarget>(
       discountClasses: createReadonlySignalLike([]),
       updateDiscountClasses: () => createResult('updateDiscountClasses'),
       discountMethod: createReadonlySignalLike('automatic' as const),
+      purchaseType: createReadonlySignalLike('one_time_purchase' as const),
+      updatePurchaseType: () => createResult('updatePurchaseType'),
+      recurringCycleLimit: createReadonlySignalLike(null),
+      updateRecurringCycleLimit: () =>
+        createResult('updateRecurringCycleLimit'),
     },
   };
 }

packages/ui-extensions-tester/src/admin/index.ts

@@ -58,13 +58,22 @@ export interface AdminMutationResults {
     | Awaited<ReturnType<ValidationApplyMetafieldChange>>
     | Awaited<ReturnType<DiscountApplyMetafieldChange>>;
   updateDiscountClasses: ReturnType<DiscountsApi['updateDiscountClasses']>;
+  updatePurchaseType: ReturnType<DiscountsApi['updatePurchaseType']>;
+  updateRecurringCycleLimit: ReturnType<
+    DiscountsApi['updateRecurringCycleLimit']
+  >;
 }
 
 const adminMutationDefaults: {
   [K in keyof AdminMutationResults]: () => AdminMutationResults[K];
 } = {
   applyMetafieldChange: () => ({type: 'success'}),
   updateDiscountClasses: () => ({success: true as const, value: []}),
+  updatePurchaseType: () => ({
+    success: true as const,
+    value: 'one_time_purchase' as const,
+  }),
+  updateRecurringCycleLimit: () => ({success: true as const, value: null}),
 };
 
 /**

packages/ui-extensions/src/surfaces/admin/api/discount-function-settings/launch-options.ts

@@ -34,6 +34,12 @@ export type DiscountClass = 'product' | 'order' | 'shipping';
  */
 export type DiscountMethod = 'automatic' | 'code';
 
+/**
+ * The purchase type that determines which purchases the discount applies to. Use `'one_time_purchase'` for one-time purchases only, `'subscription'` for subscription purchases only, or `'both'` for both.
+ * @publicDocs
+ */
+export type PurchaseType = 'one_time_purchase' | 'subscription' | 'both';
+
 /**
  * The `data` object exposed to discount function settings extensions in the `admin.discount-details.function-settings.render` target. Use this to access the current discount configuration and populate your settings interface with existing values.
  * @publicDocs
@@ -62,4 +68,20 @@ export interface DiscountsApi {
    * A signal that contains the discount method (`'automatic'` or `'code'`). Read this to determine whether the discount applies automatically at checkout or requires a customer-entered code.
    */
   discountMethod: ReadonlySignalLike<DiscountMethod>;
+  /**
+   * A signal that contains the purchase type. Read this to determine whether the discount applies to one-time purchases, subscriptions, or both.
+   */
+  purchaseType: ReadonlySignalLike<PurchaseType>;
+  /**
+   * A function that updates the purchase type to change which types of purchases the discount applies to. Call this with a `PurchaseType` value (`'one_time_purchase'`, `'subscription'`, or `'both'`).
+   */
+  updatePurchaseType: UpdateSignalFunction<PurchaseType>;
+  /**
+   * A signal that contains the recurring cycle limit for subscription purchases. A positive integer limits how many billing cycles the discount applies for. Both `0` and `null` mean unlimited (no limit). `null` is the default when no value has been explicitly set.
+   */
+  recurringCycleLimit: ReadonlySignalLike<number | null>;
+  /**
+   * A function that updates the recurring cycle limit for subscription purchases. Pass a positive integer to limit the number of billing cycles, `0` or `null` to remove the limit.
+   */
+  updateRecurringCycleLimit: UpdateSignalFunction<number | null>;
 }