@openmeter/sdk 1.0.0-beta-420aec97a983 → 1.0.0-beta-b8d23d87938c

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

@@ -242,7 +242,13 @@ export interface paths {
         };
         /**
          * List customer overrides
-         * @description List customer overrides
+         * @description List customer overrides using the specified filters.
+         *
+         *     The response will include the customer override values and the merged billing profile values.
+         *
+         *     If the includeAllCustomers is set to true, the list contains all customers. This mode is
+         *     useful for getting the current effective billing workflow settings for all users regardless
+         *     if they have customer orverrides or not.
          */
         get: operations['listBillingProfileCustomerOverrides'];
         put?: never;
@@ -263,17 +269,29 @@ export interface paths {
         /**
          * Get a customer override
          * @description Get a customer override by customer id.
+         *
+         *     The response will include the customer override values and the merged billing profile values.
+         *
+         *     If the customer override is not found, the default billing profile's values are returned. This behavior
+         *     allows for getting a merged profile regardless of the customer override existence.
          */
         get: operations['getBillingProfileCustomerOverride'];
         /**
          * Create a new or update a customer override
-         * @description Create a new or update an existing customer override.
+         * @description The customer override can be used to pin a given customer to a billing profile
+         *     different from the default one.
+         *
+         *     This can be used to test the effect of different billing profiles before making them
+         *     the default ones or have different workflow settings for example for enterprise customers.
          */
         put: operations['upsertBillingProfileCustomerOverride'];
         post?: never;
         /**
          * Delete a customer override
          * @description Delete a customer override by customer id.
+         *
+         *     This will remove the customer override and the customer will be subject to the default
+         *     billing profile's settings again.
          */
         delete: operations['deleteBillingProfileCustomerOverride'];
         options?: never;
@@ -341,7 +359,12 @@ export interface paths {
         };
         /**
          * List invoices
-         * @description List invoices for a specific customer
+         * @description List invoices based on the specified filters.
+         *
+         *     The expand option can be used to include additional information (besides the invoice header and totals)
+         *     in the response. For example by adding the expand=lines option the invoice lines will be included in the response.
+         *
+         *     Gathering invoices will always show the current usage calculated on the fly.
          */
         get: operations['listInvoices'];
         put?: never;
@@ -390,6 +413,8 @@ export interface paths {
         /**
          * Get an invoice
          * @description Get an invoice by ID.
+         *
+         *     Gathering invoices will always show the current usage calculated on the fly.
          */
         get: operations['getInvoice'];
         /**
@@ -405,6 +430,8 @@ export interface paths {
          * @description Delete an invoice
          *
          *     Only invoices that are in the draft (or earlier) status can be deleted.
+         *
+         *     Invoices that are post finalization can only be voided.
          */
         delete: operations['deleteInvoice'];
         options?: never;
@@ -496,6 +523,11 @@ export interface paths {
         /**
          * Snapshot quantities for usage based line items
          * @description Snapshot quantities for usage based line items.
+         *
+         *     This call will snapshot the quantities for all usage based line items in the invoice.
+         *
+         *     This call is only valid in `draft.waiting_for_collection` status, where the collection period
+         *     can be skipped using this action.
          */
         post: operations['snapshotQuantitiesInvoiceAction'];
         delete?: never;
@@ -559,7 +591,11 @@ export interface paths {
         };
         /**
          * List billing profiles
-         * @description List all billing profiles
+         * @description List all billing profiles matching the specified filters.
+         *
+         *     The expand option can be used to include additional information (besides the billing profile)
+         *     in the response. For example by adding the expand=apps option the apps used by the billing profile
+         *     will be included in the response.
          */
         get: operations['listBillingProfiles'];
         put?: never;
@@ -586,18 +622,30 @@ export interface paths {
         };
         /**
          * Get a billing profile
-         * @description Get a billing profile by ID
+         * @description Get a billing profile by id.
+         *
+         *     The expand option can be used to include additional information (besides the billing profile)
+         *     in the response. For example by adding the expand=apps option the apps used by the billing profile
+         *     will be included in the response.
          */
         get: operations['getBillingProfile'];
         /**
          * Update a billing profile
-         * @description Update a billing profile
+         * @description Update a billing profile by id.
+         *
+         *     The apps field cannot be updated directly, if an app change is desired a new
+         *     profile should be created.
          */
         put: operations['updateBillingProfile'];
         post?: never;
         /**
          * Delete a billing profile
-         * @description Delete a billing profile
+         * @description Delete a billing profile by id.
+         *
+         *     Only such billing profiles can be deleted that are:
+         *     - not the default one
+         *     - not pinned to any customer using customer overrides
+         *     - only have finalized invoices
          */
         delete: operations['deleteBillingProfile'];
         options?: never;
@@ -23210,6 +23258,12 @@ export interface operations {
         requestBody: {
             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.
+                     * @default immediate
+                     */
+                    timing?: components['schemas']['SubscriptionTiming'];
                     /** @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;

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

@@ -23,8 +23,8 @@ exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyMax = exports.
 exports.getSubscriptionPathSubscriptionIdRegExp = exports.createSubscriptionBody = exports.createSubscriptionBodyCustomerKeyMaxOne = exports.createSubscriptionBodyCustomerIdRegExpOne = exports.createSubscriptionBodyTimingDefaultFour = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemDiscountsUsageQuantityRegExpThree = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpSeven = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpSeven = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceQuantityPerPackageRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpSeven = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpFive = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpFive = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMultiplierDefault = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMultiplierRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpThree = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpThree = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceTiersItemUnitPriceAmountRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceTiersItemFlatPriceAmountRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceTiersItemUpToAmountRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpFive = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPricePaymentTermDefaultTwo = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpThree = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemTaxConfigStripeCodeRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplatePreserveOverageAtResetDefaultOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityMaxOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityDefaultOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetMinOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIsSoftLimitDefaultOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyMaxOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemDescriptionMaxOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemNameMaxOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyMaxOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemDiscountsUsageQuantityRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPricePaymentTermDefault = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpOne = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemTaxConfigStripeCodeRegExp = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplatePreserveOverageAtResetDefault = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityMax = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityDefault = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetMin = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIsSoftLimitDefault = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyRegExp = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyMax = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemDescriptionMax = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemNameMax = exports.createSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyRegExp = void 0;
 exports.editSubscriptionBodyCustomizationsItemRateCardDiscountsUsageQuantityRegExpThree = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMaximumAmountRegExpSeven = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMinimumAmountRegExpSeven = exports.editSubscriptionBodyCustomizationsItemRateCardPriceQuantityPerPackageRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardPriceAmountRegExpSeven = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMaximumAmountRegExpFive = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMinimumAmountRegExpFive = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMultiplierDefault = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMultiplierRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMaximumAmountRegExpThree = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMinimumAmountRegExpThree = exports.editSubscriptionBodyCustomizationsItemRateCardPriceTiersItemUnitPriceAmountRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardPriceTiersItemFlatPriceAmountRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardPriceTiersItemUpToAmountRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMaximumAmountRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardPriceMinimumAmountRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardPriceAmountRegExpFive = exports.editSubscriptionBodyCustomizationsItemRateCardPricePaymentTermDefaultTwo = exports.editSubscriptionBodyCustomizationsItemRateCardPriceAmountRegExpThree = exports.editSubscriptionBodyCustomizationsItemRateCardTaxConfigStripeCodeRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplatePreserveOverageAtResetDefaultOne = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplateIssueAfterResetPriorityMaxOne = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplateIssueAfterResetPriorityDefaultOne = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplateIssueAfterResetMinOne = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplateIsSoftLimitDefaultOne = exports.editSubscriptionBodyCustomizationsItemRateCardFeatureKeyRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardFeatureKeyMaxOne = exports.editSubscriptionBodyCustomizationsItemRateCardDescriptionMaxOne = exports.editSubscriptionBodyCustomizationsItemRateCardNameMaxOne = exports.editSubscriptionBodyCustomizationsItemRateCardKeyRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardKeyMaxOne = exports.editSubscriptionBodyCustomizationsItemRateCardDiscountsUsageQuantityRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardPricePaymentTermDefault = exports.editSubscriptionBodyCustomizationsItemRateCardPriceAmountRegExpOne = exports.editSubscriptionBodyCustomizationsItemRateCardTaxConfigStripeCodeRegExp = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplatePreserveOverageAtResetDefault = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplateIssueAfterResetPriorityMax = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplateIssueAfterResetPriorityDefault = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplateIssueAfterResetMin = exports.editSubscriptionBodyCustomizationsItemRateCardEntitlementTemplateIsSoftLimitDefault = exports.editSubscriptionBodyCustomizationsItemRateCardFeatureKeyRegExp = exports.editSubscriptionBodyCustomizationsItemRateCardFeatureKeyMax = exports.editSubscriptionBodyCustomizationsItemRateCardDescriptionMax = exports.editSubscriptionBodyCustomizationsItemRateCardNameMax = exports.editSubscriptionBodyCustomizationsItemRateCardKeyRegExp = exports.editSubscriptionBodyCustomizationsItemRateCardKeyMax = exports.editSubscriptionParams = exports.editSubscriptionPathSubscriptionIdRegExp = exports.getSubscriptionQueryParams = exports.getSubscriptionParams = void 0;
 exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIsSoftLimitDefault = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyRegExp = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyMax = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemDescriptionMax = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemNameMax = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyRegExp = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyMax = exports.changeSubscriptionBodyCustomPlanPhasesItemDescriptionMax = exports.changeSubscriptionBodyCustomPlanPhasesItemNameMax = exports.changeSubscriptionBodyCustomPlanPhasesItemKeyRegExp = exports.changeSubscriptionBodyCustomPlanPhasesItemKeyMax = exports.changeSubscriptionBodyCustomPlanCurrencyDefault = exports.changeSubscriptionBodyCustomPlanCurrencyRegExpOne = exports.changeSubscriptionBodyCustomPlanCurrencyMaxOne = exports.changeSubscriptionBodyCustomPlanCurrencyMinOne = exports.changeSubscriptionBodyCustomPlanDescriptionMax = exports.changeSubscriptionBodyCustomPlanNameMax = exports.changeSubscriptionBodyPlanKeyRegExp = exports.changeSubscriptionBodyPlanKeyMax = exports.changeSubscriptionParams = exports.changeSubscriptionPathSubscriptionIdRegExp = exports.cancelSubscriptionBody = exports.cancelSubscriptionParams = exports.cancelSubscriptionPathSubscriptionIdRegExp = exports.updateSubscriptionAddonBody = exports.updateSubscriptionAddonBodyQuantityMin = exports.updateSubscriptionAddonBodyDescriptionMax = exports.updateSubscriptionAddonBodyNameMax = exports.updateSubscriptionAddonParams = exports.updateSubscriptionAddonPathSubscriptionAddonIdRegExp = exports.updateSubscriptionAddonPathSubscriptionIdRegExp = exports.getSubscriptionAddonParams = exports.getSubscriptionAddonPathSubscriptionAddonIdRegExp = exports.getSubscriptionAddonPathSubscriptionIdRegExp = exports.listSubscriptionAddonsParams = exports.listSubscriptionAddonsPathSubscriptionIdRegExp = exports.createSubscriptionAddonBody = exports.createSubscriptionAddonBodyAddonIdRegExp = exports.createSubscriptionAddonBodyQuantityMin = exports.createSubscriptionAddonBodyDescriptionMax = exports.createSubscriptionAddonBodyNameMax = exports.createSubscriptionAddonParams = exports.createSubscriptionAddonPathSubscriptionIdRegExp = exports.deleteSubscriptionParams = exports.deleteSubscriptionPathSubscriptionIdRegExp = exports.editSubscriptionBody = exports.editSubscriptionBodyCustomizationsMax = exports.editSubscriptionBodyCustomizationsItemPhaseKeyRegExpTwo = exports.editSubscriptionBodyCustomizationsItemPhaseKeyMaxTwo = exports.editSubscriptionBodyCustomizationsItemPhaseDiscountsUsageQuantityRegExpOne = void 0;
-exports.listEventsV2QueryClientIdMax = exports.listEventsV2QueryLimitMax = exports.listEventsV2QueryLimitDefault = exports.unscheduleCancelationParams = exports.unscheduleCancelationPathSubscriptionIdRegExp = exports.restoreSubscriptionParams = exports.restoreSubscriptionPathSubscriptionIdRegExp = exports.migrateSubscriptionBody = exports.migrateSubscriptionParams = exports.migrateSubscriptionPathSubscriptionIdRegExp = exports.changeSubscriptionBody = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemDiscountsUsageQuantityRegExpThree = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpSeven = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpSeven = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceQuantityPerPackageRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpSeven = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpFive = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpFive = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMultiplierDefault = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMultiplierRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpThree = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpThree = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceTiersItemUnitPriceAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceTiersItemFlatPriceAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceTiersItemUpToAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpFive = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPricePaymentTermDefaultTwo = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpThree = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemTaxConfigStripeCodeRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplatePreserveOverageAtResetDefaultOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityDefaultOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetMinOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIsSoftLimitDefaultOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemDescriptionMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemNameMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemDiscountsUsageQuantityRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPricePaymentTermDefault = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemTaxConfigStripeCodeRegExp = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplatePreserveOverageAtResetDefault = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityMax = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityDefault = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetMin = void 0;
-exports.listEventsV2QueryParams = void 0;
+exports.listEventsV2QueryLimitMax = exports.listEventsV2QueryLimitDefault = exports.unscheduleCancelationParams = exports.unscheduleCancelationPathSubscriptionIdRegExp = exports.restoreSubscriptionParams = exports.restoreSubscriptionPathSubscriptionIdRegExp = exports.migrateSubscriptionBody = exports.migrateSubscriptionBodyTimingDefault = exports.migrateSubscriptionParams = exports.migrateSubscriptionPathSubscriptionIdRegExp = exports.changeSubscriptionBody = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemDiscountsUsageQuantityRegExpThree = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpSeven = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpSeven = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceQuantityPerPackageRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpSeven = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpFive = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpFive = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMultiplierDefault = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMultiplierRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpThree = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpThree = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceTiersItemUnitPriceAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceTiersItemFlatPriceAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceTiersItemUpToAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMaximumAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceMinimumAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpFive = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPricePaymentTermDefaultTwo = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpThree = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemTaxConfigStripeCodeRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplatePreserveOverageAtResetDefaultOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityDefaultOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetMinOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIsSoftLimitDefaultOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemFeatureKeyMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemDescriptionMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemNameMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemKeyMaxOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemDiscountsUsageQuantityRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPricePaymentTermDefault = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemPriceAmountRegExpOne = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemTaxConfigStripeCodeRegExp = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplatePreserveOverageAtResetDefault = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityMax = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetPriorityDefault = exports.changeSubscriptionBodyCustomPlanPhasesItemRateCardsItemEntitlementTemplateIssueAfterResetMin = void 0;
+exports.listEventsV2QueryParams = exports.listEventsV2QueryClientIdMax = void 0;
 /* eslint-disable no-useless-escape */
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-nocheck
@@ -1589,7 +1589,13 @@ exports.appStripeWebhookBody = zod_1.z
 })
     .describe('Stripe webhook event.');
 /**
- * List customer overrides
+ * List customer overrides using the specified filters.
+
+The response will include the customer override values and the merged billing profile values.
+
+If the includeAllCustomers is set to true, the list contains all customers. This mode is
+useful for getting the current effective billing workflow settings for all users regardless
+if they have customer orverrides or not.
  * @summary List customer overrides
  */
 exports.listBillingProfileCustomerOverridesQueryBillingProfileItemRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -1653,7 +1659,11 @@ exports.listBillingProfileCustomerOverridesQueryParams = zod_1.z.object({
         .describe('The maximum number of items per page.\n\nDefault is 100.'),
 });
 /**
- * Create a new or update an existing customer override.
+ * The customer override can be used to pin a given customer to a billing profile
+different from the default one.
+
+This can be used to test the effect of different billing profiles before making them
+the default ones or have different workflow settings for example for enterprise customers.
  * @summary Create a new or update a customer override
  */
 exports.upsertBillingProfileCustomerOverridePathCustomerIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -1674,6 +1684,11 @@ exports.upsertBillingProfileCustomerOverrideBody = zod_1.z
     .describe('Payload for creating a new or updating an existing customer override.');
 /**
  * Get a customer override by customer id.
+
+The response will include the customer override values and the merged billing profile values.
+
+If the customer override is not found, the default billing profile's values are returned. This behavior
+allows for getting a merged profile regardless of the customer override existence.
  * @summary Get a customer override
  */
 exports.getBillingProfileCustomerOverridePathCustomerIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -1691,6 +1706,9 @@ exports.getBillingProfileCustomerOverrideQueryParams = zod_1.z.object({
 });
 /**
  * Delete a customer override by customer id.
+
+This will remove the customer override and the customer will be subject to the default
+billing profile's settings again.
  * @summary Delete a customer override
  */
 exports.deleteBillingProfileCustomerOverridePathCustomerIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -3193,7 +3211,12 @@ exports.simulateInvoiceBody = zod_1.z
 })
     .describe('InvoiceSimulationInput is the input for simulating an invoice.');
 /**
- * List invoices for a specific customer
+ * List invoices based on the specified filters.
+
+The expand option can be used to include additional information (besides the invoice header and totals)
+in the response. For example by adding the expand=lines option the invoice lines will be included in the response.
+
+Gathering invoices will always show the current usage calculated on the fly.
  * @summary List invoices
  */
 exports.listInvoicesQueryCustomersItemRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -3328,6 +3351,8 @@ exports.invoicePendingLinesActionBody = zod_1.z
     .describe('BillingInvoiceActionInput is the input for creating an invoice.\n\nInvoice creation is always based on already pending line items created by the billingCreateLineByCustomer\noperation. Empty invoices are not allowed.');
 /**
  * Get an invoice by ID.
+
+Gathering invoices will always show the current usage calculated on the fly.
  * @summary Get an invoice
  */
 exports.getInvoicePathInvoiceIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -3348,6 +3373,8 @@ exports.getInvoiceQueryParams = zod_1.z.object({
  * Delete an invoice
 
 Only invoices that are in the draft (or earlier) status can be deleted.
+
+Invoices that are post finalization can only be voided.
  * @summary Delete an invoice
  */
 exports.deleteInvoicePathInvoiceIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -4313,6 +4340,11 @@ exports.retryInvoiceActionParams = zod_1.z.object({
 });
 /**
  * Snapshot quantities for usage based line items.
+
+This call will snapshot the quantities for all usage based line items in the invoice.
+
+This call is only valid in `draft.waiting_for_collection` status, where the collection period
+can be skipped using this action.
  * @summary Snapshot quantities for usage based line items
  */
 exports.snapshotQuantitiesInvoiceActionPathInvoiceIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -4417,7 +4449,11 @@ exports.voidInvoiceActionBody = zod_1.z
 })
     .describe('Request to void an invoice');
 /**
- * List all billing profiles
+ * List all billing profiles matching the specified filters.
+
+The expand option can be used to include additional information (besides the billing profile)
+in the response. For example by adding the expand=apps option the apps used by the billing profile
+will be included in the response.
  * @summary List billing profiles
  */
 exports.listBillingProfilesQueryIncludeArchivedDefault = false;
@@ -4677,7 +4713,12 @@ exports.createBillingProfileBody = zod_1.z
 })
     .describe('BillingProfileCreate represents the input for creating a billing profile');
 /**
- * Delete a billing profile
+ * Delete a billing profile by id.
+
+Only such billing profiles can be deleted that are:
+- not the default one
+- not pinned to any customer using customer overrides
+- only have finalized invoices
  * @summary Delete a billing profile
  */
 exports.deleteBillingProfilePathIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -4685,7 +4726,11 @@ exports.deleteBillingProfileParams = zod_1.z.object({
     id: zod_1.z.string().regex(exports.deleteBillingProfilePathIdRegExp),
 });
 /**
- * Get a billing profile by ID
+ * Get a billing profile by id.
+
+The expand option can be used to include additional information (besides the billing profile)
+in the response. For example by adding the expand=apps option the apps used by the billing profile
+will be included in the response.
  * @summary Get a billing profile
  */
 exports.getBillingProfilePathIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -4700,7 +4745,10 @@ exports.getBillingProfileQueryParams = zod_1.z.object({
         .optional(),
 });
 /**
- * Update a billing profile
+ * Update a billing profile by id.
+
+The apps field cannot be updated directly, if an app change is desired a new
+profile should be created.
  * @summary Update a billing profile
  */
 exports.updateBillingProfilePathIdRegExp = new RegExp('^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$');
