orb-billing 4.10.0 → 4.11.0

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.
@@ -920,6 +920,7 @@ export interface Subscription {
920
920
  * the plan's behavior. If null, defaults to the customer's setting.
921
921
  */
922
922
  auto_collection: boolean | null;
923
+ billing_cycle_anchor_configuration: Subscription.BillingCycleAnchorConfiguration;
923
924
  /**
924
925
  * The day of the month on which the billing cycle is anchored. If the maximum
925
926
  * number of days in a month is greater than this value, the last day of the month
@@ -1121,6 +1122,26 @@ export declare namespace Subscription {
1121
1122
  reason: string | null;
1122
1123
  }
1123
1124
  }
1125
+ interface BillingCycleAnchorConfiguration {
1126
+ /**
1127
+ * The day of the month on which the billing cycle is anchored. If the maximum
1128
+ * number of days in a month is greater than this value, the last day of the month
1129
+ * is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
1130
+ * period begins on the 30th.
1131
+ */
1132
+ day: number;
1133
+ /**
1134
+ * The month on which the billing cycle is anchored (e.g. a quarterly price
1135
+ * anchored in February would have cycles starting February, May, August, and
1136
+ * November).
1137
+ */
1138
+ month?: number | null;
1139
+ /**
1140
+ * The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
1141
+ * anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
1142
+ */
1143
+ year?: number | null;
1144
+ }
1124
1145
  interface AmountDiscountInterval {
1125
1146
  /**
1126
1147
  * Only available if discount_type is `amount`.
@@ -1878,6 +1899,7 @@ export interface SubscriptionCreateParams {
1878
1899
  align_billing_with_subscription_start_date?: boolean;
1879
1900
  auto_collection?: boolean | null;
1880
1901
  aws_region?: string | null;
1902
+ billing_cycle_anchor_configuration?: SubscriptionCreateParams.BillingCycleAnchorConfiguration | null;
1881
1903
  coupon_redemption_code?: string | null;
1882
1904
  credits_overage_rate?: number | null;
1883
1905
  customer_id?: string | null;
@@ -1913,6 +1935,26 @@ export interface SubscriptionCreateParams {
1913
1935
  start_date?: string | null;
1914
1936
  }
1915
1937
  export declare namespace SubscriptionCreateParams {
1938
+ interface BillingCycleAnchorConfiguration {
1939
+ /**
1940
+ * The day of the month on which the billing cycle is anchored. If the maximum
1941
+ * number of days in a month is greater than this value, the last day of the month
1942
+ * is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
1943
+ * period begins on the 30th.
1944
+ */
1945
+ day: number;
1946
+ /**
1947
+ * The month on which the billing cycle is anchored (e.g. a quarterly price
1948
+ * anchored in February would have cycles starting February, May, August, and
1949
+ * November).
1950
+ */
1951
+ month?: number | null;
1952
+ /**
1953
+ * The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
1954
+ * anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
1955
+ */
1956
+ year?: number | null;
1957
+ }
1916
1958
  interface OverrideUnitPrice {
1917
1959
  id: string;
1918
1960
  model_type: 'unit';
@@ -3117,6 +3159,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3117
3159
  * this is true, and in-arrears if this is false.
3118
3160
  */
3119
3161
  billed_in_advance?: boolean | null;
3162
+ /**
3163
+ * For custom cadence: specifies the duration of the billing period in days or
3164
+ * months.
3165
+ */
3166
+ billing_cycle_configuration?: NewFloatingUnitPrice.BillingCycleConfiguration | null;
3120
3167
  /**
3121
3168
  * The per unit conversion rate of the price currency to the invoicing currency.
3122
3169
  */
@@ -3134,6 +3181,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3134
3181
  * The property used to group this price on an invoice
3135
3182
  */
3136
3183
  invoice_grouping_key?: string | null;
3184
+ /**
3185
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3186
+ * If unspecified, a single invoice is produced per billing cycle.
3187
+ */
3188
+ invoicing_cycle_configuration?: NewFloatingUnitPrice.InvoicingCycleConfiguration | null;
3137
3189
  /**
3138
3190
  * User-specified key/value pairs for the resource. Individual keys can be removed
3139
3191
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3148,6 +3200,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
3148
3200
  */
3149
3201
  unit_amount: string;
3150
3202
  }
3203
+ /**
3204
+ * For custom cadence: specifies the duration of the billing period in days or
3205
+ * months.
3206
+ */
3207
+ interface BillingCycleConfiguration {
3208
+ /**
3209
+ * The duration of the billing period.
3210
+ */
3211
+ duration: number;
3212
+ /**
3213
+ * The unit of billing period duration.
3214
+ */
3215
+ duration_unit: 'day' | 'month';
3216
+ }
3217
+ /**
3218
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3219
+ * If unspecified, a single invoice is produced per billing cycle.
3220
+ */
3221
+ interface InvoicingCycleConfiguration {
3222
+ /**
3223
+ * The duration of the billing period.
3224
+ */
3225
+ duration: number;
3226
+ /**
3227
+ * The unit of billing period duration.
3228
+ */
3229
+ duration_unit: 'day' | 'month';
3230
+ }
3151
3231
  }
3152
3232
  interface NewFloatingPackagePrice {
3153
3233
  /**
@@ -3178,6 +3258,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3178
3258
  * this is true, and in-arrears if this is false.
3179
3259
  */
3180
3260
  billed_in_advance?: boolean | null;
3261
+ /**
3262
+ * For custom cadence: specifies the duration of the billing period in days or
3263
+ * months.
3264
+ */
3265
+ billing_cycle_configuration?: NewFloatingPackagePrice.BillingCycleConfiguration | null;
3181
3266
  /**
3182
3267
  * The per unit conversion rate of the price currency to the invoicing currency.
3183
3268
  */
@@ -3195,6 +3280,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3195
3280
  * The property used to group this price on an invoice
3196
3281
  */
3197
3282
  invoice_grouping_key?: string | null;
3283
+ /**
3284
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3285
+ * If unspecified, a single invoice is produced per billing cycle.
3286
+ */
3287
+ invoicing_cycle_configuration?: NewFloatingPackagePrice.InvoicingCycleConfiguration | null;
3198
3288
  /**
3199
3289
  * User-specified key/value pairs for the resource. Individual keys can be removed
3200
3290
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3214,6 +3304,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
3214
3304
  */
3215
3305
  package_size: number;
3216
3306
  }
