@openmeter/sdk 1.0.0-beta.232 → 1.0.0-beta.234

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;
@@ -3788,6 +3796,8 @@ export interface components {
          * @example USD
          */
         CurrencyCode: string;
+        /** @description Fiat or managed custom currency code. */
+        CurrencyCodeOrCustom: string;
         /**
          * @description Custom Invoicing app can be used for interface with any invoicing or payment system.
          *
@@ -4087,6 +4097,11 @@ export interface components {
              * @example 2023-01-01T01:01:01.001Z
              */
             billingAnchor?: Date;
+            /**
+             * @description Controls how custom-currency cost bases are selected for the new subscription.
+             * @default dynamic
+             */
+            costBasisMode?: components['schemas']['SubscriptionCostBasisMode'];
             /** @description The custom plan description which defines the Subscription. */
             customPlan: components['schemas']['CustomPlanInput'];
         };
@@ -4095,6 +4110,11 @@ export interface components {
          * @description Create a custom subscription.
          */
         CustomSubscriptionCreate: {
+            /**
+             * @description Controls how custom-currency cost bases are selected for the new subscription.
+             * @default dynamic
+             */
+            costBasisMode?: components['schemas']['SubscriptionCostBasisMode'];
             /** @description The custom plan description which defines the Subscription. */
             customPlan: components['schemas']['CustomPlanInput'];
             /**
@@ -9795,6 +9815,11 @@ export interface components {
             billingAnchor?: Date;
             /** @description The settlement mode of the subscription. */
             settlementMode?: components['schemas']['BillingSettlementMode'];
+            /**
+             * @description Controls how custom-currency cost bases are selected for the new subscription.
+             * @default dynamic
+             */
+            costBasisMode?: components['schemas']['SubscriptionCostBasisMode'];
         };
         /**
          * Create from plan
@@ -9818,6 +9843,11 @@ export interface components {
             description?: string;
             /** @description The settlement mode of the subscription. */
             settlementMode?: components['schemas']['BillingSettlementMode'];
+            /**
+             * @description Controls how custom-currency cost bases are selected for the new subscription.
+             * @default dynamic
+             */
+            costBasisMode?: components['schemas']['SubscriptionCostBasisMode'];
             /**
              * @description Timing configuration for the change, when the change should take effect.
              *     The default is immediate.
@@ -10893,11 +10923,22 @@ export interface components {
             plan?: components['schemas']['PlanReference'];
             /**
              * Currency
-             * @description The currency code of the subscription.
-             *     Will be revised once we add multi currency support.
+             * @description The fiat currency in which the subscription is invoiced.
              * @default USD
              */
             currency: components['schemas']['CurrencyCode'];
+            /**
+             * Cost basis mode
+             * @description Controls whether custom-currency cost bases are resolved dynamically or pinned
+             *     when their currency pair is introduced to the subscription.
+             * @default dynamic
+             */
+            readonly costBasisMode: components['schemas']['SubscriptionCostBasisMode'];
+            /**
+             * Pinned cost bases
+             * @description Cost bases pinned to custom-currency pairs for this subscription.
+             */
+            readonly costBasisPins: components['schemas']['SubscriptionCostBasisPin'][];
             /**
              * Billing cadence
              * Format: duration
@@ -11263,6 +11304,26 @@ export interface components {
             /** @description Additional properties specific to the problem type may be present. */
             extensions?: components['schemas']['SubscriptionErrorExtensions'];
         };
+        /**
+         * @description Controls how custom-currency cost bases are selected for the subscription.
+         * @enum {string}
+         */
+        SubscriptionCostBasisMode: 'dynamic' | 'pinned';
+        /** @description A cost basis pinned to a custom-currency pair for the subscription. */
+        SubscriptionCostBasisPin: {
+            /**
+             * @description The managed custom currency ID.
+             * @example 01G65Z755AFWAKHE12NY0CQ9FH
+             */
+            readonly customCurrencyId: string;
+            /** @description The fiat currency in which the subscription is invoiced. */
+            readonly invoiceCurrency: components['schemas']['CurrencyCode'];
+            /**
+             * @description The pinned cost basis resource ID.
+             * @example 01G65Z755AFWAKHE12NY0CQ9FH
+             */
+            readonly costBasisId: string;
+        };
         /** @description Create a subscription. */
         SubscriptionCreate: components['schemas']['PlanSubscriptionCreate'] | components['schemas']['CustomSubscriptionCreate'];
         /** @description Subscription edit input. */