@@ -11512,6 +11560,7 @@ exports.migrateSubscriptionParams = zod_1.z.object({
         .string()
         .regex(exports.migrateSubscriptionPathSubscriptionIdRegExp),
 });
+exports.migrateSubscriptionBodyTimingDefault = 'immediate';
 exports.migrateSubscriptionBody = zod_1.z.object({
     startingPhase: zod_1.z
         .string()
@@ -11523,6 +11572,15 @@ exports.migrateSubscriptionBody = zod_1.z.object({
         .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.'),
+    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.')
+        .or(zod_1.z
+        .date()
+        .describe('[RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.'))
+        .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.'),
 });
 /**
  * Restores a canceled subscription.

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

@@ -2374,7 +2374,13 @@ export declare const appStripeWebhookBody: zod.ZodObject<{
     livemode: boolean;
 }>;
 /**
- * List customer overrides
+ * List customer overrides using the specified filters.
+
+The response will include the customer override values and the merged billing profile values.
+
+If the includeAllCustomers is set to true, the list contains all customers. This mode is
+useful for getting the current effective billing workflow settings for all users regardless
+if they have customer orverrides or not.
  * @summary List customer overrides
  */
 export declare const listBillingProfileCustomerOverridesQueryBillingProfileItemRegExp: RegExp;
@@ -2421,7 +2427,11 @@ export declare const listBillingProfileCustomerOverridesQueryParams: zod.ZodObje
     includeAllCustomers?: boolean | undefined;
 }>;
 /**
- * Create a new or update an existing customer override.
+ * The customer override can be used to pin a given customer to a billing profile
+different from the default one.
+
+This can be used to test the effect of different billing profiles before making them
+the default ones or have different workflow settings for example for enterprise customers.
  * @summary Create a new or update a customer override
  */
 export declare const upsertBillingProfileCustomerOverridePathCustomerIdRegExp: RegExp;
@@ -2442,6 +2452,11 @@ export declare const upsertBillingProfileCustomerOverrideBody: zod.ZodObject<{
 }>;
 /**
  * Get a customer override by customer id.
+
+The response will include the customer override values and the merged billing profile values.
+
+If the customer override is not found, the default billing profile's values are returned. This behavior
+allows for getting a merged profile regardless of the customer override existence.
  * @summary Get a customer override
  */
 export declare const getBillingProfileCustomerOverridePathCustomerIdRegExp: RegExp;
@@ -2461,6 +2476,9 @@ export declare const getBillingProfileCustomerOverrideQueryParams: zod.ZodObject
 }>;
 /**
  * Delete a customer override by customer id.
+
+This will remove the customer override and the customer will be subject to the default
+billing profile's settings again.
  * @summary Delete a customer override
  */
 export declare const deleteBillingProfileCustomerOverridePathCustomerIdRegExp: RegExp;