3307
+ /**
3308
+ * For custom cadence: specifies the duration of the billing period in days or
3309
+ * months.
3310
+ */
3311
+ interface BillingCycleConfiguration {
3312
+ /**
3313
+ * The duration of the billing period.
3314
+ */
3315
+ duration: number;
3316
+ /**
3317
+ * The unit of billing period duration.
3318
+ */
3319
+ duration_unit: 'day' | 'month';
3320
+ }
3321
+ /**
3322
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3323
+ * If unspecified, a single invoice is produced per billing cycle.
3324
+ */
3325
+ interface InvoicingCycleConfiguration {
3326
+ /**
3327
+ * The duration of the billing period.
3328
+ */
3329
+ duration: number;
3330
+ /**
3331
+ * The unit of billing period duration.
3332
+ */
3333
+ duration_unit: 'day' | 'month';
3334
+ }
3217
3335
  }
3218
3336
  interface NewFloatingMatrixPrice {
3219
3337
  /**
@@ -3244,6 +3362,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3244
3362
  * this is true, and in-arrears if this is false.
3245
3363
  */
3246
3364
  billed_in_advance?: boolean | null;
3365
+ /**
3366
+ * For custom cadence: specifies the duration of the billing period in days or
3367
+ * months.
3368
+ */
3369
+ billing_cycle_configuration?: NewFloatingMatrixPrice.BillingCycleConfiguration | null;
3247
3370
  /**
3248
3371
  * The per unit conversion rate of the price currency to the invoicing currency.
3249
3372
  */
@@ -3261,6 +3384,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3261
3384
  * The property used to group this price on an invoice
3262
3385
  */
3263
3386
  invoice_grouping_key?: string | null;
3387
+ /**
3388
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3389
+ * If unspecified, a single invoice is produced per billing cycle.
3390
+ */
3391
+ invoicing_cycle_configuration?: NewFloatingMatrixPrice.InvoicingCycleConfiguration | null;
3264
3392
  /**
3265
3393
  * User-specified key/value pairs for the resource. Individual keys can be removed
3266
3394
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3297,6 +3425,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
3297
3425
  unit_amount: string;
3298
3426
  }
3299
3427
  }
3428
+ /**
3429
+ * For custom cadence: specifies the duration of the billing period in days or
3430
+ * months.
3431
+ */
3432
+ interface BillingCycleConfiguration {
3433
+ /**
3434
+ * The duration of the billing period.
3435
+ */
3436
+ duration: number;
3437
+ /**
3438
+ * The unit of billing period duration.
3439
+ */
3440
+ duration_unit: 'day' | 'month';
3441
+ }
3442
+ /**
3443
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3444
+ * If unspecified, a single invoice is produced per billing cycle.
3445
+ */
3446
+ interface InvoicingCycleConfiguration {
3447
+ /**
3448
+ * The duration of the billing period.
3449
+ */
3450
+ duration: number;
3451
+ /**
3452
+ * The unit of billing period duration.
3453
+ */
3454
+ duration_unit: 'day' | 'month';
3455
+ }
3300
3456
  }
3301
3457
  interface NewFloatingMatrixWithAllocationPrice {
3302
3458
  /**
@@ -3327,6 +3483,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3327
3483
  * this is true, and in-arrears if this is false.
3328
3484
  */
3329
3485
  billed_in_advance?: boolean | null;
3486
+ /**
3487
+ * For custom cadence: specifies the duration of the billing period in days or
3488
+ * months.
3489
+ */
3490
+ billing_cycle_configuration?: NewFloatingMatrixWithAllocationPrice.BillingCycleConfiguration | null;
3330
3491
  /**
3331
3492
  * The per unit conversion rate of the price currency to the invoicing currency.
3332
3493
  */
@@ -3344,6 +3505,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3344
3505
  * The property used to group this price on an invoice
3345
3506
  */
3346
3507
  invoice_grouping_key?: string | null;
3508
+ /**
3509
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3510
+ * If unspecified, a single invoice is produced per billing cycle.
3511
+ */
3512
+ invoicing_cycle_configuration?: NewFloatingMatrixWithAllocationPrice.InvoicingCycleConfiguration | null;
3347
3513
  /**
3348
3514
  * User-specified key/value pairs for the resource. Individual keys can be removed
3349
3515
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3384,6 +3550,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
3384
3550
  unit_amount: string;
3385
3551
  }
3386
3552
  }
3553
+ /**
3554
+ * For custom cadence: specifies the duration of the billing period in days or
3555
+ * months.
3556
+ */
3557
+ interface BillingCycleConfiguration {
3558
+ /**
3559
+ * The duration of the billing period.
3560
+ */
3561
+ duration: number;
3562
+ /**
3563
+ * The unit of billing period duration.
3564
+ */
3565
+ duration_unit: 'day' | 'month';
3566
+ }
3567
+ /**
3568
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3569
+ * If unspecified, a single invoice is produced per billing cycle.
3570
+ */
3571
+ interface InvoicingCycleConfiguration {
3572
+ /**
3573
+ * The duration of the billing period.
3574
+ */
3575
+ duration: number;
3576
+ /**
3577
+ * The unit of billing period duration.
3578
+ */
3579
+ duration_unit: 'day' | 'month';
3580
+ }
3387
3581
  }
