@openmeter/sdk 1.0.0-beta-a8cd4ec176bb → 1.0.0-beta-facf3b09ebaf

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1473,6 +1473,7 @@ export declare const updateInvoiceBodyLinesItemIdRegExp: RegExp;
1473
1473
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneAutoAdvanceDefault = true;
1474
1474
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDraftPeriodDefault = "P0D";
1475
1475
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDueAfterDefault = "P30D";
1476
+ export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = "bill_actual_period";
1476
1477
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp: RegExp;
1477
1478
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp: RegExp;
1478
1479
  export declare const updateInvoiceBodyWorkflowOneWorkflowOnePaymentOneCollectionMethodDefault = "charge_automatically";
@@ -1695,6 +1696,10 @@ export declare const UpdateInvoiceBody: zod.ZodObject<{
1695
1696
  }, zod.z.core.$strip>>;
1696
1697
  draftPeriod: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
1697
1698
  dueAfter: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
1699
+ subscriptionEndProrationMode: zod.ZodDefault<zod.ZodEnum<{
1700
+ bill_full_period: "bill_full_period";
1701
+ bill_actual_period: "bill_actual_period";
1702
+ }>>;
1698
1703
  }, zod.z.core.$strip>;
1699
1704
  payment: zod.ZodObject<{
1700
1705
  collectionMethod: zod.ZodDefault<zod.ZodEnum<{
@@ -1864,6 +1869,7 @@ export declare const createBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceD
1864
1869
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = "P0D";
1865
1870
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = "P30D";
1866
1871
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
1872
+ export declare const createBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = "bill_actual_period";
1867
1873
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp: RegExp;
1868
1874
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp: RegExp;
1869
1875
  export declare const createBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = "charge_automatically";
@@ -1939,6 +1945,10 @@ export declare const CreateBillingProfileBody: zod.ZodObject<{
1939
1945
  draftPeriod: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
1940
1946
  dueAfter: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
1941
1947
  progressiveBilling: zod.ZodDefault<zod.z.ZodCoercedBoolean<unknown>>;
1948
+ subscriptionEndProrationMode: zod.ZodDefault<zod.ZodEnum<{
1949
+ bill_full_period: "bill_full_period";
1950
+ bill_actual_period: "bill_actual_period";
1951
+ }>>;
1942
1952
  }, zod.z.core.$strip>>;
1943
1953
  payment: zod.ZodOptional<zod.ZodObject<{
1944
1954
  collectionMethod: zod.ZodDefault<zod.ZodEnum<{
@@ -2010,6 +2020,7 @@ export declare const updateBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceD
2010
2020
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = "P0D";
2011
2021
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = "P30D";
2012
2022
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
2023
+ export declare const updateBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = "bill_actual_period";
2013
2024
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp: RegExp;
2014
2025
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp: RegExp;
2015
2026
  export declare const updateBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = "charge_automatically";
@@ -2077,6 +2088,10 @@ export declare const UpdateBillingProfileBody: zod.ZodObject<{
2077
2088
  draftPeriod: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
2078
2089
  dueAfter: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
2079
2090
  progressiveBilling: zod.ZodDefault<zod.z.ZodCoercedBoolean<unknown>>;
2091
+ subscriptionEndProrationMode: zod.ZodDefault<zod.ZodEnum<{
2092
+ bill_full_period: "bill_full_period";
2093
+ bill_actual_period: "bill_actual_period";
2094
+ }>>;
2080
2095
  }, zod.z.core.$strip>>;
2081
2096
  payment: zod.ZodOptional<zod.ZodObject<{
2082
2097
  collectionMethod: zod.ZodDefault<zod.ZodEnum<{
@@ -3370,6 +3370,11 @@ export interface components {
3370
3370
  * @default true
3371
3371
  */
3372
3372
  progressiveBilling?: boolean;
3373
+ /**
3374
+ * @description Controls how subscription-ending shortened service periods are billed.
3375
+ * @default bill_actual_period
3376
+ */
3377
+ subscriptionEndProrationMode?: components['schemas']['BillingWorkflowInvoicingSubscriptionEndProrationMode'];
3373
3378
  /**
3374
3379
  * @description Default tax configuration to apply to the invoices.
3375
3380
  *
@@ -3380,6 +3385,11 @@ export interface components {
3380
3385
  */
3381
3386
  defaultTaxConfig?: components['schemas']['TaxConfig'];
3382
3387
  };
3388
+ /**
3389
+ * @description Billing workflow subscription end proration mode.
3390
+ * @enum {string}
3391
+ */
3392
+ BillingWorkflowInvoicingSubscriptionEndProrationMode: 'bill_full_period' | 'bill_actual_period';
3383
3393
  /**
3384
3394
  * Workflow payment settings
3385
3395
  * @description BillingWorkflowPaymentSettings represents the payment settings for a billing workflow
@@ -7660,6 +7670,11 @@ export interface components {
7660
7670
  * @example P30D
7661
7671
  */
7662
7672
  dueAfter?: string;
7673
+ /**
7674
+ * @description Controls how subscription-ending shortened service periods are billed.
7675
+ * @default bill_actual_period
7676
+ */
7677
+ subscriptionEndProrationMode?: components['schemas']['BillingWorkflowInvoicingSubscriptionEndProrationMode'];
7663
7678
  /**
7664
7679
  * @description Default tax configuration to apply to the invoices.
7665
7680
  *
@@ -12313,6 +12328,7 @@ export type BillingWorkflowCollectionAlignmentSubscription = components['schemas
12313
12328
  export type BillingWorkflowCollectionSettings = components['schemas']['BillingWorkflowCollectionSettings'];
12314
12329
  export type BillingWorkflowCreate = components['schemas']['BillingWorkflowCreate'];
12315
12330
  export type BillingWorkflowInvoicingSettings = components['schemas']['BillingWorkflowInvoicingSettings'];
12331
+ export type BillingWorkflowInvoicingSubscriptionEndProrationMode = components['schemas']['BillingWorkflowInvoicingSubscriptionEndProrationMode'];
12316
12332
  export type BillingWorkflowPaymentSettings = components['schemas']['BillingWorkflowPaymentSettings'];
12317
12333
  export type BillingWorkflowTaxSettings = components['schemas']['BillingWorkflowTaxSettings'];
12318
12334
  export type CheckoutSessionCustomTextAfterSubmitParams = components['schemas']['CheckoutSessionCustomTextAfterSubmitParams'];
@@ -1473,6 +1473,7 @@ export declare const updateInvoiceBodyLinesItemIdRegExp: RegExp;
1473
1473
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneAutoAdvanceDefault = true;
1474
1474
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDraftPeriodDefault = "P0D";
1475
1475
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDueAfterDefault = "P30D";
1476
+ export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = "bill_actual_period";
1476
1477
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp: RegExp;
1477
1478
  export declare const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp: RegExp;
1478
1479
  export declare const updateInvoiceBodyWorkflowOneWorkflowOnePaymentOneCollectionMethodDefault = "charge_automatically";
@@ -1695,6 +1696,10 @@ export declare const UpdateInvoiceBody: zod.ZodObject<{
1695
1696
  }, zod.z.core.$strip>>;
1696
1697
  draftPeriod: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
1697
1698
  dueAfter: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
1699
+ subscriptionEndProrationMode: zod.ZodDefault<zod.ZodEnum<{
1700
+ bill_full_period: "bill_full_period";
1701
+ bill_actual_period: "bill_actual_period";
1702
+ }>>;
1698
1703
  }, zod.z.core.$strip>;
1699
1704
  payment: zod.ZodObject<{
1700
1705
  collectionMethod: zod.ZodDefault<zod.ZodEnum<{
@@ -1864,6 +1869,7 @@ export declare const createBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceD
1864
1869
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = "P0D";
1865
1870
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = "P30D";
1866
1871
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
1872
+ export declare const createBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = "bill_actual_period";
1867
1873
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp: RegExp;
1868
1874
  export declare const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp: RegExp;
1869
1875
  export declare const createBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = "charge_automatically";
@@ -1939,6 +1945,10 @@ export declare const CreateBillingProfileBody: zod.ZodObject<{
1939
1945
  draftPeriod: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
1940
1946
  dueAfter: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
1941
1947
  progressiveBilling: zod.ZodDefault<zod.z.ZodCoercedBoolean<unknown>>;
1948
+ subscriptionEndProrationMode: zod.ZodDefault<zod.ZodEnum<{
1949
+ bill_full_period: "bill_full_period";
1950
+ bill_actual_period: "bill_actual_period";
1951
+ }>>;
1942
1952
  }, zod.z.core.$strip>>;
1943
1953
  payment: zod.ZodOptional<zod.ZodObject<{
1944
1954
  collectionMethod: zod.ZodDefault<zod.ZodEnum<{
@@ -2010,6 +2020,7 @@ export declare const updateBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceD
2010
2020
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = "P0D";
2011
2021
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = "P30D";
2012
2022
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
2023
+ export declare const updateBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = "bill_actual_period";
2013
2024
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp: RegExp;
2014
2025
  export declare const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp: RegExp;
2015
2026
  export declare const updateBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = "charge_automatically";
@@ -2077,6 +2088,10 @@ export declare const UpdateBillingProfileBody: zod.ZodObject<{
2077
2088
  draftPeriod: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
2078
2089
  dueAfter: zod.ZodDefault<zod.z.ZodCoercedString<unknown>>;
2079
2090
  progressiveBilling: zod.ZodDefault<zod.z.ZodCoercedBoolean<unknown>>;
2091
+ subscriptionEndProrationMode: zod.ZodDefault<zod.ZodEnum<{
2092
+ bill_full_period: "bill_full_period";
2093
+ bill_actual_period: "bill_actual_period";
2094
+ }>>;
2080
2095
  }, zod.z.core.$strip>>;
2081
2096
  payment: zod.ZodOptional<zod.ZodObject<{
2082
2097
  collectionMethod: zod.ZodDefault<zod.ZodEnum<{
@@ -3173,6 +3173,7 @@ export const updateInvoiceBodyLinesItemIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkm
3173
3173
  export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneAutoAdvanceDefault = true;
3174
3174
  export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDraftPeriodDefault = 'P0D';
3175
3175
  export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDueAfterDefault = 'P30D';
3176
+ export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = 'bill_actual_period';
3176
3177
  export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp = /^txcd_\d{8}$/;
3177
3178
  export const updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
3178
3179
  export const updateInvoiceBodyWorkflowOneWorkflowOnePaymentOneCollectionMethodDefault = 'charge_automatically';
@@ -3860,6 +3861,11 @@ export const UpdateInvoiceBody = zod
3860
3861
  .string()
3861
3862
  .default(updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneDueAfterDefault)
3862
3863
  .describe("The period after which the invoice is due.\nWith some payment solutions it's only applicable for manual collection method."),
3864
+ subscriptionEndProrationMode: zod
3865
+ .enum(['bill_full_period', 'bill_actual_period'])
3866
+ .describe('Billing workflow subscription end proration mode.')
3867
+ .default(updateInvoiceBodyWorkflowOneWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault)
3868
+ .describe('Controls how subscription-ending shortened service periods are billed.'),
3863
3869
  })
3864
3870
  .describe('InvoiceWorkflowInvoicingSettingsReplaceUpdate represents the update model for the invoicing settings of an invoice workflow.')
3865
3871
  .describe('The invoicing settings for this workflow'),
@@ -4102,6 +4108,7 @@ export const createBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceDefault =
4102
4108
  export const createBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = 'P0D';
4103
4109
  export const createBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = 'P30D';
4104
4110
  export const createBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
4111
+ export const createBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = 'bill_actual_period';
4105
4112
  export const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp = /^txcd_\d{8}$/;
4106
4113
  export const createBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
4107
4114
  export const createBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = 'charge_automatically';
@@ -4318,6 +4325,11 @@ export const CreateBillingProfileBody = zod
4318
4325
  .boolean()
4319
4326
  .default(createBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault)
4320
4327
  .describe('Should progressive billing be allowed for this workflow?'),
4328
+ subscriptionEndProrationMode: zod
4329
+ .enum(['bill_full_period', 'bill_actual_period'])
4330
+ .describe('Billing workflow subscription end proration mode.')
4331
+ .default(createBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault)
4332
+ .describe('Controls how subscription-ending shortened service periods are billed.'),
4321
4333
  })
4322
4334
  .describe('BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow')
4323
4335
  .optional()
@@ -4410,6 +4422,7 @@ export const updateBillingProfileBodyWorkflowOneInvoicingOneAutoAdvanceDefault =
4410
4422
  export const updateBillingProfileBodyWorkflowOneInvoicingOneDraftPeriodDefault = 'P0D';
4411
4423
  export const updateBillingProfileBodyWorkflowOneInvoicingOneDueAfterDefault = 'P30D';
4412
4424
  export const updateBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault = true;
4425
+ export const updateBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault = 'bill_actual_period';
4413
4426
  export const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneStripeOneCodeRegExp = /^txcd_\d{8}$/;
4414
4427
  export const updateBillingProfileBodyWorkflowOneInvoicingOneDefaultTaxConfigOneTaxCodeIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
4415
4428
  export const updateBillingProfileBodyWorkflowOnePaymentOneCollectionMethodDefault = 'charge_automatically';
@@ -4606,6 +4619,11 @@ export const UpdateBillingProfileBody = zod
4606
4619
  .boolean()
4607
4620
  .default(updateBillingProfileBodyWorkflowOneInvoicingOneProgressiveBillingDefault)
4608
4621
  .describe('Should progressive billing be allowed for this workflow?'),
4622
+ subscriptionEndProrationMode: zod
4623
+ .enum(['bill_full_period', 'bill_actual_period'])
4624
+ .describe('Billing workflow subscription end proration mode.')
4625
+ .default(updateBillingProfileBodyWorkflowOneInvoicingOneSubscriptionEndProrationModeDefault)
4626
+ .describe('Controls how subscription-ending shortened service periods are billed.'),
4609
4627
  })
4610
4628
  .describe('BillingWorkflowInvoicingSettings represents the invoice settings for a billing workflow')
4611
4629
  .optional()