@@ -5447,7 +5465,12 @@ export declare const simulateInvoiceBody: zod.ZodObject<{
     number?: string | undefined;
 }>;
 /**
- * List invoices for a specific customer
+ * List invoices based on the specified filters.
+
+The expand option can be used to include additional information (besides the invoice header and totals)
+in the response. For example by adding the expand=lines option the invoice lines will be included in the response.
+
+Gathering invoices will always show the current usage calculated on the fly.
  * @summary List invoices
  */
 export declare const listInvoicesQueryCustomersItemRegExp: RegExp;
@@ -5545,6 +5568,8 @@ export declare const invoicePendingLinesActionBody: zod.ZodObject<{
 }>;
 /**
  * Get an invoice by ID.
+
+Gathering invoices will always show the current usage calculated on the fly.
  * @summary Get an invoice
  */
 export declare const getInvoicePathInvoiceIdRegExp: RegExp;
@@ -5571,6 +5596,8 @@ export declare const getInvoiceQueryParams: zod.ZodObject<{
  * Delete an invoice
 
 Only invoices that are in the draft (or earlier) status can be deleted.
+
+Invoices that are post finalization can only be voided.
  * @summary Delete an invoice
  */
 export declare const deleteInvoicePathInvoiceIdRegExp: RegExp;
@@ -7508,6 +7535,11 @@ export declare const retryInvoiceActionParams: zod.ZodObject<{
 }>;
 /**
  * Snapshot quantities for usage based line items.
+
+This call will snapshot the quantities for all usage based line items in the invoice.
+
+This call is only valid in `draft.waiting_for_collection` status, where the collection period
+can be skipped using this action.
  * @summary Snapshot quantities for usage based line items
  */
 export declare const snapshotQuantitiesInvoiceActionPathInvoiceIdRegExp: RegExp;
@@ -7694,7 +7726,11 @@ export declare const voidInvoiceActionBody: zod.ZodObject<{
     }[] | null | undefined;
 }>;
 /**
- * List all billing profiles
+ * List all billing profiles matching the specified filters.
+
+The expand option can be used to include additional information (besides the billing profile)
+in the response. For example by adding the expand=apps option the apps used by the billing profile
+will be included in the response.
  * @summary List billing profiles
  */
 export declare const listBillingProfilesQueryIncludeArchivedDefault = false;