3388
3582
  interface NewFloatingTieredPrice {
3389
3583
  /**
@@ -3414,6 +3608,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3414
3608
  * this is true, and in-arrears if this is false.
3415
3609
  */
3416
3610
  billed_in_advance?: boolean | null;
3611
+ /**
3612
+ * For custom cadence: specifies the duration of the billing period in days or
3613
+ * months.
3614
+ */
3615
+ billing_cycle_configuration?: NewFloatingTieredPrice.BillingCycleConfiguration | null;
3417
3616
  /**
3418
3617
  * The per unit conversion rate of the price currency to the invoicing currency.
3419
3618
  */
@@ -3431,6 +3630,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3431
3630
  * The property used to group this price on an invoice
3432
3631
  */
3433
3632
  invoice_grouping_key?: string | null;
3633
+ /**
3634
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3635
+ * If unspecified, a single invoice is produced per billing cycle.
3636
+ */
3637
+ invoicing_cycle_configuration?: NewFloatingTieredPrice.InvoicingCycleConfiguration | null;
3434
3638
  /**
3435
3639
  * User-specified key/value pairs for the resource. Individual keys can be removed
3436
3640
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3461,6 +3665,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
3461
3665
  last_unit?: number | null;
3462
3666
  }
3463
3667
  }
3668
+ /**
3669
+ * For custom cadence: specifies the duration of the billing period in days or
3670
+ * months.
3671
+ */
3672
+ interface BillingCycleConfiguration {
3673
+ /**
3674
+ * The duration of the billing period.
3675
+ */
3676
+ duration: number;
3677
+ /**
3678
+ * The unit of billing period duration.
3679
+ */
3680
+ duration_unit: 'day' | 'month';
3681
+ }
3682
+ /**
3683
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3684
+ * If unspecified, a single invoice is produced per billing cycle.
3685
+ */
3686
+ interface InvoicingCycleConfiguration {
3687
+ /**
3688
+ * The duration of the billing period.
3689
+ */
3690
+ duration: number;
3691
+ /**
3692
+ * The unit of billing period duration.
3693
+ */
3694
+ duration_unit: 'day' | 'month';
3695
+ }
3464
3696
  }
3465
3697
  interface NewFloatingTieredBpsPrice {
3466
3698
  /**
@@ -3491,6 +3723,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3491
3723
  * this is true, and in-arrears if this is false.
3492
3724
  */
3493
3725
  billed_in_advance?: boolean | null;
3726
+ /**
3727
+ * For custom cadence: specifies the duration of the billing period in days or
3728
+ * months.
3729
+ */
3730
+ billing_cycle_configuration?: NewFloatingTieredBpsPrice.BillingCycleConfiguration | null;
3494
3731
  /**
3495
3732
  * The per unit conversion rate of the price currency to the invoicing currency.
3496
3733
  */
@@ -3508,6 +3745,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3508
3745
  * The property used to group this price on an invoice
3509
3746
  */
3510
3747
  invoice_grouping_key?: string | null;
3748
+ /**
3749
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3750
+ * If unspecified, a single invoice is produced per billing cycle.
3751
+ */
3752
+ invoicing_cycle_configuration?: NewFloatingTieredBpsPrice.InvoicingCycleConfiguration | null;
3511
3753
  /**
3512
3754
  * User-specified key/value pairs for the resource. Individual keys can be removed
3513
3755
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3543,6 +3785,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
3543
3785
  per_unit_maximum?: string | null;
3544
3786
  }
3545
3787
  }
3788
+ /**
3789
+ * For custom cadence: specifies the duration of the billing period in days or
3790
+ * months.
3791
+ */
3792
+ interface BillingCycleConfiguration {
3793
+ /**
3794
+ * The duration of the billing period.
3795
+ */
3796
+ duration: number;
3797
+ /**
3798
+ * The unit of billing period duration.
3799
+ */
3800
+ duration_unit: 'day' | 'month';
3801
+ }
3802
+ /**
3803
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3804
+ * If unspecified, a single invoice is produced per billing cycle.
3805
+ */
3806
+ interface InvoicingCycleConfiguration {
3807
+ /**
3808
+ * The duration of the billing period.
3809
+ */
3810
+ duration: number;
3811
+ /**
3812
+ * The unit of billing period duration.
3813
+ */
3814
+ duration_unit: 'day' | 'month';
3815
+ }
3546
3816
  }
3547
3817
  interface NewFloatingBpsPrice {
3548
3818
  bps_config: NewFloatingBpsPrice.BpsConfig;
@@ -3573,6 +3843,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3573
3843
  * this is true, and in-arrears if this is false.
3574
3844
  */
3575
3845
  billed_in_advance?: boolean | null;
3846
+ /**
3847
+ * For custom cadence: specifies the duration of the billing period in days or
3848
+ * months.
3849
+ */
3850
+ billing_cycle_configuration?: NewFloatingBpsPrice.BillingCycleConfiguration | null;
3576
3851
  /**
3577
3852
  * The per unit conversion rate of the price currency to the invoicing currency.
3578
3853
  */
@@ -3590,6 +3865,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3590
3865
  * The property used to group this price on an invoice
3591
3866
  */
3592
3867
  invoice_grouping_key?: string | null;
3868
+ /**
3869
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3870
+ * If unspecified, a single invoice is produced per billing cycle.
3871
+ */
3872
+ invoicing_cycle_configuration?: NewFloatingBpsPrice.InvoicingCycleConfiguration | null;
3593
3873
  /**
3594
3874
  * User-specified key/value pairs for the resource. Individual keys can be removed
3595
3875
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3608,6 +3888,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
3608
3888
  */
3609
3889
  per_unit_maximum?: string | null;
3610
3890
  }
3891
+ /**
3892
+ * For custom cadence: specifies the duration of the billing period in days or
3893
+ * months.
3894
+ */
3895
+ interface BillingCycleConfiguration {
3896
+ /**
3897
+ * The duration of the billing period.
3898
+ */
3899
+ duration: number;
3900
+ /**
3901
+ * The unit of billing period duration.
3902
+ */
3903
+ duration_unit: 'day' | 'month';
3904
+ }
3905
+ /**
3906
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3907
+ * If unspecified, a single invoice is produced per billing cycle.
3908
+ */
3909
+ interface InvoicingCycleConfiguration {
3910
+ /**
3911
+ * The duration of the billing period.
3912
+ */
3913
+ duration: number;
3914
+ /**
3915
+ * The unit of billing period duration.
3916
+ */
3917
+ duration_unit: 'day' | 'month';
3918
+ }
3611
3919
  }
