@openmeter/sdk 1.0.0-beta-ef4f3399d89d → 1.0.0-beta-201274f79c65

package/dist/cjs/src/client/schemas.d.cts

@@ -7800,37 +7800,9 @@ export interface components {
             metadata?: components['schemas']['Metadata'];
             /**
              * Addon
-             * @description Partially populated add-on properties.
+             * @description Add-on object.
              */
-            addon: {
-                /**
-                 * ID
-                 * @description The ID of the add-on.
-                 * @example 01G65Z755AFWAKHE12NY0CQ9FH
-                 */
-                id: string;
-                /**
-                 * Key
-                 * @description User provided unique identifier for add-on.
-                 */
-                readonly key: string;
-                /**
-                 * Display name
-                 * @description Human-readable name for add-on.
-                 */
-                name: string;
-                /**
-                 * Version
-                 * @description The version of the add-on which templates this instance.
-                 * @default 1
-                 */
-                readonly version: number;
-                /**
-                 * InstanceType
-                 * @description The instance type of the add-on.
-                 */
-                readonly instanceType: components['schemas']['AddonInstanceType'];
-            };
+            readonly addon: components['schemas']['Addon'];
             /**
              * The plan phase from the add-on becomes purchasable
              * @description The key of the plan phase from the add-on becomes available for purchase.
@@ -7867,16 +7839,11 @@ export interface components {
              */
             maxQuantity?: number;
             /**
-             * Addon
-             * @description The add-on to create.
+             * Add-on unique identifier
+             * @description The add-on unique identifier in ULID format.
+             * @example 01G65Z755AFWAKHE12NY0CQ9FH
              */
-            addon: {
-                /**
-                 * @description The ID of the add-on.
-                 * @example 01G65Z755AFWAKHE12NY0CQ9FH
-                 */
-                id: string;
-            };
+            addonId: string;
         };
         /**
          * @description Order by options for plan add-on assignments.
@@ -8080,6 +8047,9 @@ export interface components {
             metadata?: components['schemas']['Metadata'];
             /** @description The plan reference to change to. */
             plan: components['schemas']['PlanReferenceInput'];
+            /** @description The key of the phase to start the subscription in.
+             *     If not provided, the subscription will start in the first phase of the plan. */
+            startingPhase?: string;
             /** @description The name of the Subscription. If not provided the plan name is used. */
             name?: string;
             /** @description Description for the Subscription. */