@@ -11353,11 +11414,22 @@ export interface components {
             plan?: components['schemas']['PlanReference'];
             /**
              * Currency
-             * @description The currency code of the subscription.
-             *     Will be revised once we add multi currency support.
+             * @description The fiat currency in which the subscription is invoiced.
              * @default USD
              */
             currency: components['schemas']['CurrencyCode'];
+            /**
+             * Cost basis mode
+             * @description Controls whether custom-currency cost bases are resolved dynamically or pinned
+             *     when their currency pair is introduced to the subscription.
+             * @default dynamic
+             */
+            readonly costBasisMode: components['schemas']['SubscriptionCostBasisMode'];
+            /**
+             * Pinned cost bases
+             * @description Cost bases pinned to custom-currency pairs for this subscription.
+             */
+            readonly costBasisPins: components['schemas']['SubscriptionCostBasisPin'][];
             /**
              * Billing cadence
              * Format: duration
@@ -11466,6 +11538,11 @@ export interface components {
              *     We say "referenced by the Price" regardless of how a price itself is referenced, it colloquially makes sense to say "paying the same price for the same thing". In practice this should be derived from what's printed on the invoice line-item.
              */
             key: string;
+            /**
+             * Currency
+             * @description The materialized currency of the item's rate card. Present for priced items.
+             */
+            readonly currency?: components['schemas']['CurrencyCodeOrCustom'];
             /** @description The feature's key (if present). */
             featureKey?: string;
             /**
@@ -12358,6 +12435,7 @@ export type CreateStripeCustomerPortalSessionParams = components['schemas']['Cre
 export type CreditNoteOriginalInvoiceRef = components['schemas']['CreditNoteOriginalInvoiceRef'];
 export type Currency = components['schemas']['Currency'];
 export type CurrencyCode = components['schemas']['CurrencyCode'];
+export type CurrencyCodeOrCustom = components['schemas']['CurrencyCodeOrCustom'];
 export type CustomInvoicingApp = components['schemas']['CustomInvoicingApp'];
 export type CustomInvoicingAppReplaceUpdate = components['schemas']['CustomInvoicingAppReplaceUpdate'];
 export type CustomInvoicingCustomerAppData = components['schemas']['CustomInvoicingCustomerAppData'];
@@ -12637,6 +12715,8 @@ export type SubscriptionBadRequestErrorResponse = components['schemas']['Subscri
 export type SubscriptionChange = components['schemas']['SubscriptionChange'];
 export type SubscriptionChangeResponseBody = components['schemas']['SubscriptionChangeResponseBody'];
 export type SubscriptionConflictErrorResponse = components['schemas']['SubscriptionConflictErrorResponse'];
+export type SubscriptionCostBasisMode = components['schemas']['SubscriptionCostBasisMode'];
+export type SubscriptionCostBasisPin = components['schemas']['SubscriptionCostBasisPin'];
 export type SubscriptionCreate = components['schemas']['SubscriptionCreate'];
 export type SubscriptionEdit = components['schemas']['SubscriptionEdit'];
 export type SubscriptionEditOperation = components['schemas']['SubscriptionEditOperation'];
@@ -26209,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/client/subscriptions.d.cts

@@ -29,6 +29,8 @@ export declare class Subscriptions {
         customerId: string;
         plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
         currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly costBasisMode: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisMode"];
+        readonly costBasisPins: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisPin"][];
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;
@@ -55,6 +57,8 @@ export declare class Subscriptions {
         customerId: string;
         plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
         currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly costBasisMode: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisMode"];
+        readonly costBasisPins: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisPin"][];
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;
@@ -85,6 +89,8 @@ export declare class Subscriptions {
         customerId: string;
         plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
         currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly costBasisMode: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisMode"];
+        readonly costBasisPins: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisPin"][];
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;
@@ -113,6 +119,8 @@ export declare class Subscriptions {
         customerId: string;
         plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
         currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly costBasisMode: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisMode"];
+        readonly costBasisPins: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisPin"][];
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;
@@ -164,6 +172,8 @@ export declare class Subscriptions {
         customerId: string;
         plan?: import("./schemas.cjs").components["schemas"]["PlanReference"];
         currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly costBasisMode: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisMode"];
+        readonly costBasisPins: import("./schemas.cjs").components["schemas"]["SubscriptionCostBasisPin"][];
         readonly billingCadence: string;
         readonly proRatingConfig?: import("./schemas.cjs").components["schemas"]["ProRatingConfig"];
         readonly billingAnchor: Date;