3612
3920
  interface NewFloatingBulkBpsPrice {
3613
3921
  bulk_bps_config: NewFloatingBulkBpsPrice.BulkBpsConfig;
@@ -3638,6 +3946,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3638
3946
  * this is true, and in-arrears if this is false.
3639
3947
  */
3640
3948
  billed_in_advance?: boolean | null;
3949
+ /**
3950
+ * For custom cadence: specifies the duration of the billing period in days or
3951
+ * months.
3952
+ */
3953
+ billing_cycle_configuration?: NewFloatingBulkBpsPrice.BillingCycleConfiguration | null;
3641
3954
  /**
3642
3955
  * The per unit conversion rate of the price currency to the invoicing currency.
3643
3956
  */
@@ -3655,6 +3968,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3655
3968
  * The property used to group this price on an invoice
3656
3969
  */
3657
3970
  invoice_grouping_key?: string | null;
3971
+ /**
3972
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
3973
+ * If unspecified, a single invoice is produced per billing cycle.
3974
+ */
3975
+ invoicing_cycle_configuration?: NewFloatingBulkBpsPrice.InvoicingCycleConfiguration | null;
3658
3976
  /**
3659
3977
  * User-specified key/value pairs for the resource. Individual keys can be removed
3660
3978
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3686,6 +4004,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
3686
4004
  per_unit_maximum?: string | null;
3687
4005
  }
3688
4006
  }
4007
+ /**
4008
+ * For custom cadence: specifies the duration of the billing period in days or
4009
+ * months.
4010
+ */
4011
+ interface BillingCycleConfiguration {
4012
+ /**
4013
+ * The duration of the billing period.
4014
+ */
4015
+ duration: number;
4016
+ /**
4017
+ * The unit of billing period duration.
4018
+ */
4019
+ duration_unit: 'day' | 'month';
4020
+ }
4021
+ /**
4022
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4023
+ * If unspecified, a single invoice is produced per billing cycle.
4024
+ */
4025
+ interface InvoicingCycleConfiguration {
4026
+ /**
4027
+ * The duration of the billing period.
4028
+ */
4029
+ duration: number;
4030
+ /**
4031
+ * The unit of billing period duration.
4032
+ */
4033
+ duration_unit: 'day' | 'month';
4034
+ }
3689
4035
  }
3690
4036
  interface NewFloatingBulkPrice {
3691
4037
  bulk_config: NewFloatingBulkPrice.BulkConfig;
@@ -3716,6 +4062,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3716
4062
  * this is true, and in-arrears if this is false.
3717
4063
  */
3718
4064
  billed_in_advance?: boolean | null;
4065
+ /**
4066
+ * For custom cadence: specifies the duration of the billing period in days or
4067
+ * months.
4068
+ */
4069
+ billing_cycle_configuration?: NewFloatingBulkPrice.BillingCycleConfiguration | null;
3719
4070
  /**
3720
4071
  * The per unit conversion rate of the price currency to the invoicing currency.
3721
4072
  */
@@ -3733,6 +4084,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3733
4084
  * The property used to group this price on an invoice
3734
4085
  */
3735
4086
  invoice_grouping_key?: string | null;
4087
+ /**
4088
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4089
+ * If unspecified, a single invoice is produced per billing cycle.
4090
+ */
4091
+ invoicing_cycle_configuration?: NewFloatingBulkPrice.InvoicingCycleConfiguration | null;
3736
4092
  /**
3737
4093
  * User-specified key/value pairs for the resource. Individual keys can be removed
3738
4094
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3759,6 +4115,34 @@ export declare namespace SubscriptionPriceIntervalsParams {
3759
4115
  maximum_units?: number | null;
3760
4116
  }
3761
4117
  }
4118
+ /**
4119
+ * For custom cadence: specifies the duration of the billing period in days or
4120
+ * months.
4121
+ */
4122
+ interface BillingCycleConfiguration {
4123
+ /**
4124
+ * The duration of the billing period.
4125
+ */
4126
+ duration: number;
4127
+ /**
4128
+ * The unit of billing period duration.
4129
+ */
4130
+ duration_unit: 'day' | 'month';
4131
+ }
4132
+ /**
4133
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4134
+ * If unspecified, a single invoice is produced per billing cycle.
4135
+ */
4136
+ interface InvoicingCycleConfiguration {
4137
+ /**
4138
+ * The duration of the billing period.
4139
+ */
4140
+ duration: number;
4141
+ /**
4142
+ * The unit of billing period duration.
4143
+ */
4144
+ duration_unit: 'day' | 'month';
4145
+ }
3762
4146
  }
3763
4147
  interface NewFloatingThresholdTotalAmountPrice {
3764
4148
  /**
@@ -3789,6 +4173,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3789
4173
  * this is true, and in-arrears if this is false.
3790
4174
  */
3791
4175
  billed_in_advance?: boolean | null;
4176
+ /**
4177
+ * For custom cadence: specifies the duration of the billing period in days or
4178
+ * months.
4179
+ */
4180
+ billing_cycle_configuration?: NewFloatingThresholdTotalAmountPrice.BillingCycleConfiguration | null;
3792
4181
  /**
3793
4182
  * The per unit conversion rate of the price currency to the invoicing currency.
3794
4183
  */
@@ -3806,6 +4195,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3806
4195
  * The property used to group this price on an invoice
3807
4196
  */
3808
4197
  invoice_grouping_key?: string | null;
4198
+ /**
4199
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4200
+ * If unspecified, a single invoice is produced per billing cycle.
4201
+ */
4202
+ invoicing_cycle_configuration?: NewFloatingThresholdTotalAmountPrice.InvoicingCycleConfiguration | null;
3809
4203
  /**
3810
4204
  * User-specified key/value pairs for the resource. Individual keys can be removed
3811
4205
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3813,6 +4207,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
3813
4207
  */
3814
4208
  metadata?: Record<string, string | null> | null;
3815
4209
  }