@@ -8093,6 +8063,9 @@ export interface components {
             metadata?: components['schemas']['Metadata'];
             /** @description The plan reference to change to. */
             plan: components['schemas']['PlanReferenceInput'];
+            /** @description The key of the phase to start the subscription in.
+             *     If not provided, the subscription will start in the first phase of the plan. */
+            startingPhase?: string;
             /** @description The name of the Subscription. If not provided the plan name is used. */
             name?: string;
             /** @description Description for the Subscription. */
@@ -23111,7 +23084,12 @@ export interface operations {
         requestBody: {
             content: {
                 'application/json': {
+                    /** @description The version of the plan to migrate to.
+                     *     If not provided, the subscription will migrate to the latest version of the current plan. */
                     targetVersion?: number;
+                    /** @description The key of the phase to start the subscription in.
+                     *     If not provided, the subscription will start in the first phase of the plan. */
+                    startingPhase?: string;
                 };
             };
         };

package/dist/cjs/src/zod/index.cjs

@@ -8186,14 +8186,10 @@ exports.createPlanAddonParams = zod_1.z.object({
 exports.createPlanAddonBodyAddonIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
 exports.createPlanAddonBody = zod_1.z
     .object({
-    addon: zod_1.z
-        .object({
-        id: zod_1.z
-            .string()
-            .regex(exports.createPlanAddonBodyAddonIdRegExp)
-            .describe('The ID of the add-on.'),
-    })
-        .describe('The add-on to create.'),
+    addonId: zod_1.z
+        .string()
+        .regex(exports.createPlanAddonBodyAddonIdRegExp)
+        .describe('The add-on unique identifier in ULID format.'),
     fromPlanPhase: zod_1.z
         .string()
         .describe('The key of the plan phase from the add-on becomes available for purchase.'),
@@ -9361,6 +9357,11 @@ exports.createSubscriptionBody = zod_1.z
     })
         .describe('References an exact plan defaulting to the current active version.')
         .describe('The plan reference to change to.'),
+    startingPhase: zod_1.z
+        .string()
+        .min(1)
+        .optional()
+        .describe('The key of the phase to start the subscription in.\nIf not provided, the subscription will start in the first phase of the plan.'),
     timing: zod_1.z
         .enum(['immediate', 'next_billing_cycle'])
         .describe('Subscription edit timing.\nWhen immediate, the requested changes take effect immediately.\nWhen nextBillingCycle, the requested changes take effect at the next billing cycle.')
@@ -10890,6 +10891,11 @@ exports.changeSubscriptionBody = zod_1.z
     })
         .describe('References an exact plan defaulting to the current active version.')
         .describe('The plan reference to change to.'),
+    startingPhase: zod_1.z
+        .string()
+        .min(1)
+        .optional()
+        .describe('The key of the phase to start the subscription in.\nIf not provided, the subscription will start in the first phase of the plan.'),
     timing: zod_1.z
         .enum(['immediate', 'next_billing_cycle'])
         .describe('Subscription edit timing.\nWhen immediate, the requested changes take effect immediately.\nWhen nextBillingCycle, the requested changes take effect at the next billing cycle.')
@@ -11485,7 +11491,16 @@ exports.migrateSubscriptionParams = zod_1.z.object({
         .regex(exports.migrateSubscriptionPathSubscriptionIdRegExp),
 });
 exports.migrateSubscriptionBody = zod_1.z.object({
-    targetVersion: zod_1.z.number().min(1).optional(),
+    startingPhase: zod_1.z
+        .string()
+        .min(1)
+        .optional()
+        .describe('The key of the phase to start the subscription in.\nIf not provided, the subscription will start in the first phase of the plan.'),
+    targetVersion: zod_1.z
+        .number()
+        .min(1)
+        .optional()
+        .describe('The version of the plan to migrate to.\nIf not provided, the subscription will migrate to the latest version of the current plan.'),
 });
 /**
  * Restores a canceled subscription.

package/dist/cjs/src/zod/index.d.cts

@@ -13407,27 +13407,17 @@ export declare const createPlanAddonParams: zod.ZodObject<{
 }>;
 export declare const createPlanAddonBodyAddonIdRegExp: RegExp;
 export declare const createPlanAddonBody: zod.ZodObject<{
-    addon: zod.ZodObject<{
-        id: zod.ZodString;
-    }, "strip", zod.ZodTypeAny, {
-        id: string;
-    }, {
-        id: string;
-    }>;
+    addonId: zod.ZodString;
     fromPlanPhase: zod.ZodString;
     maxQuantity: zod.ZodOptional<zod.ZodNumber>;
     metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
 }, "strip", zod.ZodTypeAny, {
-    addon: {
-        id: string;
-    };
+    addonId: string;
     fromPlanPhase: string;
     metadata?: Record<string, string> | undefined;
     maxQuantity?: number | undefined;
 }, {
-    addon: {
-        id: string;
-    };
+    addonId: string;
     fromPlanPhase: string;
     metadata?: Record<string, string> | undefined;
     maxQuantity?: number | undefined;
@@ -14779,6 +14769,7 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
         key: string;
         version?: number | undefined;
     }>;
+    startingPhase: zod.ZodOptional<zod.ZodString>;
     timing: zod.ZodDefault<zod.ZodUnion<[zod.ZodEnum<["immediate", "next_billing_cycle"]>, zod.ZodDate]>>;
 }, "strip", zod.ZodTypeAny, {
     plan: {
@@ -14794,6 +14785,7 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
     alignment?: {
         billablesMustAlign?: boolean | undefined;
     } | undefined;
+    startingPhase?: string | undefined;
 }, {
     plan: {
         key: string;
@@ -14807,6 +14799,7 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
     alignment?: {
         billablesMustAlign?: boolean | undefined;
     } | undefined;
+    startingPhase?: string | undefined;
     timing?: Date | "immediate" | "next_billing_cycle" | undefined;
 }>, zod.ZodObject<{
     customerId: zod.ZodOptional<zod.ZodString>;
@@ -17794,19 +17787,19 @@ export declare const createSubscriptionAddonBody: zod.ZodObject<{
 }, "strip", zod.ZodTypeAny, {
     name: string;
     quantity: number;
+    timing: Date | "immediate" | "next_billing_cycle";
     addon: {
         id: string;
     };
-    timing: Date | "immediate" | "next_billing_cycle";
     description?: string | undefined;
     metadata?: Record<string, string> | null | undefined;
 }, {
     name: string;
     quantity: number;
+    timing: Date | "immediate" | "next_billing_cycle";
     addon: {
         id: string;
     };
-    timing: Date | "immediate" | "next_billing_cycle";
     description?: string | undefined;
     metadata?: Record<string, string> | null | undefined;
 }>;
@@ -17988,6 +17981,7 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
         key: string;
         version?: number | undefined;
     }>;
+    startingPhase: zod.ZodOptional<zod.ZodString>;
     timing: zod.ZodUnion<[zod.ZodEnum<["immediate", "next_billing_cycle"]>, zod.ZodDate]>;
 }, "strip", zod.ZodTypeAny, {
     plan: {
@@ -18001,6 +17995,7 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
     alignment?: {
         billablesMustAlign?: boolean | undefined;
     } | undefined;
+    startingPhase?: string | undefined;
 }, {
     plan: {
         key: string;
@@ -18013,6 +18008,7 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
     alignment?: {
         billablesMustAlign?: boolean | undefined;
     } | undefined;
+    startingPhase?: string | undefined;
 }>, zod.ZodObject<{
     customPlan: zod.ZodObject<{
         alignment: zod.ZodOptional<zod.ZodObject<{
@@ -19516,10 +19512,13 @@ export declare const migrateSubscriptionParams: zod.ZodObject<{
     subscriptionId: string;
 }>;
 export declare const migrateSubscriptionBody: zod.ZodObject<{
+    startingPhase: zod.ZodOptional<zod.ZodString>;
     targetVersion: zod.ZodOptional<zod.ZodNumber>;
 }, "strip", zod.ZodTypeAny, {
+    startingPhase?: string | undefined;
     targetVersion?: number | undefined;
 }, {
+    startingPhase?: string | undefined;
     targetVersion?: number | undefined;
 }>;
 /**