@openmeter/sdk 1.0.0-beta-3087f852a0e8 → 1.0.0-beta-14ec9d225214

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

@@ -2188,9 +2188,17 @@ export interface paths {
         put?: never;
         /**
          * Migrate subscription
-         * @description Migrates the subscripiton to the provided version of the current plan.
-         *     If possible, the migration will be done immediately.
-         *     If not, the migration will be scheduled to the end of the current billing period.
+         * @description Migrates a running subscription to a later version of its current plan.
+         *     If startingPhase is omitted and billingAnchor is omitted or unchanged, the subscription is amended in place.
+         *     Unchanged items retain their service periods. Changed or removed items end at
+         *     the effective time; replacements and additions start from that time.
+         *     For in-place migrations, existing addons must be compatible with the target plan version.
+         *     The phase timeline, billing anchor, and subscription-level billing settings
+         *     are preserved. Both response entries refer to the same subscription:
+         *     current is the before snapshot and next is the amended view.
+         *     Providing startingPhase or a different billingAnchor uses subscription change: the current subscription
+         *     ends and a replacement starts at the effective time. This resets the phase timeline
+         *     and can produce billing adjustments. Addons are not transferred to the replacement.
          */
         post: operations['migrateSubscription'];
         delete?: never;
@@ -26281,24 +26289,31 @@ export interface operations {
             content: {
                 'application/json': {
                     /**
-                     * @description Timing configuration for the migration, when the migration should take effect.
-                     *     If not supported by the subscription, 400 will be returned.
+                     * @description When the migration takes effect: immediately, at the next billing cycle, or at an explicit billing-aligned timestamp.
+                     *     In-place migrations may be scheduled into a later phase when the current and target phase timelines match.
+                     *     The target plan reference is saved immediately; changed items take effect at the requested time.
+                     *     Past or unsupported times return an error.
                      * @default immediate
                      */
                     timing?: components['schemas']['SubscriptionTiming'];
                     /**
-                     * @description The version of the plan to migrate to.
+                     * @description A strictly later version of the current 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.
+                     * @description Explicitly replace the subscription, starting in this target plan phase.
+                     *     Providing this field always selects replacement, even if the phase matches the current one.
+                     *     Replacement may produce billing adjustments and does not transfer addons.
+                     *     Omit it to migrate in place; incompatible phase timelines then return an error.
                      */
                     startingPhase?: string;
                     /**
                      * Format: date-time
-                     * @description The billing anchor of the subscription. The provided date will be normalized according to the billing cadence to the nearest recurrence before start time. If not provided, the previous subscription billing anchor will be used.
+                     * @description The anchor used with the plan's billing cadence to calculate billing periods.
+                     *     If startingPhase is omitted and this anchor is omitted or equal to the existing one, migration preserves the current subscription.
+                     *     Providing a different anchor ends the current subscription and creates a replacement.
+                     *     The supplied anchor is preserved; it may be before or after the replacement's start time.
                      * @example 2023-01-01T01:01:01.001Z
                      */
                     billingAnchor?: Date;

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

@@ -12569,9 +12569,17 @@ exports.ChangeSubscriptionBody = zod
 ])
     .describe('Change a subscription.');
 /**
- * Migrates the subscripiton to the provided version of the current plan.
- * If possible, the migration will be done immediately.
- * If not, the migration will be scheduled to the end of the current billing period.
+ * Migrates a running subscription to a later version of its current plan.
+ * If startingPhase is omitted and billingAnchor is omitted or unchanged, the subscription is amended in place.
+ * Unchanged items retain their service periods. Changed or removed items end at
+ * the effective time; replacements and additions start from that time.
+ * For in-place migrations, existing addons must be compatible with the target plan version.
+ * The phase timeline, billing anchor, and subscription-level billing settings
+ * are preserved. Both response entries refer to the same subscription:
+ * current is the before snapshot and next is the amended view.
+ * Providing startingPhase or a different billingAnchor uses subscription change: the current subscription
+ * ends and a replacement starts at the effective time. This resets the phase timeline
+ * and can produce billing adjustments. Addons are not transferred to the replacement.
  * @summary Migrate subscription
  */
 exports.migrateSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
@@ -12585,18 +12593,18 @@ exports.MigrateSubscriptionBody = zod.object({
     billingAnchor: zod.coerce
         .date()
         .optional()
-        .describe('The billing anchor of the subscription. The provided date will be normalized according to the billing cadence to the nearest recurrence before start time. If not provided, the previous subscription billing anchor will be used.'),
+        .describe("The anchor used with the plan's billing cadence to calculate billing periods.\nIf startingPhase is omitted and this anchor is omitted or equal to the existing one, migration preserves the current subscription.\nProviding a different anchor ends the current subscription and creates a replacement.\nThe supplied anchor is preserved; it may be before or after the replacement's start time."),
     startingPhase: zod.coerce
         .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.'),
+        .describe('Explicitly replace the subscription, starting in this target plan phase.\nProviding this field always selects replacement, even if the phase matches the current one.\nReplacement may produce billing adjustments and does not transfer addons.\nOmit it to migrate in place; incompatible phase timelines then return an error.'),
     targetVersion: zod.coerce
         .number()
         .int()
         .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.'),
+        .describe('A strictly later version of the current plan to migrate to.\nIf not provided, the subscription will migrate to the latest version of the current plan.'),
     timing: zod
         .union([
         zod
@@ -12608,7 +12616,7 @@ exports.MigrateSubscriptionBody = zod.object({
     ])
         .describe('Subscription edit timing defined when the changes should take effect.\nIf the provided configuration is not supported by the subscription, an error will be returned.')
         .default(exports.migrateSubscriptionBodyTimingDefault)
-        .describe('Timing configuration for the migration, when the migration should take effect.\nIf not supported by the subscription, 400 will be returned.'),
+        .describe('When the migration takes effect: immediately, at the next billing cycle, or at an explicit billing-aligned timestamp.\nIn-place migrations may be scheduled into a later phase when the current and target phase timelines match.\nThe target plan reference is saved immediately; changed items take effect at the requested time.\nPast or unsupported times return an error.'),
 });
 /**
  * Restores a canceled subscription.