4210
+ namespace NewFloatingThresholdTotalAmountPrice {
4211
+ /**
4212
+ * For custom cadence: specifies the duration of the billing period in days or
4213
+ * months.
4214
+ */
4215
+ interface BillingCycleConfiguration {
4216
+ /**
4217
+ * The duration of the billing period.
4218
+ */
4219
+ duration: number;
4220
+ /**
4221
+ * The unit of billing period duration.
4222
+ */
4223
+ duration_unit: 'day' | 'month';
4224
+ }
4225
+ /**
4226
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4227
+ * If unspecified, a single invoice is produced per billing cycle.
4228
+ */
4229
+ interface InvoicingCycleConfiguration {
4230
+ /**
4231
+ * The duration of the billing period.
4232
+ */
4233
+ duration: number;
4234
+ /**
4235
+ * The unit of billing period duration.
4236
+ */
4237
+ duration_unit: 'day' | 'month';
4238
+ }
4239
+ }
3816
4240
  interface NewFloatingTieredPackagePrice {
3817
4241
  /**
3818
4242
  * The cadence to bill for this price on.
@@ -3842,6 +4266,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3842
4266
  * this is true, and in-arrears if this is false.
3843
4267
  */
3844
4268
  billed_in_advance?: boolean | null;
4269
+ /**
4270
+ * For custom cadence: specifies the duration of the billing period in days or
4271
+ * months.
4272
+ */
4273
+ billing_cycle_configuration?: NewFloatingTieredPackagePrice.BillingCycleConfiguration | null;
3845
4274
  /**
3846
4275
  * The per unit conversion rate of the price currency to the invoicing currency.
3847
4276
  */
@@ -3859,6 +4288,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3859
4288
  * The property used to group this price on an invoice
3860
4289
  */
3861
4290
  invoice_grouping_key?: string | null;
4291
+ /**
4292
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4293
+ * If unspecified, a single invoice is produced per billing cycle.
4294
+ */
4295
+ invoicing_cycle_configuration?: NewFloatingTieredPackagePrice.InvoicingCycleConfiguration | null;
3862
4296
  /**
3863
4297
  * User-specified key/value pairs for the resource. Individual keys can be removed
3864
4298
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3866,6 +4300,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
3866
4300
  */
3867
4301
  metadata?: Record<string, string | null> | null;
3868
4302
  }
4303
+ namespace NewFloatingTieredPackagePrice {
4304
+ /**
4305
+ * For custom cadence: specifies the duration of the billing period in days or
4306
+ * months.
4307
+ */
4308
+ interface BillingCycleConfiguration {
4309
+ /**
4310
+ * The duration of the billing period.
4311
+ */
4312
+ duration: number;
4313
+ /**
4314
+ * The unit of billing period duration.
4315
+ */
4316
+ duration_unit: 'day' | 'month';
4317
+ }
4318
+ /**
4319
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4320
+ * If unspecified, a single invoice is produced per billing cycle.
4321
+ */
4322
+ interface InvoicingCycleConfiguration {
4323
+ /**
4324
+ * The duration of the billing period.
4325
+ */
4326
+ duration: number;
4327
+ /**
4328
+ * The unit of billing period duration.
4329
+ */
4330
+ duration_unit: 'day' | 'month';
4331
+ }
4332
+ }
3869
4333
  interface NewFloatingGroupedTieredPrice {
3870
4334
  /**
3871
4335
  * The cadence to bill for this price on.
@@ -3895,6 +4359,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3895
4359
  * this is true, and in-arrears if this is false.
3896
4360
  */
3897
4361
  billed_in_advance?: boolean | null;
4362
+ /**
4363
+ * For custom cadence: specifies the duration of the billing period in days or
4364
+ * months.
4365
+ */
4366
+ billing_cycle_configuration?: NewFloatingGroupedTieredPrice.BillingCycleConfiguration | null;
3898
4367
  /**
3899
4368
  * The per unit conversion rate of the price currency to the invoicing currency.
3900
4369
  */
@@ -3912,6 +4381,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3912
4381
  * The property used to group this price on an invoice
3913
4382
  */
3914
4383
  invoice_grouping_key?: string | null;
4384
+ /**
4385
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4386
+ * If unspecified, a single invoice is produced per billing cycle.
4387
+ */
4388
+ invoicing_cycle_configuration?: NewFloatingGroupedTieredPrice.InvoicingCycleConfiguration | null;
3915
4389
  /**
3916
4390
  * User-specified key/value pairs for the resource. Individual keys can be removed
3917
4391
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3919,6 +4393,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
3919
4393
  */
3920
4394
  metadata?: Record<string, string | null> | null;
3921
4395
  }
4396
+ namespace NewFloatingGroupedTieredPrice {
4397
+ /**
4398
+ * For custom cadence: specifies the duration of the billing period in days or
4399
+ * months.
4400
+ */
4401
+ interface BillingCycleConfiguration {
4402
+ /**
4403
+ * The duration of the billing period.
4404
+ */
4405
+ duration: number;
4406
+ /**
4407
+ * The unit of billing period duration.
4408
+ */
4409
+ duration_unit: 'day' | 'month';
4410
+ }
4411
+ /**
4412
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4413
+ * If unspecified, a single invoice is produced per billing cycle.
4414
+ */
4415
+ interface InvoicingCycleConfiguration {
4416
+ /**
4417
+ * The duration of the billing period.
4418
+ */
4419
+ duration: number;
4420
+ /**
4421
+ * The unit of billing period duration.
4422
+ */
4423
+ duration_unit: 'day' | 'month';
4424
+ }
4425
+ }
3922
4426
  interface NewFloatingTieredWithMinimumPrice {
3923
4427
  /**
3924
4428
  * The cadence to bill for this price on.
@@ -3948,6 +4452,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3948
4452
  * this is true, and in-arrears if this is false.
3949
4453
  */
3950
4454
  billed_in_advance?: boolean | null;
4455
+ /**
4456
+ * For custom cadence: specifies the duration of the billing period in days or
4457
+ * months.
4458
+ */
4459
+ billing_cycle_configuration?: NewFloatingTieredWithMinimumPrice.BillingCycleConfiguration | null;
3951
4460
  /**
3952
4461
  * The per unit conversion rate of the price currency to the invoicing currency.
3953
4462
  */
@@ -3965,6 +4474,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
3965
4474
  * The property used to group this price on an invoice
3966
4475
  */
3967
4476
  invoice_grouping_key?: string | null;
4477
+ /**
4478
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4479
+ * If unspecified, a single invoice is produced per billing cycle.
4480
+ */
4481
+ invoicing_cycle_configuration?: NewFloatingTieredWithMinimumPrice.InvoicingCycleConfiguration | null;
3968
4482
  /**
3969
4483
  * User-specified key/value pairs for the resource. Individual keys can be removed
3970
4484
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3972,6 +4486,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
3972
4486
  */
3973
4487
  metadata?: Record<string, string | null> | null;
3974
4488
  }