@@ -8114,7 +8150,12 @@ export declare const createBillingProfileBody: zod.ZodObject<{
     metadata?: Record<string, string> | null | undefined;
 }>;
 /**
- * Delete a billing profile
+ * Delete a billing profile by id.
+
+Only such billing profiles can be deleted that are:
+- not the default one
+- not pinned to any customer using customer overrides
+- only have finalized invoices
  * @summary Delete a billing profile
  */
 export declare const deleteBillingProfilePathIdRegExp: RegExp;
@@ -8126,7 +8167,11 @@ export declare const deleteBillingProfileParams: zod.ZodObject<{
     id: string;
 }>;
 /**
- * Get a billing profile by ID
+ * Get a billing profile by id.
+
+The expand option can be used to include additional information (besides the billing profile)
+in the response. For example by adding the expand=apps option the apps used by the billing profile
+will be included in the response.
  * @summary Get a billing profile
  */
 export declare const getBillingProfilePathIdRegExp: RegExp;
@@ -8145,7 +8190,10 @@ export declare const getBillingProfileQueryParams: zod.ZodObject<{
     expand?: "apps"[] | undefined;
 }>;
 /**
- * Update a billing profile
+ * Update a billing profile by id.
+
+The apps field cannot be updated directly, if an app change is desired a new
+profile should be created.
  * @summary Update a billing profile
  */
 export declare const updateBillingProfilePathIdRegExp: RegExp;
@@ -19526,14 +19574,18 @@ export declare const migrateSubscriptionParams: zod.ZodObject<{
 }, {
     subscriptionId: string;
 }>;
+export declare const migrateSubscriptionBodyTimingDefault = "immediate";
 export declare const migrateSubscriptionBody: zod.ZodObject<{
     startingPhase: zod.ZodOptional<zod.ZodString>;
     targetVersion: zod.ZodOptional<zod.ZodNumber>;
+    timing: zod.ZodDefault<zod.ZodUnion<[zod.ZodEnum<["immediate", "next_billing_cycle"]>, zod.ZodDate]>>;
 }, "strip", zod.ZodTypeAny, {
+    timing: Date | "immediate" | "next_billing_cycle";
     startingPhase?: string | undefined;
     targetVersion?: number | undefined;
 }, {
     startingPhase?: string | undefined;
+    timing?: Date | "immediate" | "next_billing_cycle" | undefined;
     targetVersion?: number | undefined;
 }>;
 /**