feat(billing): add subscription end proration mode (#4553)

Co-authored-by: Alex Goth <64845621+GAlexIHU@users.noreply.github.com>

Author: turip

api/api.gen.go

@@ -3395,6 +3395,11 @@ export interface components {
        * @default true
        */
       progressiveBilling?: boolean
+      /**
+       * @description Controls how subscription-ending shortened service periods are billed.
+       * @default bill_actual_period
+       */
+      subscriptionEndProrationMode?: components['schemas']['BillingWorkflowInvoicingSubscriptionEndProrationMode']
       /**
        * @description Default tax configuration to apply to the invoices.
        *
@@ -3405,6 +3410,13 @@ export interface components {
        */
       defaultTaxConfig?: components['schemas']['TaxConfig']
     }
+    /**
+     * @description Billing workflow subscription end proration mode.
+     * @enum {string}
+     */
+    BillingWorkflowInvoicingSubscriptionEndProrationMode:
+      | 'bill_full_period'
+      | 'bill_actual_period'
     /**
      * Workflow payment settings
      * @description BillingWorkflowPaymentSettings represents the payment settings for a billing workflow
@@ -7738,6 +7750,11 @@ export interface components {
        * @example P30D
        */
       dueAfter?: string
+      /**
+       * @description Controls how subscription-ending shortened service periods are billed.
+       * @default bill_actual_period
+       */
+      subscriptionEndProrationMode?: components['schemas']['BillingWorkflowInvoicingSubscriptionEndProrationMode']
       /**
        * @description Default tax configuration to apply to the invoices.
        *
@@ -12499,6 +12516,8 @@ export type BillingWorkflowCreate =
   components['schemas']['BillingWorkflowCreate']
 export type BillingWorkflowInvoicingSettings =
   components['schemas']['BillingWorkflowInvoicingSettings']
+export type BillingWorkflowInvoicingSubscriptionEndProrationMode =
+  components['schemas']['BillingWorkflowInvoicingSubscriptionEndProrationMode']
 export type BillingWorkflowPaymentSettings =
   components['schemas']['BillingWorkflowPaymentSettings']
 export type BillingWorkflowTaxSettings =

api/client/go/client.gen.go

@@ -4851,6 +4851,8 @@ export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDraftPeriodDefau
   'P0D'
 export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDueAfterDefault =
   'P30D'
+export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault =
+  'bill_actual_period'
 export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp =
   /^txcd_\d{8}$/
 export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp =
@@ -5890,6 +5892,15 @@ export const UpdateInvoiceBody = zod
                   .describe(
                     "The period after which the invoice is due.\nWith some payment solutions it's only applicable for manual collection method.",
                   ),
+                subscriptionEndProrationMode: zod
+                  .enum(['bill_full_period', 'bill_actual_period'])
+                  .describe('Billing workflow subscription end proration mode.')
+                  .default(
+                    updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault,
+                  )
+                  .describe(
+                    'Controls how subscription-ending shortened service periods are billed.',
+                  ),
               })
               .describe(
                 'InvoiceWorkflowInvoicingSettingsReplaceUpdate represents the update model for the invoicing settings of an invoice workflow.',
@@ -6218,6 +6229,8 @@ export const createBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault =
 export const createBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault =
   'P30D'
 export const createBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true
+export const createBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault =
+  'bill_actual_period'
 export const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp =
   /^txcd_\d{8}$/
 export const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp =
@@ -6531,6 +6544,15 @@ export const CreateBillingProfileBody = zod
               .describe(
                 'Should progressive billing be allowed for this workflow?',
               ),
+            subscriptionEndProrationMode: zod
+              .enum(['bill_full_period', 'bill_actual_period'])
+              .describe('Billing workflow subscription end proration mode.')
+              .default(
+                createBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault,
+              )
+              .describe(
+                'Controls how subscription-ending shortened service periods are billed.',
+              ),
           })
           .describe(
             'BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow',
@@ -6664,6 +6686,8 @@ export const updateBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault =
 export const updateBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault =
   'P30D'
 export const updateBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true
+export const updateBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault =
+  'bill_actual_period'
 export const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp =
   /^txcd_\d{8}$/
 export const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp =
@@ -6952,6 +6976,15 @@ export const UpdateBillingProfileBody = zod
               .describe(
                 'Should progressive billing be allowed for this workflow?',
               ),
+            subscriptionEndProrationMode: zod
+              .enum(['bill_full_period', 'bill_actual_period'])
+              .describe('Billing workflow subscription end proration mode.')
+              .default(
+                updateBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault,
+              )
+              .describe(
+                'Controls how subscription-ending shortened service periods are billed.',
+              ),
           })
           .describe(
             'BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow',

api/client/javascript/src/client/schemas.ts

@@ -14167,6 +14167,11 @@ components:
           type: boolean
           description: Should progressive billing be allowed for this workflow?
           default: true
+        subscriptionEndProrationMode:
+          allOf:
+            - $ref: '#/components/schemas/BillingWorkflowInvoicingSubscriptionEndProrationMode'
+          description: Controls how subscription-ending shortened service periods are billed.
+          default: bill_actual_period
         defaultTaxConfig:
           allOf:
             - $ref: '#/components/schemas/TaxConfig'
@@ -14179,6 +14184,12 @@ components:
             fully supported.
       description: BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow
       title: Workflow invoice settings
+    BillingWorkflowInvoicingSubscriptionEndProrationMode:
+      type: string
+      enum:
+        - bill_full_period
+        - bill_actual_period
+      description: Billing workflow subscription end proration mode.
     BillingWorkflowPaymentSettings:
       type: object
       properties:
@@ -19784,6 +19795,11 @@ components:
             With some payment solutions it's only applicable for manual collection method.
           example: P30D
           default: P30D
+        subscriptionEndProrationMode:
+          allOf:
+            - $ref: '#/components/schemas/BillingWorkflowInvoicingSubscriptionEndProrationMode'
+          description: Controls how subscription-ending shortened service periods are billed.
+          default: bill_actual_period
         defaultTaxConfig:
           allOf:
             - $ref: '#/components/schemas/TaxConfig'

api/client/javascript/src/zod/index.ts

@@ -14318,6 +14318,11 @@ components:
           type: boolean
           description: Should progressive billing be allowed for this workflow?
           default: true
+        subscriptionEndProrationMode:
+          allOf:
+            - $ref: '#/components/schemas/BillingWorkflowInvoicingSubscriptionEndProrationMode'
+          description: Controls how subscription-ending shortened service periods are billed.
+          default: bill_actual_period
         defaultTaxConfig:
           allOf:
             - $ref: '#/components/schemas/TaxConfig'
@@ -14330,6 +14335,12 @@ components:
             fully supported.
       description: BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow
       title: Workflow invoice settings
+    BillingWorkflowInvoicingSubscriptionEndProrationMode:
+      type: string
+      enum:
+        - bill_full_period
+        - bill_actual_period
+      description: Billing workflow subscription end proration mode.
     BillingWorkflowLineResolution:
       type: string
       enum:
@@ -20482,6 +20493,11 @@ components:
             With some payment solutions it's only applicable for manual collection method.
           example: P30D
           default: P30D
+        subscriptionEndProrationMode:
+          allOf:
+            - $ref: '#/components/schemas/BillingWorkflowInvoicingSubscriptionEndProrationMode'
+          description: Controls how subscription-ending shortened service periods are billed.
+          default: bill_actual_period
         defaultTaxConfig:
           allOf:
             - $ref: '#/components/schemas/TaxConfig'

api/client/python/openmeter/_generated/models/__init__.py

@@ -65,7 +65,6 @@ export type {
   FlatFeeDiscounts,
   PriceFree,
   WorkflowCollectionAlignmentSubscription,
-  WorkflowInvoicingSettings,
   WorkflowPaymentChargeAutomaticallySettings,
   WorkflowPaymentSendInvoiceSettings,
   LlmCostProvider,
@@ -173,6 +172,7 @@ export type {
   AppCatalogItem,
   TaxCodeAppMapping,
   PartyTaxIdentity,
+  WorkflowInvoicingSettings,
   ListCurrenciesParamsFilter,
   CurrencyCustom,
   CreateCurrencyCustomRequest,
@@ -289,7 +289,6 @@ export type {
   PlanPagePaginatedResponse,
   SortQueryInput,
   BaseErrorInput,
-  WorkflowInvoicingSettingsInput,
   WorkflowPaymentSendInvoiceSettingsInput,
   EventInput,
   UnauthorizedInput,
@@ -309,6 +308,7 @@ export type {
   CreateCreditGrantPurchaseInput,
   RateCardMeteredEntitlementInput,
   CreditGrantPurchaseInput,
+  WorkflowInvoicingSettingsInput,
   UnitConfigInput,
   GovernanceQueryRequestInput,
   IngestedEventInput,