4489
+ namespace NewFloatingTieredWithMinimumPrice {
4490
+ /**
4491
+ * For custom cadence: specifies the duration of the billing period in days or
4492
+ * months.
4493
+ */
4494
+ interface BillingCycleConfiguration {
4495
+ /**
4496
+ * The duration of the billing period.
4497
+ */
4498
+ duration: number;
4499
+ /**
4500
+ * The unit of billing period duration.
4501
+ */
4502
+ duration_unit: 'day' | 'month';
4503
+ }
4504
+ /**
4505
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4506
+ * If unspecified, a single invoice is produced per billing cycle.
4507
+ */
4508
+ interface InvoicingCycleConfiguration {
4509
+ /**
4510
+ * The duration of the billing period.
4511
+ */
4512
+ duration: number;
4513
+ /**
4514
+ * The unit of billing period duration.
4515
+ */
4516
+ duration_unit: 'day' | 'month';
4517
+ }
4518
+ }
3975
4519
  interface NewFloatingPackageWithAllocationPrice {
3976
4520
  /**
3977
4521
  * The cadence to bill for this price on.
@@ -4001,6 +4545,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4001
4545
  * this is true, and in-arrears if this is false.
4002
4546
  */
4003
4547
  billed_in_advance?: boolean | null;
4548
+ /**
4549
+ * For custom cadence: specifies the duration of the billing period in days or
4550
+ * months.
4551
+ */
4552
+ billing_cycle_configuration?: NewFloatingPackageWithAllocationPrice.BillingCycleConfiguration | null;
4004
4553
  /**
4005
4554
  * The per unit conversion rate of the price currency to the invoicing currency.
4006
4555
  */
@@ -4018,6 +4567,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4018
4567
  * The property used to group this price on an invoice
4019
4568
  */
4020
4569
  invoice_grouping_key?: string | null;
4570
+ /**
4571
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4572
+ * If unspecified, a single invoice is produced per billing cycle.
4573
+ */
4574
+ invoicing_cycle_configuration?: NewFloatingPackageWithAllocationPrice.InvoicingCycleConfiguration | null;
4021
4575
  /**
4022
4576
  * User-specified key/value pairs for the resource. Individual keys can be removed
4023
4577
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4025,6 +4579,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
4025
4579
  */
4026
4580
  metadata?: Record<string, string | null> | null;
4027
4581
  }
4582
+ namespace NewFloatingPackageWithAllocationPrice {
4583
+ /**
4584
+ * For custom cadence: specifies the duration of the billing period in days or
4585
+ * months.
4586
+ */
4587
+ interface BillingCycleConfiguration {
4588
+ /**
4589
+ * The duration of the billing period.
4590
+ */
4591
+ duration: number;
4592
+ /**
4593
+ * The unit of billing period duration.
4594
+ */
4595
+ duration_unit: 'day' | 'month';
4596
+ }
4597
+ /**
4598
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4599
+ * If unspecified, a single invoice is produced per billing cycle.
4600
+ */
4601
+ interface InvoicingCycleConfiguration {
4602
+ /**
4603
+ * The duration of the billing period.
4604
+ */
4605
+ duration: number;
4606
+ /**
4607
+ * The unit of billing period duration.
4608
+ */
4609
+ duration_unit: 'day' | 'month';
4610
+ }
4611
+ }
4028
4612
  interface NewFloatingTieredPackageWithMinimumPrice {
4029
4613
  /**
4030
4614
  * The cadence to bill for this price on.
@@ -4054,6 +4638,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4054
4638
  * this is true, and in-arrears if this is false.
4055
4639
  */
4056
4640
  billed_in_advance?: boolean | null;
4641
+ /**
4642
+ * For custom cadence: specifies the duration of the billing period in days or
4643
+ * months.
4644
+ */
4645
+ billing_cycle_configuration?: NewFloatingTieredPackageWithMinimumPrice.BillingCycleConfiguration | null;
4057
4646
  /**
4058
4647
  * The per unit conversion rate of the price currency to the invoicing currency.
4059
4648
  */
@@ -4071,6 +4660,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4071
4660
  * The property used to group this price on an invoice
4072
4661
  */
4073
4662
  invoice_grouping_key?: string | null;
4663
+ /**
4664
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4665
+ * If unspecified, a single invoice is produced per billing cycle.
4666
+ */
4667
+ invoicing_cycle_configuration?: NewFloatingTieredPackageWithMinimumPrice.InvoicingCycleConfiguration | null;
4074
4668
  /**
4075
4669
  * User-specified key/value pairs for the resource. Individual keys can be removed
4076
4670
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4078,6 +4672,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
4078
4672
  */
4079
4673
  metadata?: Record<string, string | null> | null;
4080
4674
  }
