@openmeter/sdk 1.0.0-beta-fff5f33f03cb → 1.0.0-beta-c8d16f2a19f9

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.
@@ -9595,6 +9595,12 @@ export declare const createPlanBodyCurrencyMinOne = 3;
9595
9595
  export declare const createPlanBodyCurrencyMaxOne = 3;
9596
9596
  export declare const createPlanBodyCurrencyRegExpOne: RegExp;
9597
9597
  export declare const createPlanBodyCurrencyDefault = "USD";
9598
+ export declare const createPlanBodyProRatingConfigEnabledDefault = true;
9599
+ export declare const createPlanBodyProRatingConfigModeDefault = "prorate_prices";
9600
+ export declare const createPlanBodyProRatingConfigDefault: {
9601
+ enabled: boolean;
9602
+ mode: string;
9603
+ };
9598
9604
  export declare const createPlanBodyPhasesItemKeyMax = 64;
9599
9605
  export declare const createPlanBodyPhasesItemKeyRegExp: RegExp;
9600
9606
  export declare const createPlanBodyPhasesItemNameMax = 256;
@@ -9653,6 +9659,7 @@ export declare const createPlanBody: zod.ZodObject<{
9653
9659
  }, {
9654
9660
  billablesMustAlign?: boolean | undefined;
9655
9661
  }>>;
9662
+ billingCadence: zod.ZodString;
9656
9663
  currency: zod.ZodString;
9657
9664
  description: zod.ZodOptional<zod.ZodString>;
9658
9665
  key: zod.ZodString;
@@ -10564,10 +10571,21 @@ export declare const createPlanBody: zod.ZodObject<{
10564
10571
  description?: string | undefined;
10565
10572
  metadata?: Record<string, string> | null | undefined;
10566
10573
  }>, "many">;