4675
+ namespace NewFloatingTieredPackageWithMinimumPrice {
4676
+ /**
4677
+ * For custom cadence: specifies the duration of the billing period in days or
4678
+ * months.
4679
+ */
4680
+ interface BillingCycleConfiguration {
4681
+ /**
4682
+ * The duration of the billing period.
4683
+ */
4684
+ duration: number;
4685
+ /**
4686
+ * The unit of billing period duration.
4687
+ */
4688
+ duration_unit: 'day' | 'month';
4689
+ }
4690
+ /**
4691
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4692
+ * If unspecified, a single invoice is produced per billing cycle.
4693
+ */
4694
+ interface InvoicingCycleConfiguration {
4695
+ /**
4696
+ * The duration of the billing period.
4697
+ */
4698
+ duration: number;
4699
+ /**
4700
+ * The unit of billing period duration.
4701
+ */
4702
+ duration_unit: 'day' | 'month';
4703
+ }
4704
+ }
4081
4705
  interface NewFloatingUnitWithPercentPrice {
4082
4706
  /**
4083
4707
  * The cadence to bill for this price on.
@@ -4107,6 +4731,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4107
4731
  * this is true, and in-arrears if this is false.
4108
4732
  */
4109
4733
  billed_in_advance?: boolean | null;
4734
+ /**
4735
+ * For custom cadence: specifies the duration of the billing period in days or
4736
+ * months.
4737
+ */
4738
+ billing_cycle_configuration?: NewFloatingUnitWithPercentPrice.BillingCycleConfiguration | null;
4110
4739
  /**
4111
4740
  * The per unit conversion rate of the price currency to the invoicing currency.
4112
4741
  */
@@ -4124,6 +4753,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4124
4753
  * The property used to group this price on an invoice
4125
4754
  */
4126
4755
  invoice_grouping_key?: string | null;
4756
+ /**
4757
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4758
+ * If unspecified, a single invoice is produced per billing cycle.
4759
+ */
4760
+ invoicing_cycle_configuration?: NewFloatingUnitWithPercentPrice.InvoicingCycleConfiguration | null;
4127
4761
  /**
4128
4762
  * User-specified key/value pairs for the resource. Individual keys can be removed
4129
4763
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4131,6 +4765,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
4131
4765
  */
4132
4766
  metadata?: Record<string, string | null> | null;
4133
4767
  }
4768
+ namespace NewFloatingUnitWithPercentPrice {
4769
+ /**
4770
+ * For custom cadence: specifies the duration of the billing period in days or
4771
+ * months.
4772
+ */
4773
+ interface BillingCycleConfiguration {
4774
+ /**
4775
+ * The duration of the billing period.
4776
+ */
4777
+ duration: number;
4778
+ /**
4779
+ * The unit of billing period duration.
4780
+ */
4781
+ duration_unit: 'day' | 'month';
4782
+ }
4783
+ /**
4784
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4785
+ * If unspecified, a single invoice is produced per billing cycle.
4786
+ */
4787
+ interface InvoicingCycleConfiguration {
4788
+ /**
4789
+ * The duration of the billing period.
4790
+ */
4791
+ duration: number;
4792
+ /**
4793
+ * The unit of billing period duration.
4794
+ */
4795
+ duration_unit: 'day' | 'month';
4796
+ }
4797
+ }
4134
4798
  interface NewFloatingTieredWithProrationPrice {
4135
4799
  /**
4136
4800
  * The cadence to bill for this price on.
@@ -4160,6 +4824,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4160
4824
  * this is true, and in-arrears if this is false.
4161
4825
  */
4162
4826
  billed_in_advance?: boolean | null;
4827
+ /**
4828
+ * For custom cadence: specifies the duration of the billing period in days or
4829
+ * months.
4830
+ */
4831
+ billing_cycle_configuration?: NewFloatingTieredWithProrationPrice.BillingCycleConfiguration | null;
4163
4832
  /**
4164
4833
  * The per unit conversion rate of the price currency to the invoicing currency.
4165
4834
  */
@@ -4177,6 +4846,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4177
4846
  * The property used to group this price on an invoice
4178
4847
  */
4179
4848
  invoice_grouping_key?: string | null;
4849
+ /**
4850
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4851
+ * If unspecified, a single invoice is produced per billing cycle.
4852
+ */
4853
+ invoicing_cycle_configuration?: NewFloatingTieredWithProrationPrice.InvoicingCycleConfiguration | null;
4180
4854
  /**
4181
4855
  * User-specified key/value pairs for the resource. Individual keys can be removed
4182
4856
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4184,6 +4858,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
4184
4858
  */
4185
4859
  metadata?: Record<string, string | null> | null;
4186
4860
  }
4861
+ namespace NewFloatingTieredWithProrationPrice {
4862
+ /**
4863
+ * For custom cadence: specifies the duration of the billing period in days or
4864
+ * months.
4865
+ */
4866
+ interface BillingCycleConfiguration {
4867
+ /**
4868
+ * The duration of the billing period.
4869
+ */
4870
+ duration: number;
4871
+ /**
4872
+ * The unit of billing period duration.
4873
+ */
4874
+ duration_unit: 'day' | 'month';
4875
+ }
4876
+ /**
4877
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4878
+ * If unspecified, a single invoice is produced per billing cycle.
4879
+ */
4880
+ interface InvoicingCycleConfiguration {
4881
+ /**
4882
+ * The duration of the billing period.
4883
+ */
4884
+ duration: number;
4885
+ /**
4886
+ * The unit of billing period duration.
4887
+ */
4888
+ duration_unit: 'day' | 'month';
4889
+ }
4890
+ }
4187
4891
  interface NewFloatingUnitWithProrationPrice {
4188
4892
  /**
4189
4893
  * The cadence to bill for this price on.
@@ -4213,6 +4917,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4213
4917
  * this is true, and in-arrears if this is false.
4214
4918
  */
4215
4919
  billed_in_advance?: boolean | null;
4920
+ /**
4921
+ * For custom cadence: specifies the duration of the billing period in days or
4922
+ * months.
4923
+ */
4924
+ billing_cycle_configuration?: NewFloatingUnitWithProrationPrice.BillingCycleConfiguration | null;
4216
4925
  /**
4217
4926
  * The per unit conversion rate of the price currency to the invoicing currency.
4218
4927
  */
@@ -4230,6 +4939,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4230
4939
  * The property used to group this price on an invoice
4231
4940
  */
4232
4941
  invoice_grouping_key?: string | null;
4942
+ /**
4943
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4944
+ * If unspecified, a single invoice is produced per billing cycle.
4945
+ */
4946
+ invoicing_cycle_configuration?: NewFloatingUnitWithProrationPrice.InvoicingCycleConfiguration | null;
4233
4947
  /**
4234
4948
  * User-specified key/value pairs for the resource. Individual keys can be removed
4235
4949
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4237,6 +4951,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
4237
4951
  */
4238
4952
  metadata?: Record<string, string | null> | null;
4239
4953
  }
4954
+ namespace NewFloatingUnitWithProrationPrice {
4955
+ /**
4956
+ * For custom cadence: specifies the duration of the billing period in days or
4957
+ * months.
4958
+ */
4959
+ interface BillingCycleConfiguration {
4960
+ /**
4961
+ * The duration of the billing period.
4962
+ */
4963
+ duration: number;
4964
+ /**
4965
+ * The unit of billing period duration.
4966
+ */
4967
+ duration_unit: 'day' | 'month';
4968
+ }
4969
+ /**
4970
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4971
+ * If unspecified, a single invoice is produced per billing cycle.
4972
+ */
4973
+ interface InvoicingCycleConfiguration {
4974
+ /**
4975
+ * The duration of the billing period.
4976
+ */
4977
+ duration: number;
4978
+ /**
4979
+ * The unit of billing period duration.
4980
+ */
4981
+ duration_unit: 'day' | 'month';
4982
+ }
4983
+ }
4240
4984
  interface NewFloatingGroupedAllocationPrice {
4241
4985
  /**
4242
4986
  * The cadence to bill for this price on.
@@ -4266,6 +5010,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4266
5010
  * this is true, and in-arrears if this is false.
4267
5011
  */
4268
5012
  billed_in_advance?: boolean | null;
5013
+ /**
5014
+ * For custom cadence: specifies the duration of the billing period in days or
5015
+ * months.
5016
+ */
5017
+ billing_cycle_configuration?: NewFloatingGroupedAllocationPrice.BillingCycleConfiguration | null;
4269
5018
  /**
4270
5019
  * The per unit conversion rate of the price currency to the invoicing currency.
4271
5020
  */
@@ -4283,6 +5032,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4283
5032
  * The property used to group this price on an invoice
4284
5033
  */
4285
5034
  invoice_grouping_key?: string | null;
5035
+ /**
5036
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
5037
+ * If unspecified, a single invoice is produced per billing cycle.
5038
+ */
5039
+ invoicing_cycle_configuration?: NewFloatingGroupedAllocationPrice.InvoicingCycleConfiguration | null;
4286
5040
  /**
4287
5041
  * User-specified key/value pairs for the resource. Individual keys can be removed
4288
5042
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4290,6 +5044,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
4290
5044
  */
4291
5045
  metadata?: Record<string, string | null> | null;
4292
5046
  }
5047
+ namespace NewFloatingGroupedAllocationPrice {
5048
+ /**
5049
+ * For custom cadence: specifies the duration of the billing period in days or
5050
+ * months.
5051
+ */
5052
+ interface BillingCycleConfiguration {
5053
+ /**
5054
+ * The duration of the billing period.
5055
+ */
5056
+ duration: number;
5057
+ /**
5058
+ * The unit of billing period duration.
5059
+ */
5060
+ duration_unit: 'day' | 'month';
5061
+ }
5062
+ /**
5063
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
5064
+ * If unspecified, a single invoice is produced per billing cycle.
5065
+ */
5066
+ interface InvoicingCycleConfiguration {
5067
+ /**
5068
+ * The duration of the billing period.
5069
+ */
5070
+ duration: number;
5071
+ /**
5072
+ * The unit of billing period duration.
5073
+ */
5074
+ duration_unit: 'day' | 'month';
5075
+ }
5076
+ }
4293
5077
  interface NewFloatingBulkWithProrationPrice {
4294
5078
  bulk_with_proration_config: Record<string, unknown>;
4295
5079
  /**
@@ -4319,6 +5103,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4319
5103
  * this is true, and in-arrears if this is false.
4320
5104
  */
4321
5105
  billed_in_advance?: boolean | null;
5106
+ /**
5107
+ * For custom cadence: specifies the duration of the billing period in days or
5108
+ * months.
5109
+ */
5110
+ billing_cycle_configuration?: NewFloatingBulkWithProrationPrice.BillingCycleConfiguration | null;
4322
5111
  /**
4323
5112
  * The per unit conversion rate of the price currency to the invoicing currency.
4324
5113
  */
@@ -4336,6 +5125,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
4336
5125
  * The property used to group this price on an invoice
4337
5126
  */
4338
5127
  invoice_grouping_key?: string | null;
5128
+ /**
5129
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
5130
+ * If unspecified, a single invoice is produced per billing cycle.
5131
+ */
5132
+ invoicing_cycle_configuration?: NewFloatingBulkWithProrationPrice.InvoicingCycleConfiguration | null;
4339
5133
  /**
4340
5134
  * User-specified key/value pairs for the resource. Individual keys can be removed
4341
5135
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4343,6 +5137,36 @@ export declare namespace SubscriptionPriceIntervalsParams {
4343
5137
  */
4344
5138
  metadata?: Record<string, string | null> | null;
4345
5139
  }
5140
+ namespace NewFloatingBulkWithProrationPrice {
5141
+ /**
5142
+ * For custom cadence: specifies the duration of the billing period in days or
5143
+ * months.
5144
+ */
5145
+ interface BillingCycleConfiguration {
5146
+ /**
5147
+ * The duration of the billing period.
5148
+ */
5149
+ duration: number;
5150
+ /**
5151
+ * The unit of billing period duration.
5152
+ */
5153
+ duration_unit: 'day' | 'month';
5154
+ }
5155
+ /**
5156
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
5157
+ * If unspecified, a single invoice is produced per billing cycle.
5158
+ */
5159
+ interface InvoicingCycleConfiguration {
5160
+ /**
5161
+ * The duration of the billing period.
5162
+ */
5163
+ duration: number;
5164
+ /**
5165
+ * The unit of billing period duration.
5166
+ */
5167
+ duration_unit: 'day' | 'month';
5168
+ }
5169
+ }
4346
5170
  }
4347
5171
  interface AddAdjustment {
4348
5172
  /**