10574
+ proRatingConfig: zod.ZodDefault<zod.ZodObject<{
10575
+ enabled: zod.ZodBoolean;
10576
+ mode: zod.ZodEnum<["prorate_prices"]>;
10577
+ }, "strip", zod.ZodTypeAny, {
10578
+ mode: "prorate_prices";
10579
+ enabled: boolean;
10580
+ }, {
10581
+ mode: "prorate_prices";
10582
+ enabled: boolean;
10583
+ }>>;
10567
10584
  }, "strip", zod.ZodTypeAny, {
10568
10585
  key: string;
10569
10586
  name: string;
10570
10587
  currency: string;
10588
+ billingCadence: string;
10571
10589
  phases: {
10572
10590
  key: string;
10573
10591
  name: string;
@@ -10700,6 +10718,10 @@ export declare const createPlanBody: zod.ZodObject<{
10700
10718
  description?: string | undefined;
10701
10719
  metadata?: Record<string, string> | null | undefined;
10702
10720
  }[];
10721
+ proRatingConfig: {
10722
+ mode: "prorate_prices";
10723
+ enabled: boolean;
10724
+ };
10703
10725
  description?: string | undefined;
10704
10726
  metadata?: Record<string, string> | null | undefined;
10705
10727
  alignment?: {
@@ -10709,6 +10731,7 @@ export declare const createPlanBody: zod.ZodObject<{
10709
10731
  key: string;
10710
10732
  name: string;
10711
10733
  currency: string;
10734
+ billingCadence: string;
10712
10735
  phases: {
10713
10736
  key: string;
10714
10737
  name: string;
@@ -10846,6 +10869,10 @@ export declare const createPlanBody: zod.ZodObject<{
10846
10869
  alignment?: {
10847
10870
  billablesMustAlign?: boolean | undefined;
10848
10871
  } | undefined;
10872
+ proRatingConfig?: {
10873
+ mode: "prorate_prices";
10874
+ enabled: boolean;
10875
+ } | undefined;
10849
10876
  }>;
10850
10877
  /**
10851
10878
  * Create a new draft version from plan.
@@ -10876,6 +10903,12 @@ export declare const updatePlanParams: zod.ZodObject<{
10876
10903
  }>;
10877
10904
  export declare const updatePlanBodyNameMax = 256;
10878
10905
  export declare const updatePlanBodyDescriptionMax = 1024;
10906
+ export declare const updatePlanBodyProRatingConfigEnabledDefault = true;
10907
+ export declare const updatePlanBodyProRatingConfigModeDefault = "prorate_prices";
10908
+ export declare const updatePlanBodyProRatingConfigDefault: {
10909
+ enabled: boolean;
10910
+ mode: string;
10911
+ };
10879
10912
  export declare const updatePlanBodyPhasesItemKeyMax = 64;
10880
10913
  export declare const updatePlanBodyPhasesItemKeyRegExp: RegExp;
10881
10914
  export declare const updatePlanBodyPhasesItemNameMax = 256;
@@ -10934,6 +10967,7 @@ export declare const updatePlanBody: zod.ZodObject<{
10934
10967
  }, {
10935
10968
  billablesMustAlign?: boolean | undefined;
10936
10969
  }>>;
10970
+ billingCadence: zod.ZodString;
10937
10971
  description: zod.ZodOptional<zod.ZodString>;
10938
10972
  metadata: zod.ZodOptional<zod.ZodNullable<zod.ZodRecord<zod.ZodString, zod.ZodString>>>;
10939
10973
  name: zod.ZodString;
@@ -11843,8 +11877,19 @@ export declare const updatePlanBody: zod.ZodObject<{
11843
11877
  description?: string | undefined;
11844
11878
  metadata?: Record<string, string> | null | undefined;
11845
11879
  }>, "many">;
11880
+ proRatingConfig: zod.ZodDefault<zod.ZodObject<{
11881
+ enabled: zod.ZodBoolean;
11882
+ mode: zod.ZodEnum<["prorate_prices"]>;
11883
+ }, "strip", zod.ZodTypeAny, {
11884
+ mode: "prorate_prices";
11885
+ enabled: boolean;
11886
+ }, {
11887
+ mode: "prorate_prices";
11888
+ enabled: boolean;
11889
+ }>>;
11846
11890
  }, "strip", zod.ZodTypeAny, {
11847
11891
  name: string;
11892
+ billingCadence: string;
11848
11893
  phases: {
11849
11894
  key: string;
11850
11895
  name: string;
@@ -11977,6 +12022,10 @@ export declare const updatePlanBody: zod.ZodObject<{
11977
12022
  description?: string | undefined;
11978
12023
  metadata?: Record<string, string> | null | undefined;
11979
12024
  }[];
12025
+ proRatingConfig: {
12026
+ mode: "prorate_prices";
12027
+ enabled: boolean;
12028
+ };
11980
12029
  description?: string | undefined;
11981
12030
  metadata?: Record<string, string> | null | undefined;
11982
12031
  alignment?: {
@@ -11984,6 +12033,7 @@ export declare const updatePlanBody: zod.ZodObject<{
11984
12033
  } | undefined;
11985
12034
  }, {
11986
12035
  name: string;
12036
+ billingCadence: string;
11987
12037
  phases: {
11988
12038
  key: string;
11989
12039
  name: string;
@@ -12121,6 +12171,10 @@ export declare const updatePlanBody: zod.ZodObject<{
12121
12171
  alignment?: {
12122
12172
  billablesMustAlign?: boolean | undefined;
12123
12173
  } | undefined;
12174
+ proRatingConfig?: {
12175
+ mode: "prorate_prices";
12176
+ enabled: boolean;
12177
+ } | undefined;
12124
12178
  }>;
12125
12179
  /**
12126
12180
  * Get a plan by id or key. The latest published version is returned if latter is used.
@@ -13505,6 +13559,12 @@ export declare const createSubscriptionBodyCustomPlanCurrencyMinOne = 3;
13505
13559
  export declare const createSubscriptionBodyCustomPlanCurrencyMaxOne = 3;
13506
13560
  export declare const createSubscriptionBodyCustomPlanCurrencyRegExpOne: RegExp;
13507
13561
  export declare const createSubscriptionBodyCustomPlanCurrencyDefault = "USD";
13562
+ export declare const createSubscriptionBodyCustomPlanProRatingConfigEnabledDefault = true;
13563
+ export declare const createSubscriptionBodyCustomPlanProRatingConfigModeDefault = "prorate_prices";
13564
+ export declare const createSubscriptionBodyCustomPlanProRatingConfigDefault: {
13565
+ enabled: boolean;
13566
+ mode: string;
13567
+ };
13508
13568
  export declare const createSubscriptionBodyCustomPlanPhasesItemKeyMax = 64;
13509
13569
  export declare const createSubscriptionBodyCustomPlanPhasesItemKeyRegExp: RegExp;
13510
13570
  export declare const createSubscriptionBodyCustomPlanPhasesItemNameMax = 256;
@@ -13624,6 +13684,7 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
13624
13684
  }, {
13625
13685
  billablesMustAlign?: boolean | undefined;
13626
13686
  }>>;
13687
+ billingCadence: zod.ZodString;
13627
13688
  currency: zod.ZodString;
13628
13689
  description: zod.ZodOptional<zod.ZodString>;
13629
13690
  metadata: zod.ZodOptional<zod.ZodNullable<zod.ZodRecord<zod.ZodString, zod.ZodString>>>;
@@ -14534,9 +14595,20 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
14534
14595
  description?: string | undefined;
14535
14596
  metadata?: Record<string, string> | null | undefined;
14536
14597
  }>, "many">;
14598
+ proRatingConfig: zod.ZodDefault<zod.ZodObject<{
14599
+ enabled: zod.ZodBoolean;
14600
+ mode: zod.ZodEnum<["prorate_prices"]>;
14601
+ }, "strip", zod.ZodTypeAny, {
14602
+ mode: "prorate_prices";
14603
+ enabled: boolean;
14604
+ }, {
14605
+ mode: "prorate_prices";
14606
+ enabled: boolean;
14607
+ }>>;
14537
14608
  }, "strip", zod.ZodTypeAny, {
14538
14609
  name: string;
14539
14610
  currency: string;
14611
+ billingCadence: string;
14540
14612
  phases: {
14541
14613
  key: string;
14542
14614
  name: string;
@@ -14669,6 +14741,10 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
14669
14741
  description?: string | undefined;
14670
14742
  metadata?: Record<string, string> | null | undefined;
14671
14743
  }[];
14744
+ proRatingConfig: {
14745
+ mode: "prorate_prices";
14746
+ enabled: boolean;
14747
+ };
14672
14748
  description?: string | undefined;
14673
14749
  metadata?: Record<string, string> | null | undefined;
14674
14750
  alignment?: {
@@ -14677,6 +14753,7 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
14677
14753
  }, {
14678
14754
  name: string;
14679
14755
  currency: string;
14756
+ billingCadence: string;
14680
14757
  phases: {
14681
14758
  key: string;
14682
14759
  name: string;
@@ -14814,6 +14891,10 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
14814
14891
  alignment?: {
14815
14892
  billablesMustAlign?: boolean | undefined;
14816
14893
  } | undefined;
14894
+ proRatingConfig?: {
14895
+ mode: "prorate_prices";
14896
+ enabled: boolean;
14897
+ } | undefined;
14817
14898
  }>;
14818
14899
  timing: zod.ZodDefault<zod.ZodUnion<[zod.ZodEnum<["immediate", "next_billing_cycle"]>, zod.ZodDate]>>;
14819
14900
  }, "strip", zod.ZodTypeAny, {
@@ -14821,6 +14902,7 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
14821
14902
  customPlan: {
14822
14903
  name: string;
14823
14904
  currency: string;
14905
+ billingCadence: string;
14824
14906
  phases: {
14825
14907
  key: string;
14826
14908
  name: string;
@@ -14953,6 +15035,10 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
14953
15035
  description?: string | undefined;
14954
15036
  metadata?: Record<string, string> | null | undefined;
14955
15037
  }[];
15038
+ proRatingConfig: {
15039
+ mode: "prorate_prices";
15040
+ enabled: boolean;
15041
+ };
14956
15042
  description?: string | undefined;
14957
15043
  metadata?: Record<string, string> | null | undefined;
14958
15044
  alignment?: {
@@ -14965,6 +15051,7 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
14965
15051
  customPlan: {
14966
15052
  name: string;
14967
15053
  currency: string;
15054
+ billingCadence: string;
14968
15055
  phases: {
14969
15056
  key: string;
14970
15057
  name: string;
@@ -15102,6 +15189,10 @@ export declare const createSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
15102
15189
  alignment?: {
15103
15190
  billablesMustAlign?: boolean | undefined;
15104
15191
  } | undefined;
15192
+ proRatingConfig?: {
15193
+ mode: "prorate_prices";
15194
+ enabled: boolean;
15195
+ } | undefined;
15105
15196
  };
15106
15197
  customerId?: string | undefined;
15107
15198
  customerKey?: string | undefined;
@@ -16722,6 +16813,12 @@ export declare const changeSubscriptionBodyCustomPlanCurrencyMinOne = 3;
16722
16813
  export declare const changeSubscriptionBodyCustomPlanCurrencyMaxOne = 3;
16723
16814
  export declare const changeSubscriptionBodyCustomPlanCurrencyRegExpOne: RegExp;
16724
16815
  export declare const changeSubscriptionBodyCustomPlanCurrencyDefault = "USD";
16816
+ export declare const changeSubscriptionBodyCustomPlanProRatingConfigEnabledDefault = true;
16817
+ export declare const changeSubscriptionBodyCustomPlanProRatingConfigModeDefault = "prorate_prices";
16818
+ export declare const changeSubscriptionBodyCustomPlanProRatingConfigDefault: {
16819
+ enabled: boolean;
16820
+ mode: string;
16821
+ };
16725
16822
  export declare const changeSubscriptionBodyCustomPlanPhasesItemKeyMax = 64;
16726
16823
  export declare const changeSubscriptionBodyCustomPlanPhasesItemKeyRegExp: RegExp;
16727
16824
  export declare const changeSubscriptionBodyCustomPlanPhasesItemNameMax = 256;
@@ -16830,6 +16927,7 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
16830
16927
  }, {
16831
16928
  billablesMustAlign?: boolean | undefined;
16832
16929
  }>>;
16930
+ billingCadence: zod.ZodString;
16833
16931
  currency: zod.ZodString;
16834
16932
  description: zod.ZodOptional<zod.ZodString>;
16835
16933
  metadata: zod.ZodOptional<zod.ZodNullable<zod.ZodRecord<zod.ZodString, zod.ZodString>>>;
@@ -17740,9 +17838,20 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
17740
17838
  description?: string | undefined;
17741
17839
  metadata?: Record<string, string> | null | undefined;
17742
17840
  }>, "many">;
17841
+ proRatingConfig: zod.ZodDefault<zod.ZodObject<{
17842
+ enabled: zod.ZodBoolean;
17843
+ mode: zod.ZodEnum<["prorate_prices"]>;
17844
+ }, "strip", zod.ZodTypeAny, {
17845
+ mode: "prorate_prices";
17846
+ enabled: boolean;
17847
+ }, {
17848
+ mode: "prorate_prices";
17849
+ enabled: boolean;
17850
+ }>>;
17743
17851
  }, "strip", zod.ZodTypeAny, {
17744
17852
  name: string;
17745
17853
  currency: string;
17854
+ billingCadence: string;
17746
17855
  phases: {
17747
17856
  key: string;
17748
17857
  name: string;
@@ -17875,6 +17984,10 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
17875
17984
  description?: string | undefined;
17876
17985
  metadata?: Record<string, string> | null | undefined;
17877
17986
  }[];
17987
+ proRatingConfig: {
17988
+ mode: "prorate_prices";
17989
+ enabled: boolean;
17990
+ };
17878
17991
  description?: string | undefined;
17879
17992
  metadata?: Record<string, string> | null | undefined;
17880
17993
  alignment?: {
@@ -17883,6 +17996,7 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
17883
17996
  }, {
17884
17997
  name: string;
17885
17998
  currency: string;
17999
+ billingCadence: string;
17886
18000
  phases: {
17887
18001
  key: string;
17888
18002
  name: string;
@@ -18020,6 +18134,10 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
18020
18134
  alignment?: {
18021
18135
  billablesMustAlign?: boolean | undefined;
18022
18136
  } | undefined;
18137
+ proRatingConfig?: {
18138
+ mode: "prorate_prices";
18139
+ enabled: boolean;
18140
+ } | undefined;
18023
18141
  }>;
18024
18142
  timing: zod.ZodUnion<[zod.ZodEnum<["immediate", "next_billing_cycle"]>, zod.ZodDate]>;
18025
18143
  }, "strip", zod.ZodTypeAny, {
@@ -18027,6 +18145,7 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
18027
18145
  customPlan: {
18028
18146
  name: string;
18029
18147
  currency: string;
18148
+ billingCadence: string;
18030
18149
  phases: {
18031
18150
  key: string;
18032
18151
  name: string;
@@ -18159,6 +18278,10 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
18159
18278
  description?: string | undefined;
18160
18279
  metadata?: Record<string, string> | null | undefined;
18161
18280
  }[];
18281
+ proRatingConfig: {
18282
+ mode: "prorate_prices";
18283
+ enabled: boolean;
18284
+ };
18162
18285
  description?: string | undefined;
18163
18286
  metadata?: Record<string, string> | null | undefined;
18164
18287
  alignment?: {
@@ -18170,6 +18293,7 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
18170
18293
  customPlan: {
18171
18294
  name: string;
18172
18295
  currency: string;
18296
+ billingCadence: string;
18173
18297
  phases: {
18174
18298
  key: string;
18175
18299
  name: string;
@@ -18307,6 +18431,10 @@ export declare const changeSubscriptionBody: zod.ZodUnion<[zod.ZodObject<{
18307
18431
  alignment?: {
18308
18432
  billablesMustAlign?: boolean | undefined;
18309
18433
  } | undefined;
18434
+ proRatingConfig?: {
18435
+ mode: "prorate_prices";
18436
+ enabled: boolean;
18437
+ } | undefined;
18310
18438
  };
18311
18439
  }>]>;
18312
18440
  /**
@@ -6285,6 +6285,12 @@ export const createPlanBodyCurrencyMinOne = 3;
6285
6285
  export const createPlanBodyCurrencyMaxOne = 3;
6286
6286
  export const createPlanBodyCurrencyRegExpOne = new RegExp('^[A-Z]{3}$');
6287
6287
  export const createPlanBodyCurrencyDefault = 'USD';
6288
+ export const createPlanBodyProRatingConfigEnabledDefault = true;
6289
+ export const createPlanBodyProRatingConfigModeDefault = 'prorate_prices';
6290
+ export const createPlanBodyProRatingConfigDefault = {
6291
+ enabled: true,
6292
+ mode: 'prorate_prices',
6293
+ };
6288
6294
  export const createPlanBodyPhasesItemKeyMax = 64;
6289
6295
  export const createPlanBodyPhasesItemKeyRegExp = new RegExp('^[a-z0-9]+(?:_[a-z0-9]+)*$');
6290
6296
  export const createPlanBodyPhasesItemNameMax = 256;
@@ -6347,6 +6353,9 @@ export const createPlanBody = zod
6347
6353
  .describe('Alignment configuration for a plan or subscription.')
6348
6354
  .optional()
6349
6355
  .describe('Alignment configuration for the plan.'),
6356
+ billingCadence: zod
6357
+ .string()
6358
+ .describe('The default billing cadence for subscriptions using this plan.\nDefines how often customers are billed using ISO8601 duration format.\nExamples: \"P1M\" (monthly), \"P3M\" (quarterly), \"P1Y\" (annually).'),
6350
6359
  currency: zod
6351
6360
  .string()
6352
6361
  .min(createPlanBodyCurrencyMinOne)
@@ -6896,6 +6905,19 @@ export const createPlanBody = zod
6896
6905
  .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses."))
6897
6906
  .min(1)
6898
6907
  .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.\nA phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices."),
6908
+ proRatingConfig: zod
6909
+ .object({
6910
+ enabled: zod
6911
+ .boolean()
6912
+ .describe('Whether pro-rating is enabled for this plan.'),
6913
+ mode: zod
6914
+ .enum(['prorate_prices'])
6915
+ .describe('Pro-rating mode options for handling billing period changes.')
6916
+ .describe('How to handle pro-rating for billing period changes.'),
6917
+ })
6918
+ .describe('Configuration for pro-rating behavior.')
6919
+ .default(createPlanBodyProRatingConfigDefault)
6920
+ .describe('Default pro-rating configuration for subscriptions using this plan.'),
6899
6921
  })
6900
6922
  .describe('Resource create operation model.');
6901
6923
  /**
@@ -6923,6 +6945,12 @@ export const updatePlanParams = zod.object({
6923
6945
  });
6924
6946
  export const updatePlanBodyNameMax = 256;
6925
6947
  export const updatePlanBodyDescriptionMax = 1024;
6948
+ export const updatePlanBodyProRatingConfigEnabledDefault = true;
6949
+ export const updatePlanBodyProRatingConfigModeDefault = 'prorate_prices';
6950
+ export const updatePlanBodyProRatingConfigDefault = {
6951
+ enabled: true,
6952
+ mode: 'prorate_prices',
6953
+ };
6926
6954
  export const updatePlanBodyPhasesItemKeyMax = 64;
6927
6955
  export const updatePlanBodyPhasesItemKeyRegExp = new RegExp('^[a-z0-9]+(?:_[a-z0-9]+)*$');
6928
6956
  export const updatePlanBodyPhasesItemNameMax = 256;
@@ -6985,6 +7013,9 @@ export const updatePlanBody = zod
6985
7013
  .describe('Alignment configuration for a plan or subscription.')
6986
7014
  .optional()
6987
7015
  .describe('Alignment configuration for the plan.'),
7016
+ billingCadence: zod
7017
+ .string()
7018
+ .describe('The default billing cadence for subscriptions using this plan.\nDefines how often customers are billed using ISO8601 duration format.\nExamples: \"P1M\" (monthly), \"P3M\" (quarterly), \"P1Y\" (annually).'),
6988
7019
  description: zod
6989
7020
  .string()
6990
7021
  .max(updatePlanBodyDescriptionMax)
@@ -7521,6 +7552,19 @@ export const updatePlanBody = zod
7521
7552
  .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses."))
7522
7553
  .min(1)
7523
7554
  .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.\nA phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices."),
7555
+ proRatingConfig: zod
7556
+ .object({
7557
+ enabled: zod
7558
+ .boolean()
7559
+ .describe('Whether pro-rating is enabled for this plan.'),
7560
+ mode: zod
7561
+ .enum(['prorate_prices'])
7562
+ .describe('Pro-rating mode options for handling billing period changes.')
7563
+ .describe('How to handle pro-rating for billing period changes.'),
7564
+ })
7565
+ .describe('Configuration for pro-rating behavior.')
7566
+ .default(updatePlanBodyProRatingConfigDefault)
7567
+ .describe('Default pro-rating configuration for subscriptions using this plan.'),
7524
7568
  })
7525
7569
  .describe('Resource update operation model.');
7526
7570
  /**
@@ -8702,6 +8746,12 @@ export const createSubscriptionBodyCustomPlanCurrencyMinOne = 3;
8702
8746
  export const createSubscriptionBodyCustomPlanCurrencyMaxOne = 3;
8703
8747
  export const createSubscriptionBodyCustomPlanCurrencyRegExpOne = new RegExp('^[A-Z]{3}$');
8704
8748
  export const createSubscriptionBodyCustomPlanCurrencyDefault = 'USD';
8749
+ export const createSubscriptionBodyCustomPlanProRatingConfigEnabledDefault = true;
8750
+ export const createSubscriptionBodyCustomPlanProRatingConfigModeDefault = 'prorate_prices';
8751
+ export const createSubscriptionBodyCustomPlanProRatingConfigDefault = {
8752
+ enabled: true,
8753
+ mode: 'prorate_prices',
8754
+ };
8705
8755
  export const createSubscriptionBodyCustomPlanPhasesItemKeyMax = 64;
8706
8756
  export const createSubscriptionBodyCustomPlanPhasesItemKeyRegExp = new RegExp('^[a-z0-9]+(?:_[a-z0-9]+)*$');
8707
8757
  export const createSubscriptionBodyCustomPlanPhasesItemNameMax = 256;
@@ -8844,6 +8894,9 @@ export const createSubscriptionBody = zod
8844
8894
  .describe('Alignment configuration for a plan or subscription.')
8845
8895
  .optional()
8846
8896
  .describe('Alignment configuration for the plan.'),
8897
+ billingCadence: zod
8898
+ .string()
8899
+ .describe('The default billing cadence for subscriptions using this plan.\nDefines how often customers are billed using ISO8601 duration format.\nExamples: \"P1M\" (monthly), \"P3M\" (quarterly), \"P1Y\" (annually).'),
8847
8900
  currency: zod
8848
8901
  .string()
8849
8902
  .min(createSubscriptionBodyCustomPlanCurrencyMinOne)
@@ -9387,6 +9440,19 @@ export const createSubscriptionBody = zod
9387
9440
  .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses."))
9388
9441
  .min(1)
9389
9442
  .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.\nA phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices."),
9443
+ proRatingConfig: zod
9444
+ .object({
9445
+ enabled: zod
9446
+ .boolean()
9447
+ .describe('Whether pro-rating is enabled for this plan.'),
9448
+ mode: zod
9449
+ .enum(['prorate_prices'])
9450
+ .describe('Pro-rating mode options for handling billing period changes.')
9451
+ .describe('How to handle pro-rating for billing period changes.'),
9452
+ })
9453
+ .describe('Configuration for pro-rating behavior.')
9454
+ .default(createSubscriptionBodyCustomPlanProRatingConfigDefault)
9455
+ .describe('Default pro-rating configuration for subscriptions using this plan.'),
9390
9456
  })
9391
9457
  .describe('The template for omitting properties.')
9392
9458
  .describe('Plan input for custom subscription creation (without key and version).')
@@ -10250,6 +10316,12 @@ export const changeSubscriptionBodyCustomPlanCurrencyMinOne = 3;
10250
10316
  export const changeSubscriptionBodyCustomPlanCurrencyMaxOne = 3;
10251
10317
  export const changeSubscriptionBodyCustomPlanCurrencyRegExpOne = new RegExp('^[A-Z]{3}$');
10252
10318
  export const changeSubscriptionBodyCustomPlanCurrencyDefault = 'USD';
10319
+ export const changeSubscriptionBodyCustomPlanProRatingConfigEnabledDefault = true;
10320
+ export const changeSubscriptionBodyCustomPlanProRatingConfigModeDefault = 'prorate_prices';
10321
+ export const changeSubscriptionBodyCustomPlanProRatingConfigDefault = {
10322
+ enabled: true,
10323
+ mode: 'prorate_prices',
10324
+ };
10253
10325
  export const changeSubscriptionBodyCustomPlanPhasesItemKeyMax = 64;
10254
10326
  export const changeSubscriptionBodyCustomPlanPhasesItemKeyRegExp = new RegExp('^[a-z0-9]+(?:_[a-z0-9]+)*$');
10255
10327
  export const changeSubscriptionBodyCustomPlanPhasesItemNameMax = 256;
@@ -10366,6 +10438,9 @@ export const changeSubscriptionBody = zod
10366
10438
  .describe('Alignment configuration for a plan or subscription.')
10367
10439
  .optional()
10368
10440
  .describe('Alignment configuration for the plan.'),
10441
+ billingCadence: zod
10442
+ .string()
10443
+ .describe('The default billing cadence for subscriptions using this plan.\nDefines how often customers are billed using ISO8601 duration format.\nExamples: \"P1M\" (monthly), \"P3M\" (quarterly), \"P1Y\" (annually).'),
10369
10444
  currency: zod
10370
10445
  .string()
10371
10446
  .min(changeSubscriptionBodyCustomPlanCurrencyMinOne)
@@ -10909,6 +10984,19 @@ export const changeSubscriptionBody = zod
10909
10984
  .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses."))
10910
10985
  .min(1)
10911
10986
  .describe("The plan phase or pricing ramp allows changing a plan's rate cards over time as a subscription progresses.\nA phase switch occurs only at the end of a billing period, ensuring that a single subscription invoice will not include charges from different phase prices."),
10987
+ proRatingConfig: zod
10988
+ .object({
10989
+ enabled: zod
10990
+ .boolean()
10991
+ .describe('Whether pro-rating is enabled for this plan.'),
10992
+ mode: zod
10993
+ .enum(['prorate_prices'])
10994
+ .describe('Pro-rating mode options for handling billing period changes.')
10995
+ .describe('How to handle pro-rating for billing period changes.'),
10996
+ })
10997
+ .describe('Configuration for pro-rating behavior.')
10998
+ .default(changeSubscriptionBodyCustomPlanProRatingConfigDefault)
10999
+ .describe('Default pro-rating configuration for subscriptions using this plan.'),
10912
11000
  })
10913
11001
  .describe('The template for omitting properties.')
10914
11002
  .describe('Plan input for custom subscription creation (without key and version).')