orb-billing 4.54.0 → 4.56.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.
Files changed (38) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/core.d.ts.map +1 -1
  3. package/core.js +12 -6
  4. package/core.js.map +1 -1
  5. package/core.mjs +12 -6
  6. package/core.mjs.map +1 -1
  7. package/package.json +1 -1
  8. package/resources/customers/balance-transactions.d.ts +2 -2
  9. package/resources/customers/balance-transactions.d.ts.map +1 -1
  10. package/resources/customers/balance-transactions.js.map +1 -1
  11. package/resources/customers/balance-transactions.mjs.map +1 -1
  12. package/resources/events/backfills.d.ts +30 -0
  13. package/resources/events/backfills.d.ts.map +1 -1
  14. package/resources/events/backfills.js.map +1 -1
  15. package/resources/events/backfills.mjs.map +1 -1
  16. package/resources/invoice-line-items.d.ts +49 -45
  17. package/resources/invoice-line-items.d.ts.map +1 -1
  18. package/resources/invoices.d.ts +100 -92
  19. package/resources/invoices.d.ts.map +1 -1
  20. package/resources/invoices.js.map +1 -1
  21. package/resources/invoices.mjs.map +1 -1
  22. package/resources/plans/plans.d.ts +24 -24
  23. package/resources/plans/plans.d.ts.map +1 -1
  24. package/resources/subscriptions.d.ts +374 -268
  25. package/resources/subscriptions.d.ts.map +1 -1
  26. package/resources/subscriptions.js.map +1 -1
  27. package/resources/subscriptions.mjs.map +1 -1
  28. package/src/core.ts +14 -6
  29. package/src/resources/customers/balance-transactions.ts +4 -2
  30. package/src/resources/events/backfills.ts +35 -0
  31. package/src/resources/invoice-line-items.ts +57 -53
  32. package/src/resources/invoices.ts +118 -108
  33. package/src/resources/plans/plans.ts +31 -31
  34. package/src/resources/subscriptions.ts +472 -346
  35. package/src/version.ts +1 -1
  36. package/version.d.ts +1 -1
  37. package/version.js +1 -1
  38. package/version.mjs +1 -1
@@ -1228,11 +1228,11 @@ export namespace Subscription {
1228
1228
  id: string;
1229
1229
 
1230
1230
  adjustment:
1231
- | AdjustmentInterval.AmountDiscountAdjustment
1232
- | AdjustmentInterval.PercentageDiscountAdjustment
1233
- | AdjustmentInterval.UsageDiscountAdjustment
1234
- | AdjustmentInterval.MinimumAdjustment
1235
- | AdjustmentInterval.MaximumAdjustment;
1231
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
1232
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
1233
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
1234
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
1235
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
1236
1236
 
1237
1237
  /**
1238
1238
  * The price interval IDs that this adjustment applies to.
@@ -1251,16 +1251,10 @@ export namespace Subscription {
1251
1251
  }
1252
1252
 
1253
1253
  export namespace AdjustmentInterval {
1254
- export interface AmountDiscountAdjustment {
1254
+ export interface PlanPhaseUsageDiscountAdjustment {
1255
1255
  id: string;
1256
1256
 
1257
- adjustment_type: 'amount_discount';
1258
-
1259
- /**
1260
- * The amount by which to discount the prices this adjustment applies to in a given
1261
- * billing period.
1262
- */
1263
- amount_discount: string;
1257
+ adjustment_type: 'usage_discount';
1264
1258
 
1265
1259
  /**
1266
1260
  * The price IDs that this adjustment applies to.
@@ -1282,12 +1276,24 @@ export namespace Subscription {
1282
1276
  * The reason for the adjustment.
1283
1277
  */
1284
1278
  reason: string | null;
1279
+
1280
+ /**
1281
+ * The number of usage units by which to discount the price this adjustment applies
1282
+ * to in a given billing period.
1283
+ */
1284
+ usage_discount: number;
1285
1285
  }
1286
1286
 
1287
- export interface PercentageDiscountAdjustment {
1287
+ export interface PlanPhaseAmountDiscountAdjustment {
1288
1288
  id: string;
1289
1289
 
1290
- adjustment_type: 'percentage_discount';
1290
+ adjustment_type: 'amount_discount';
1291
+
1292
+ /**
1293
+ * The amount by which to discount the prices this adjustment applies to in a given
1294
+ * billing period.
1295
+ */
1296
+ amount_discount: string;
1291
1297
 
1292
1298
  /**
1293
1299
  * The price IDs that this adjustment applies to.
@@ -1300,12 +1306,6 @@ export namespace Subscription {
1300
1306
  */
1301
1307
  is_invoice_level: boolean;
1302
1308
 
1303
- /**
1304
- * The percentage (as a value between 0 and 1) by which to discount the price
1305
- * intervals this adjustment applies to in a given billing period.
1306
- */
1307
- percentage_discount: number;
1308
-
1309
1309
  /**
1310
1310
  * The plan phase in which this adjustment is active.
1311
1311
  */
@@ -1317,10 +1317,10 @@ export namespace Subscription {
1317
1317
  reason: string | null;
1318
1318
  }
1319
1319
 
1320
- export interface UsageDiscountAdjustment {
1320
+ export interface PlanPhasePercentageDiscountAdjustment {
1321
1321
  id: string;
1322
1322
 
1323
- adjustment_type: 'usage_discount';
1323
+ adjustment_type: 'percentage_discount';
1324
1324
 
1325
1325
  /**
1326
1326
  * The price IDs that this adjustment applies to.
@@ -1333,6 +1333,12 @@ export namespace Subscription {
1333
1333
  */
1334
1334
  is_invoice_level: boolean;
1335
1335
 
1336
+ /**
1337
+ * The percentage (as a value between 0 and 1) by which to discount the price
1338
+ * intervals this adjustment applies to in a given billing period.
1339
+ */
1340
+ percentage_discount: number;
1341
+
1336
1342
  /**
1337
1343
  * The plan phase in which this adjustment is active.
1338
1344
  */
@@ -1342,15 +1348,9 @@ export namespace Subscription {
1342
1348
  * The reason for the adjustment.
1343
1349
  */
1344
1350
  reason: string | null;
1345
-
1346
- /**
1347
- * The number of usage units by which to discount the price this adjustment applies
1348
- * to in a given billing period.
1349
- */
1350
- usage_discount: number;
1351
1351
  }
1352
1352
 
1353
- export interface MinimumAdjustment {
1353
+ export interface PlanPhaseMinimumAdjustment {
1354
1354
  id: string;
1355
1355
 
1356
1356
  adjustment_type: 'minimum';
@@ -1388,7 +1388,7 @@ export namespace Subscription {
1388
1388
  reason: string | null;
1389
1389
  }
1390
1390
 
1391
- export interface MaximumAdjustment {
1391
+ export interface PlanPhaseMaximumAdjustment {
1392
1392
  id: string;
1393
1393
 
1394
1394
  adjustment_type: 'maximum';
@@ -1914,11 +1914,11 @@ export namespace SubscriptionCreateResponse {
1914
1914
  id: string;
1915
1915
 
1916
1916
  adjustment:
1917
- | AdjustmentInterval.AmountDiscountAdjustment
1918
- | AdjustmentInterval.PercentageDiscountAdjustment
1919
- | AdjustmentInterval.UsageDiscountAdjustment
1920
- | AdjustmentInterval.MinimumAdjustment
1921
- | AdjustmentInterval.MaximumAdjustment;
1917
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
1918
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
1919
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
1920
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
1921
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
1922
1922
 
1923
1923
  /**
1924
1924
  * The price interval IDs that this adjustment applies to.
@@ -1937,16 +1937,10 @@ export namespace SubscriptionCreateResponse {
1937
1937
  }
1938
1938
 
1939
1939
  export namespace AdjustmentInterval {
1940
- export interface AmountDiscountAdjustment {
1940
+ export interface PlanPhaseUsageDiscountAdjustment {
1941
1941
  id: string;
1942
1942
 
1943
- adjustment_type: 'amount_discount';
1944
-
1945
- /**
1946
- * The amount by which to discount the prices this adjustment applies to in a given
1947
- * billing period.
1948
- */
1949
- amount_discount: string;
1943
+ adjustment_type: 'usage_discount';
1950
1944
 
1951
1945
  /**
1952
1946
  * The price IDs that this adjustment applies to.
@@ -1968,12 +1962,24 @@ export namespace SubscriptionCreateResponse {
1968
1962
  * The reason for the adjustment.
1969
1963
  */
1970
1964
  reason: string | null;
1965
+
1966
+ /**
1967
+ * The number of usage units by which to discount the price this adjustment applies
1968
+ * to in a given billing period.
1969
+ */
1970
+ usage_discount: number;
1971
1971
  }
1972
1972
 
1973
- export interface PercentageDiscountAdjustment {
1973
+ export interface PlanPhaseAmountDiscountAdjustment {
1974
1974
  id: string;
1975
1975
 
1976
- adjustment_type: 'percentage_discount';
1976
+ adjustment_type: 'amount_discount';
1977
+
1978
+ /**
1979
+ * The amount by which to discount the prices this adjustment applies to in a given
1980
+ * billing period.
1981
+ */
1982
+ amount_discount: string;
1977
1983
 
1978
1984
  /**
1979
1985
  * The price IDs that this adjustment applies to.
@@ -1986,12 +1992,6 @@ export namespace SubscriptionCreateResponse {
1986
1992
  */
1987
1993
  is_invoice_level: boolean;
1988
1994
 
1989
- /**
1990
- * The percentage (as a value between 0 and 1) by which to discount the price
1991
- * intervals this adjustment applies to in a given billing period.
1992
- */
1993
- percentage_discount: number;
1994
-
1995
1995
  /**
1996
1996
  * The plan phase in which this adjustment is active.
1997
1997
  */
@@ -2003,10 +2003,10 @@ export namespace SubscriptionCreateResponse {
2003
2003
  reason: string | null;
2004
2004
  }
2005
2005
 
2006
- export interface UsageDiscountAdjustment {
2006
+ export interface PlanPhasePercentageDiscountAdjustment {
2007
2007
  id: string;
2008
2008
 
2009
- adjustment_type: 'usage_discount';
2009
+ adjustment_type: 'percentage_discount';
2010
2010
 
2011
2011
  /**
2012
2012
  * The price IDs that this adjustment applies to.
@@ -2019,6 +2019,12 @@ export namespace SubscriptionCreateResponse {
2019
2019
  */
2020
2020
  is_invoice_level: boolean;
2021
2021
 
2022
+ /**
2023
+ * The percentage (as a value between 0 and 1) by which to discount the price
2024
+ * intervals this adjustment applies to in a given billing period.
2025
+ */
2026
+ percentage_discount: number;
2027
+
2022
2028
  /**
2023
2029
  * The plan phase in which this adjustment is active.
2024
2030
  */
@@ -2028,15 +2034,9 @@ export namespace SubscriptionCreateResponse {
2028
2034
  * The reason for the adjustment.
2029
2035
  */
2030
2036
  reason: string | null;
2031
-
2032
- /**
2033
- * The number of usage units by which to discount the price this adjustment applies
2034
- * to in a given billing period.
2035
- */
2036
- usage_discount: number;
2037
2037
  }
2038
2038
 
2039
- export interface MinimumAdjustment {
2039
+ export interface PlanPhaseMinimumAdjustment {
2040
2040
  id: string;
2041
2041
 
2042
2042
  adjustment_type: 'minimum';
@@ -2074,7 +2074,7 @@ export namespace SubscriptionCreateResponse {
2074
2074
  reason: string | null;
2075
2075
  }
2076
2076
 
2077
- export interface MaximumAdjustment {
2077
+ export interface PlanPhaseMaximumAdjustment {
2078
2078
  id: string;
2079
2079
 
2080
2080
  adjustment_type: 'maximum';
@@ -2518,11 +2518,11 @@ export namespace SubscriptionCancelResponse {
2518
2518
  id: string;
2519
2519
 
2520
2520
  adjustment:
2521
- | AdjustmentInterval.AmountDiscountAdjustment
2522
- | AdjustmentInterval.PercentageDiscountAdjustment
2523
- | AdjustmentInterval.UsageDiscountAdjustment
2524
- | AdjustmentInterval.MinimumAdjustment
2525
- | AdjustmentInterval.MaximumAdjustment;
2521
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
2522
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
2523
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
2524
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
2525
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
2526
2526
 
2527
2527
  /**
2528
2528
  * The price interval IDs that this adjustment applies to.
@@ -2541,16 +2541,10 @@ export namespace SubscriptionCancelResponse {
2541
2541
  }
2542
2542
 
2543
2543
  export namespace AdjustmentInterval {
2544
- export interface AmountDiscountAdjustment {
2544
+ export interface PlanPhaseUsageDiscountAdjustment {
2545
2545
  id: string;
2546
2546
 
2547
- adjustment_type: 'amount_discount';
2548
-
2549
- /**
2550
- * The amount by which to discount the prices this adjustment applies to in a given
2551
- * billing period.
2552
- */
2553
- amount_discount: string;
2547
+ adjustment_type: 'usage_discount';
2554
2548
 
2555
2549
  /**
2556
2550
  * The price IDs that this adjustment applies to.
@@ -2572,12 +2566,24 @@ export namespace SubscriptionCancelResponse {
2572
2566
  * The reason for the adjustment.
2573
2567
  */
2574
2568
  reason: string | null;
2569
+
2570
+ /**
2571
+ * The number of usage units by which to discount the price this adjustment applies
2572
+ * to in a given billing period.
2573
+ */
2574
+ usage_discount: number;
2575
2575
  }
2576
2576
 
2577
- export interface PercentageDiscountAdjustment {
2577
+ export interface PlanPhaseAmountDiscountAdjustment {
2578
2578
  id: string;
2579
2579
 
2580
- adjustment_type: 'percentage_discount';
2580
+ adjustment_type: 'amount_discount';
2581
+
2582
+ /**
2583
+ * The amount by which to discount the prices this adjustment applies to in a given
2584
+ * billing period.
2585
+ */
2586
+ amount_discount: string;
2581
2587
 
2582
2588
  /**
2583
2589
  * The price IDs that this adjustment applies to.
@@ -2590,12 +2596,6 @@ export namespace SubscriptionCancelResponse {
2590
2596
  */
2591
2597
  is_invoice_level: boolean;
2592
2598
 
2593
- /**
2594
- * The percentage (as a value between 0 and 1) by which to discount the price
2595
- * intervals this adjustment applies to in a given billing period.
2596
- */
2597
- percentage_discount: number;
2598
-
2599
2599
  /**
2600
2600
  * The plan phase in which this adjustment is active.
2601
2601
  */
@@ -2607,10 +2607,10 @@ export namespace SubscriptionCancelResponse {
2607
2607
  reason: string | null;
2608
2608
  }
2609
2609
 
2610
- export interface UsageDiscountAdjustment {
2610
+ export interface PlanPhasePercentageDiscountAdjustment {
2611
2611
  id: string;
2612
2612
 
2613
- adjustment_type: 'usage_discount';
2613
+ adjustment_type: 'percentage_discount';
2614
2614
 
2615
2615
  /**
2616
2616
  * The price IDs that this adjustment applies to.
@@ -2623,6 +2623,12 @@ export namespace SubscriptionCancelResponse {
2623
2623
  */
2624
2624
  is_invoice_level: boolean;
2625
2625
 
2626
+ /**
2627
+ * The percentage (as a value between 0 and 1) by which to discount the price
2628
+ * intervals this adjustment applies to in a given billing period.
2629
+ */
2630
+ percentage_discount: number;
2631
+
2626
2632
  /**
2627
2633
  * The plan phase in which this adjustment is active.
2628
2634
  */
@@ -2632,15 +2638,9 @@ export namespace SubscriptionCancelResponse {
2632
2638
  * The reason for the adjustment.
2633
2639
  */
2634
2640
  reason: string | null;
2635
-
2636
- /**
2637
- * The number of usage units by which to discount the price this adjustment applies
2638
- * to in a given billing period.
2639
- */
2640
- usage_discount: number;
2641
2641
  }
2642
2642
 
2643
- export interface MinimumAdjustment {
2643
+ export interface PlanPhaseMinimumAdjustment {
2644
2644
  id: string;
2645
2645
 
2646
2646
  adjustment_type: 'minimum';
@@ -2678,7 +2678,7 @@ export namespace SubscriptionCancelResponse {
2678
2678
  reason: string | null;
2679
2679
  }
2680
2680
 
2681
- export interface MaximumAdjustment {
2681
+ export interface PlanPhaseMaximumAdjustment {
2682
2682
  id: string;
2683
2683
 
2684
2684
  adjustment_type: 'maximum';
@@ -3204,11 +3204,11 @@ export namespace SubscriptionPriceIntervalsResponse {
3204
3204
  id: string;
3205
3205
 
3206
3206
  adjustment:
3207
- | AdjustmentInterval.AmountDiscountAdjustment
3208
- | AdjustmentInterval.PercentageDiscountAdjustment
3209
- | AdjustmentInterval.UsageDiscountAdjustment
3210
- | AdjustmentInterval.MinimumAdjustment
3211
- | AdjustmentInterval.MaximumAdjustment;
3207
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
3208
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
3209
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
3210
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
3211
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
3212
3212
 
3213
3213
  /**
3214
3214
  * The price interval IDs that this adjustment applies to.
@@ -3227,16 +3227,10 @@ export namespace SubscriptionPriceIntervalsResponse {
3227
3227
  }
3228
3228
 
3229
3229
  export namespace AdjustmentInterval {
3230
- export interface AmountDiscountAdjustment {
3230
+ export interface PlanPhaseUsageDiscountAdjustment {
3231
3231
  id: string;
3232
3232
 
3233
- adjustment_type: 'amount_discount';
3234
-
3235
- /**
3236
- * The amount by which to discount the prices this adjustment applies to in a given
3237
- * billing period.
3238
- */
3239
- amount_discount: string;
3233
+ adjustment_type: 'usage_discount';
3240
3234
 
3241
3235
  /**
3242
3236
  * The price IDs that this adjustment applies to.
@@ -3258,12 +3252,24 @@ export namespace SubscriptionPriceIntervalsResponse {
3258
3252
  * The reason for the adjustment.
3259
3253
  */
3260
3254
  reason: string | null;
3255
+
3256
+ /**
3257
+ * The number of usage units by which to discount the price this adjustment applies
3258
+ * to in a given billing period.
3259
+ */
3260
+ usage_discount: number;
3261
3261
  }
3262
3262
 
3263
- export interface PercentageDiscountAdjustment {
3263
+ export interface PlanPhaseAmountDiscountAdjustment {
3264
3264
  id: string;
3265
3265
 
3266
- adjustment_type: 'percentage_discount';
3266
+ adjustment_type: 'amount_discount';
3267
+
3268
+ /**
3269
+ * The amount by which to discount the prices this adjustment applies to in a given
3270
+ * billing period.
3271
+ */
3272
+ amount_discount: string;
3267
3273
 
3268
3274
  /**
3269
3275
  * The price IDs that this adjustment applies to.
@@ -3276,12 +3282,6 @@ export namespace SubscriptionPriceIntervalsResponse {
3276
3282
  */
3277
3283
  is_invoice_level: boolean;
3278
3284
 
3279
- /**
3280
- * The percentage (as a value between 0 and 1) by which to discount the price
3281
- * intervals this adjustment applies to in a given billing period.
3282
- */
3283
- percentage_discount: number;
3284
-
3285
3285
  /**
3286
3286
  * The plan phase in which this adjustment is active.
3287
3287
  */
@@ -3293,10 +3293,10 @@ export namespace SubscriptionPriceIntervalsResponse {
3293
3293
  reason: string | null;
3294
3294
  }
3295
3295
 
3296
- export interface UsageDiscountAdjustment {
3296
+ export interface PlanPhasePercentageDiscountAdjustment {
3297
3297
  id: string;
3298
3298
 
3299
- adjustment_type: 'usage_discount';
3299
+ adjustment_type: 'percentage_discount';
3300
3300
 
3301
3301
  /**
3302
3302
  * The price IDs that this adjustment applies to.
@@ -3309,6 +3309,12 @@ export namespace SubscriptionPriceIntervalsResponse {
3309
3309
  */
3310
3310
  is_invoice_level: boolean;
3311
3311
 
3312
+ /**
3313
+ * The percentage (as a value between 0 and 1) by which to discount the price
3314
+ * intervals this adjustment applies to in a given billing period.
3315
+ */
3316
+ percentage_discount: number;
3317
+
3312
3318
  /**
3313
3319
  * The plan phase in which this adjustment is active.
3314
3320
  */
@@ -3318,15 +3324,9 @@ export namespace SubscriptionPriceIntervalsResponse {
3318
3324
  * The reason for the adjustment.
3319
3325
  */
3320
3326
  reason: string | null;
3321
-
3322
- /**
3323
- * The number of usage units by which to discount the price this adjustment applies
3324
- * to in a given billing period.
3325
- */
3326
- usage_discount: number;
3327
3327
  }
3328
3328
 
3329
- export interface MinimumAdjustment {
3329
+ export interface PlanPhaseMinimumAdjustment {
3330
3330
  id: string;
3331
3331
 
3332
3332
  adjustment_type: 'minimum';
@@ -3364,7 +3364,7 @@ export namespace SubscriptionPriceIntervalsResponse {
3364
3364
  reason: string | null;
3365
3365
  }
3366
3366
 
3367
- export interface MaximumAdjustment {
3367
+ export interface PlanPhaseMaximumAdjustment {
3368
3368
  id: string;
3369
3369
 
3370
3370
  adjustment_type: 'maximum';
@@ -3808,11 +3808,11 @@ export namespace SubscriptionSchedulePlanChangeResponse {
3808
3808
  id: string;
3809
3809
 
3810
3810
  adjustment:
3811
- | AdjustmentInterval.AmountDiscountAdjustment
3812
- | AdjustmentInterval.PercentageDiscountAdjustment
3813
- | AdjustmentInterval.UsageDiscountAdjustment
3814
- | AdjustmentInterval.MinimumAdjustment
3815
- | AdjustmentInterval.MaximumAdjustment;
3811
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
3812
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
3813
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
3814
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
3815
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
3816
3816
 
3817
3817
  /**
3818
3818
  * The price interval IDs that this adjustment applies to.
@@ -3831,16 +3831,10 @@ export namespace SubscriptionSchedulePlanChangeResponse {
3831
3831
  }
3832
3832
 
3833
3833
  export namespace AdjustmentInterval {
3834
- export interface AmountDiscountAdjustment {
3834
+ export interface PlanPhaseUsageDiscountAdjustment {
3835
3835
  id: string;
3836
3836
 
3837
- adjustment_type: 'amount_discount';
3838
-
3839
- /**
3840
- * The amount by which to discount the prices this adjustment applies to in a given
3841
- * billing period.
3842
- */
3843
- amount_discount: string;
3837
+ adjustment_type: 'usage_discount';
3844
3838
 
3845
3839
  /**
3846
3840
  * The price IDs that this adjustment applies to.
@@ -3862,12 +3856,24 @@ export namespace SubscriptionSchedulePlanChangeResponse {
3862
3856
  * The reason for the adjustment.
3863
3857
  */
3864
3858
  reason: string | null;
3859
+
3860
+ /**
3861
+ * The number of usage units by which to discount the price this adjustment applies
3862
+ * to in a given billing period.
3863
+ */
3864
+ usage_discount: number;
3865
3865
  }
3866
3866
 
3867
- export interface PercentageDiscountAdjustment {
3867
+ export interface PlanPhaseAmountDiscountAdjustment {
3868
3868
  id: string;
3869
3869
 
3870
- adjustment_type: 'percentage_discount';
3870
+ adjustment_type: 'amount_discount';
3871
+
3872
+ /**
3873
+ * The amount by which to discount the prices this adjustment applies to in a given
3874
+ * billing period.
3875
+ */
3876
+ amount_discount: string;
3871
3877
 
3872
3878
  /**
3873
3879
  * The price IDs that this adjustment applies to.
@@ -3880,12 +3886,6 @@ export namespace SubscriptionSchedulePlanChangeResponse {
3880
3886
  */
3881
3887
  is_invoice_level: boolean;
3882
3888
 
3883
- /**
3884
- * The percentage (as a value between 0 and 1) by which to discount the price
3885
- * intervals this adjustment applies to in a given billing period.
3886
- */
3887
- percentage_discount: number;
3888
-
3889
3889
  /**
3890
3890
  * The plan phase in which this adjustment is active.
3891
3891
  */
@@ -3897,10 +3897,10 @@ export namespace SubscriptionSchedulePlanChangeResponse {
3897
3897
  reason: string | null;
3898
3898
  }
3899
3899
 
3900
- export interface UsageDiscountAdjustment {
3900
+ export interface PlanPhasePercentageDiscountAdjustment {
3901
3901
  id: string;
3902
3902
 
3903
- adjustment_type: 'usage_discount';
3903
+ adjustment_type: 'percentage_discount';
3904
3904
 
3905
3905
  /**
3906
3906
  * The price IDs that this adjustment applies to.
@@ -3913,6 +3913,12 @@ export namespace SubscriptionSchedulePlanChangeResponse {
3913
3913
  */
3914
3914
  is_invoice_level: boolean;
3915
3915
 
3916
+ /**
3917
+ * The percentage (as a value between 0 and 1) by which to discount the price
3918
+ * intervals this adjustment applies to in a given billing period.
3919
+ */
3920
+ percentage_discount: number;
3921
+
3916
3922
  /**
3917
3923
  * The plan phase in which this adjustment is active.
3918
3924
  */
@@ -3922,15 +3928,9 @@ export namespace SubscriptionSchedulePlanChangeResponse {
3922
3928
  * The reason for the adjustment.
3923
3929
  */
3924
3930
  reason: string | null;
3925
-
3926
- /**
3927
- * The number of usage units by which to discount the price this adjustment applies
3928
- * to in a given billing period.
3929
- */
3930
- usage_discount: number;
3931
3931
  }
3932
3932
 
3933
- export interface MinimumAdjustment {
3933
+ export interface PlanPhaseMinimumAdjustment {
3934
3934
  id: string;
3935
3935
 
3936
3936
  adjustment_type: 'minimum';
@@ -3968,7 +3968,7 @@ export namespace SubscriptionSchedulePlanChangeResponse {
3968
3968
  reason: string | null;
3969
3969
  }
3970
3970
 
3971
- export interface MaximumAdjustment {
3971
+ export interface PlanPhaseMaximumAdjustment {
3972
3972
  id: string;
3973
3973
 
3974
3974
  adjustment_type: 'maximum';
@@ -4412,11 +4412,11 @@ export namespace SubscriptionTriggerPhaseResponse {
4412
4412
  id: string;
4413
4413
 
4414
4414
  adjustment:
4415
- | AdjustmentInterval.AmountDiscountAdjustment
4416
- | AdjustmentInterval.PercentageDiscountAdjustment
4417
- | AdjustmentInterval.UsageDiscountAdjustment
4418
- | AdjustmentInterval.MinimumAdjustment
4419
- | AdjustmentInterval.MaximumAdjustment;
4415
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
4416
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
4417
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
4418
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
4419
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
4420
4420
 
4421
4421
  /**
4422
4422
  * The price interval IDs that this adjustment applies to.
@@ -4435,16 +4435,10 @@ export namespace SubscriptionTriggerPhaseResponse {
4435
4435
  }
4436
4436
 
4437
4437
  export namespace AdjustmentInterval {
4438
- export interface AmountDiscountAdjustment {
4438
+ export interface PlanPhaseUsageDiscountAdjustment {
4439
4439
  id: string;
4440
4440
 
4441
- adjustment_type: 'amount_discount';
4442
-
4443
- /**
4444
- * The amount by which to discount the prices this adjustment applies to in a given
4445
- * billing period.
4446
- */
4447
- amount_discount: string;
4441
+ adjustment_type: 'usage_discount';
4448
4442
 
4449
4443
  /**
4450
4444
  * The price IDs that this adjustment applies to.
@@ -4466,12 +4460,24 @@ export namespace SubscriptionTriggerPhaseResponse {
4466
4460
  * The reason for the adjustment.
4467
4461
  */
4468
4462
  reason: string | null;
4463
+
4464
+ /**
4465
+ * The number of usage units by which to discount the price this adjustment applies
4466
+ * to in a given billing period.
4467
+ */
4468
+ usage_discount: number;
4469
4469
  }
4470
4470
 
4471
- export interface PercentageDiscountAdjustment {
4471
+ export interface PlanPhaseAmountDiscountAdjustment {
4472
4472
  id: string;
4473
4473
 
4474
- adjustment_type: 'percentage_discount';
4474
+ adjustment_type: 'amount_discount';
4475
+
4476
+ /**
4477
+ * The amount by which to discount the prices this adjustment applies to in a given
4478
+ * billing period.
4479
+ */
4480
+ amount_discount: string;
4475
4481
 
4476
4482
  /**
4477
4483
  * The price IDs that this adjustment applies to.
@@ -4484,12 +4490,6 @@ export namespace SubscriptionTriggerPhaseResponse {
4484
4490
  */
4485
4491
  is_invoice_level: boolean;
4486
4492
 
4487
- /**
4488
- * The percentage (as a value between 0 and 1) by which to discount the price
4489
- * intervals this adjustment applies to in a given billing period.
4490
- */
4491
- percentage_discount: number;
4492
-
4493
4493
  /**
4494
4494
  * The plan phase in which this adjustment is active.
4495
4495
  */
@@ -4501,10 +4501,10 @@ export namespace SubscriptionTriggerPhaseResponse {
4501
4501
  reason: string | null;
4502
4502
  }
4503
4503
 
4504
- export interface UsageDiscountAdjustment {
4504
+ export interface PlanPhasePercentageDiscountAdjustment {
4505
4505
  id: string;
4506
4506
 
4507
- adjustment_type: 'usage_discount';
4507
+ adjustment_type: 'percentage_discount';
4508
4508
 
4509
4509
  /**
4510
4510
  * The price IDs that this adjustment applies to.
@@ -4517,6 +4517,12 @@ export namespace SubscriptionTriggerPhaseResponse {
4517
4517
  */
4518
4518
  is_invoice_level: boolean;
4519
4519
 
4520
+ /**
4521
+ * The percentage (as a value between 0 and 1) by which to discount the price
4522
+ * intervals this adjustment applies to in a given billing period.
4523
+ */
4524
+ percentage_discount: number;
4525
+
4520
4526
  /**
4521
4527
  * The plan phase in which this adjustment is active.
4522
4528
  */
@@ -4526,15 +4532,9 @@ export namespace SubscriptionTriggerPhaseResponse {
4526
4532
  * The reason for the adjustment.
4527
4533
  */
4528
4534
  reason: string | null;
4529
-
4530
- /**
4531
- * The number of usage units by which to discount the price this adjustment applies
4532
- * to in a given billing period.
4533
- */
4534
- usage_discount: number;
4535
4535
  }
4536
4536
 
4537
- export interface MinimumAdjustment {
4537
+ export interface PlanPhaseMinimumAdjustment {
4538
4538
  id: string;
4539
4539
 
4540
4540
  adjustment_type: 'minimum';
@@ -4572,7 +4572,7 @@ export namespace SubscriptionTriggerPhaseResponse {
4572
4572
  reason: string | null;
4573
4573
  }
4574
4574
 
4575
- export interface MaximumAdjustment {
4575
+ export interface PlanPhaseMaximumAdjustment {
4576
4576
  id: string;
4577
4577
 
4578
4578
  adjustment_type: 'maximum';
@@ -5016,11 +5016,11 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5016
5016
  id: string;
5017
5017
 
5018
5018
  adjustment:
5019
- | AdjustmentInterval.AmountDiscountAdjustment
5020
- | AdjustmentInterval.PercentageDiscountAdjustment
5021
- | AdjustmentInterval.UsageDiscountAdjustment
5022
- | AdjustmentInterval.MinimumAdjustment
5023
- | AdjustmentInterval.MaximumAdjustment;
5019
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
5020
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
5021
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
5022
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
5023
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
5024
5024
 
5025
5025
  /**
5026
5026
  * The price interval IDs that this adjustment applies to.
@@ -5039,16 +5039,10 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5039
5039
  }
5040
5040
 
5041
5041
  export namespace AdjustmentInterval {
5042
- export interface AmountDiscountAdjustment {
5042
+ export interface PlanPhaseUsageDiscountAdjustment {
5043
5043
  id: string;
5044
5044
 
5045
- adjustment_type: 'amount_discount';
5046
-
5047
- /**
5048
- * The amount by which to discount the prices this adjustment applies to in a given
5049
- * billing period.
5050
- */
5051
- amount_discount: string;
5045
+ adjustment_type: 'usage_discount';
5052
5046
 
5053
5047
  /**
5054
5048
  * The price IDs that this adjustment applies to.
@@ -5070,12 +5064,24 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5070
5064
  * The reason for the adjustment.
5071
5065
  */
5072
5066
  reason: string | null;
5067
+
5068
+ /**
5069
+ * The number of usage units by which to discount the price this adjustment applies
5070
+ * to in a given billing period.
5071
+ */
5072
+ usage_discount: number;
5073
5073
  }
5074
5074
 
5075
- export interface PercentageDiscountAdjustment {
5075
+ export interface PlanPhaseAmountDiscountAdjustment {
5076
5076
  id: string;
5077
5077
 
5078
- adjustment_type: 'percentage_discount';
5078
+ adjustment_type: 'amount_discount';
5079
+
5080
+ /**
5081
+ * The amount by which to discount the prices this adjustment applies to in a given
5082
+ * billing period.
5083
+ */
5084
+ amount_discount: string;
5079
5085
 
5080
5086
  /**
5081
5087
  * The price IDs that this adjustment applies to.
@@ -5088,12 +5094,6 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5088
5094
  */
5089
5095
  is_invoice_level: boolean;
5090
5096
 
5091
- /**
5092
- * The percentage (as a value between 0 and 1) by which to discount the price
5093
- * intervals this adjustment applies to in a given billing period.
5094
- */
5095
- percentage_discount: number;
5096
-
5097
5097
  /**
5098
5098
  * The plan phase in which this adjustment is active.
5099
5099
  */
@@ -5105,10 +5105,10 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5105
5105
  reason: string | null;
5106
5106
  }
5107
5107
 
5108
- export interface UsageDiscountAdjustment {
5108
+ export interface PlanPhasePercentageDiscountAdjustment {
5109
5109
  id: string;
5110
5110
 
5111
- adjustment_type: 'usage_discount';
5111
+ adjustment_type: 'percentage_discount';
5112
5112
 
5113
5113
  /**
5114
5114
  * The price IDs that this adjustment applies to.
@@ -5121,6 +5121,12 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5121
5121
  */
5122
5122
  is_invoice_level: boolean;
5123
5123
 
5124
+ /**
5125
+ * The percentage (as a value between 0 and 1) by which to discount the price
5126
+ * intervals this adjustment applies to in a given billing period.
5127
+ */
5128
+ percentage_discount: number;
5129
+
5124
5130
  /**
5125
5131
  * The plan phase in which this adjustment is active.
5126
5132
  */
@@ -5130,15 +5136,9 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5130
5136
  * The reason for the adjustment.
5131
5137
  */
5132
5138
  reason: string | null;
5133
-
5134
- /**
5135
- * The number of usage units by which to discount the price this adjustment applies
5136
- * to in a given billing period.
5137
- */
5138
- usage_discount: number;
5139
5139
  }
5140
5140
 
5141
- export interface MinimumAdjustment {
5141
+ export interface PlanPhaseMinimumAdjustment {
5142
5142
  id: string;
5143
5143
 
5144
5144
  adjustment_type: 'minimum';
@@ -5176,7 +5176,7 @@ export namespace SubscriptionUnscheduleCancellationResponse {
5176
5176
  reason: string | null;
5177
5177
  }
5178
5178
 
5179
- export interface MaximumAdjustment {
5179
+ export interface PlanPhaseMaximumAdjustment {
5180
5180
  id: string;
5181
5181
 
5182
5182
  adjustment_type: 'maximum';
@@ -5620,11 +5620,11 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
5620
5620
  id: string;
5621
5621
 
5622
5622
  adjustment:
5623
- | AdjustmentInterval.AmountDiscountAdjustment
5624
- | AdjustmentInterval.PercentageDiscountAdjustment
5625
- | AdjustmentInterval.UsageDiscountAdjustment
5626
- | AdjustmentInterval.MinimumAdjustment
5627
- | AdjustmentInterval.MaximumAdjustment;
5623
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
5624
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
5625
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
5626
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
5627
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
5628
5628
 
5629
5629
  /**
5630
5630
  * The price interval IDs that this adjustment applies to.
@@ -5643,16 +5643,10 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
5643
5643
  }
5644
5644
 
5645
5645
  export namespace AdjustmentInterval {
5646
- export interface AmountDiscountAdjustment {
5646
+ export interface PlanPhaseUsageDiscountAdjustment {
5647
5647
  id: string;
5648
5648
 
5649
- adjustment_type: 'amount_discount';
5650
-
5651
- /**
5652
- * The amount by which to discount the prices this adjustment applies to in a given
5653
- * billing period.
5654
- */
5655
- amount_discount: string;
5649
+ adjustment_type: 'usage_discount';
5656
5650
 
5657
5651
  /**
5658
5652
  * The price IDs that this adjustment applies to.
@@ -5674,12 +5668,24 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
5674
5668
  * The reason for the adjustment.
5675
5669
  */
5676
5670
  reason: string | null;
5671
+
5672
+ /**
5673
+ * The number of usage units by which to discount the price this adjustment applies
5674
+ * to in a given billing period.
5675
+ */
5676
+ usage_discount: number;
5677
5677
  }
5678
5678
 
5679
- export interface PercentageDiscountAdjustment {
5679
+ export interface PlanPhaseAmountDiscountAdjustment {
5680
5680
  id: string;
5681
5681
 
5682
- adjustment_type: 'percentage_discount';
5682
+ adjustment_type: 'amount_discount';
5683
+
5684
+ /**
5685
+ * The amount by which to discount the prices this adjustment applies to in a given
5686
+ * billing period.
5687
+ */
5688
+ amount_discount: string;
5683
5689
 
5684
5690
  /**
5685
5691
  * The price IDs that this adjustment applies to.
@@ -5692,12 +5698,6 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
5692
5698
  */
5693
5699
  is_invoice_level: boolean;
5694
5700
 
5695
- /**
5696
- * The percentage (as a value between 0 and 1) by which to discount the price
5697
- * intervals this adjustment applies to in a given billing period.
5698
- */
5699
- percentage_discount: number;
5700
-
5701
5701
  /**
5702
5702
  * The plan phase in which this adjustment is active.
5703
5703
  */
@@ -5709,10 +5709,10 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
5709
5709
  reason: string | null;
5710
5710
  }
5711
5711
 
5712
- export interface UsageDiscountAdjustment {
5712
+ export interface PlanPhasePercentageDiscountAdjustment {
5713
5713
  id: string;
5714
5714
 
5715
- adjustment_type: 'usage_discount';
5715
+ adjustment_type: 'percentage_discount';
5716
5716
 
5717
5717
  /**
5718
5718
  * The price IDs that this adjustment applies to.
@@ -5726,23 +5726,23 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
5726
5726
  is_invoice_level: boolean;
5727
5727
 
5728
5728
  /**
5729
- * The plan phase in which this adjustment is active.
5729
+ * The percentage (as a value between 0 and 1) by which to discount the price
5730
+ * intervals this adjustment applies to in a given billing period.
5730
5731
  */
5731
- plan_phase_order: number | null;
5732
+ percentage_discount: number;
5732
5733
 
5733
5734
  /**
5734
- * The reason for the adjustment.
5735
+ * The plan phase in which this adjustment is active.
5735
5736
  */
5736
- reason: string | null;
5737
+ plan_phase_order: number | null;
5737
5738
 
5738
5739
  /**
5739
- * The number of usage units by which to discount the price this adjustment applies
5740
- * to in a given billing period.
5740
+ * The reason for the adjustment.
5741
5741
  */
5742
- usage_discount: number;
5742
+ reason: string | null;
5743
5743
  }
5744
5744
 
5745
- export interface MinimumAdjustment {
5745
+ export interface PlanPhaseMinimumAdjustment {
5746
5746
  id: string;
5747
5747
 
5748
5748
  adjustment_type: 'minimum';
@@ -5780,7 +5780,7 @@ export namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
5780
5780
  reason: string | null;
5781
5781
  }
5782
5782
 
5783
- export interface MaximumAdjustment {
5783
+ export interface PlanPhaseMaximumAdjustment {
5784
5784
  id: string;
5785
5785
 
5786
5786
  adjustment_type: 'maximum';
@@ -6224,11 +6224,11 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6224
6224
  id: string;
6225
6225
 
6226
6226
  adjustment:
6227
- | AdjustmentInterval.AmountDiscountAdjustment
6228
- | AdjustmentInterval.PercentageDiscountAdjustment
6229
- | AdjustmentInterval.UsageDiscountAdjustment
6230
- | AdjustmentInterval.MinimumAdjustment
6231
- | AdjustmentInterval.MaximumAdjustment;
6227
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
6228
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
6229
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
6230
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
6231
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
6232
6232
 
6233
6233
  /**
6234
6234
  * The price interval IDs that this adjustment applies to.
@@ -6247,16 +6247,10 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6247
6247
  }
6248
6248
 
6249
6249
  export namespace AdjustmentInterval {
6250
- export interface AmountDiscountAdjustment {
6250
+ export interface PlanPhaseUsageDiscountAdjustment {
6251
6251
  id: string;
6252
6252
 
6253
- adjustment_type: 'amount_discount';
6254
-
6255
- /**
6256
- * The amount by which to discount the prices this adjustment applies to in a given
6257
- * billing period.
6258
- */
6259
- amount_discount: string;
6253
+ adjustment_type: 'usage_discount';
6260
6254
 
6261
6255
  /**
6262
6256
  * The price IDs that this adjustment applies to.
@@ -6278,12 +6272,24 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6278
6272
  * The reason for the adjustment.
6279
6273
  */
6280
6274
  reason: string | null;
6275
+
6276
+ /**
6277
+ * The number of usage units by which to discount the price this adjustment applies
6278
+ * to in a given billing period.
6279
+ */
6280
+ usage_discount: number;
6281
6281
  }
6282
6282
 
6283
- export interface PercentageDiscountAdjustment {
6283
+ export interface PlanPhaseAmountDiscountAdjustment {
6284
6284
  id: string;
6285
6285
 
6286
- adjustment_type: 'percentage_discount';
6286
+ adjustment_type: 'amount_discount';
6287
+
6288
+ /**
6289
+ * The amount by which to discount the prices this adjustment applies to in a given
6290
+ * billing period.
6291
+ */
6292
+ amount_discount: string;
6287
6293
 
6288
6294
  /**
6289
6295
  * The price IDs that this adjustment applies to.
@@ -6296,12 +6302,6 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6296
6302
  */
6297
6303
  is_invoice_level: boolean;
6298
6304
 
6299
- /**
6300
- * The percentage (as a value between 0 and 1) by which to discount the price
6301
- * intervals this adjustment applies to in a given billing period.
6302
- */
6303
- percentage_discount: number;
6304
-
6305
6305
  /**
6306
6306
  * The plan phase in which this adjustment is active.
6307
6307
  */
@@ -6313,10 +6313,10 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6313
6313
  reason: string | null;
6314
6314
  }
6315
6315
 
6316
- export interface UsageDiscountAdjustment {
6316
+ export interface PlanPhasePercentageDiscountAdjustment {
6317
6317
  id: string;
6318
6318
 
6319
- adjustment_type: 'usage_discount';
6319
+ adjustment_type: 'percentage_discount';
6320
6320
 
6321
6321
  /**
6322
6322
  * The price IDs that this adjustment applies to.
@@ -6329,6 +6329,12 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6329
6329
  */
6330
6330
  is_invoice_level: boolean;
6331
6331
 
6332
+ /**
6333
+ * The percentage (as a value between 0 and 1) by which to discount the price
6334
+ * intervals this adjustment applies to in a given billing period.
6335
+ */
6336
+ percentage_discount: number;
6337
+
6332
6338
  /**
6333
6339
  * The plan phase in which this adjustment is active.
6334
6340
  */
@@ -6338,15 +6344,9 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6338
6344
  * The reason for the adjustment.
6339
6345
  */
6340
6346
  reason: string | null;
6341
-
6342
- /**
6343
- * The number of usage units by which to discount the price this adjustment applies
6344
- * to in a given billing period.
6345
- */
6346
- usage_discount: number;
6347
6347
  }
6348
6348
 
6349
- export interface MinimumAdjustment {
6349
+ export interface PlanPhaseMinimumAdjustment {
6350
6350
  id: string;
6351
6351
 
6352
6352
  adjustment_type: 'minimum';
@@ -6384,7 +6384,7 @@ export namespace SubscriptionUnschedulePendingPlanChangesResponse {
6384
6384
  reason: string | null;
6385
6385
  }
6386
6386
 
6387
- export interface MaximumAdjustment {
6387
+ export interface PlanPhaseMaximumAdjustment {
6388
6388
  id: string;
6389
6389
 
6390
6390
  adjustment_type: 'maximum';
@@ -6828,11 +6828,11 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
6828
6828
  id: string;
6829
6829
 
6830
6830
  adjustment:
6831
- | AdjustmentInterval.AmountDiscountAdjustment
6832
- | AdjustmentInterval.PercentageDiscountAdjustment
6833
- | AdjustmentInterval.UsageDiscountAdjustment
6834
- | AdjustmentInterval.MinimumAdjustment
6835
- | AdjustmentInterval.MaximumAdjustment;
6831
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
6832
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
6833
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
6834
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
6835
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
6836
6836
 
6837
6837
  /**
6838
6838
  * The price interval IDs that this adjustment applies to.
@@ -6851,16 +6851,10 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
6851
6851
  }
6852
6852
 
6853
6853
  export namespace AdjustmentInterval {
6854
- export interface AmountDiscountAdjustment {
6854
+ export interface PlanPhaseUsageDiscountAdjustment {
6855
6855
  id: string;
6856
6856
 
6857
- adjustment_type: 'amount_discount';
6858
-
6859
- /**
6860
- * The amount by which to discount the prices this adjustment applies to in a given
6861
- * billing period.
6862
- */
6863
- amount_discount: string;
6857
+ adjustment_type: 'usage_discount';
6864
6858
 
6865
6859
  /**
6866
6860
  * The price IDs that this adjustment applies to.
@@ -6882,12 +6876,24 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
6882
6876
  * The reason for the adjustment.
6883
6877
  */
6884
6878
  reason: string | null;
6879
+
6880
+ /**
6881
+ * The number of usage units by which to discount the price this adjustment applies
6882
+ * to in a given billing period.
6883
+ */
6884
+ usage_discount: number;
6885
6885
  }
6886
6886
 
6887
- export interface PercentageDiscountAdjustment {
6887
+ export interface PlanPhaseAmountDiscountAdjustment {
6888
6888
  id: string;
6889
6889
 
6890
- adjustment_type: 'percentage_discount';
6890
+ adjustment_type: 'amount_discount';
6891
+
6892
+ /**
6893
+ * The amount by which to discount the prices this adjustment applies to in a given
6894
+ * billing period.
6895
+ */
6896
+ amount_discount: string;
6891
6897
 
6892
6898
  /**
6893
6899
  * The price IDs that this adjustment applies to.
@@ -6900,12 +6906,6 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
6900
6906
  */
6901
6907
  is_invoice_level: boolean;
6902
6908
 
6903
- /**
6904
- * The percentage (as a value between 0 and 1) by which to discount the price
6905
- * intervals this adjustment applies to in a given billing period.
6906
- */
6907
- percentage_discount: number;
6908
-
6909
6909
  /**
6910
6910
  * The plan phase in which this adjustment is active.
6911
6911
  */
@@ -6917,10 +6917,10 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
6917
6917
  reason: string | null;
6918
6918
  }
6919
6919
 
6920
- export interface UsageDiscountAdjustment {
6920
+ export interface PlanPhasePercentageDiscountAdjustment {
6921
6921
  id: string;
6922
6922
 
6923
- adjustment_type: 'usage_discount';
6923
+ adjustment_type: 'percentage_discount';
6924
6924
 
6925
6925
  /**
6926
6926
  * The price IDs that this adjustment applies to.
@@ -6933,6 +6933,12 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
6933
6933
  */
6934
6934
  is_invoice_level: boolean;
6935
6935
 
6936
+ /**
6937
+ * The percentage (as a value between 0 and 1) by which to discount the price
6938
+ * intervals this adjustment applies to in a given billing period.
6939
+ */
6940
+ percentage_discount: number;
6941
+
6936
6942
  /**
6937
6943
  * The plan phase in which this adjustment is active.
6938
6944
  */
@@ -6942,15 +6948,9 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
6942
6948
  * The reason for the adjustment.
6943
6949
  */
6944
6950
  reason: string | null;
6945
-
6946
- /**
6947
- * The number of usage units by which to discount the price this adjustment applies
6948
- * to in a given billing period.
6949
- */
6950
- usage_discount: number;
6951
6951
  }
6952
6952
 
6953
- export interface MinimumAdjustment {
6953
+ export interface PlanPhaseMinimumAdjustment {
6954
6954
  id: string;
6955
6955
 
6956
6956
  adjustment_type: 'minimum';
@@ -6988,7 +6988,7 @@ export namespace SubscriptionUpdateFixedFeeQuantityResponse {
6988
6988
  reason: string | null;
6989
6989
  }
6990
6990
 
6991
- export interface MaximumAdjustment {
6991
+ export interface PlanPhaseMaximumAdjustment {
6992
6992
  id: string;
6993
6993
 
6994
6994
  adjustment_type: 'maximum';
@@ -7432,11 +7432,11 @@ export namespace SubscriptionUpdateTrialResponse {
7432
7432
  id: string;
7433
7433
 
7434
7434
  adjustment:
7435
- | AdjustmentInterval.AmountDiscountAdjustment
7436
- | AdjustmentInterval.PercentageDiscountAdjustment
7437
- | AdjustmentInterval.UsageDiscountAdjustment
7438
- | AdjustmentInterval.MinimumAdjustment
7439
- | AdjustmentInterval.MaximumAdjustment;
7435
+ | AdjustmentInterval.PlanPhaseUsageDiscountAdjustment
7436
+ | AdjustmentInterval.PlanPhaseAmountDiscountAdjustment
7437
+ | AdjustmentInterval.PlanPhasePercentageDiscountAdjustment
7438
+ | AdjustmentInterval.PlanPhaseMinimumAdjustment
7439
+ | AdjustmentInterval.PlanPhaseMaximumAdjustment;
7440
7440
 
7441
7441
  /**
7442
7442
  * The price interval IDs that this adjustment applies to.
@@ -7455,16 +7455,10 @@ export namespace SubscriptionUpdateTrialResponse {
7455
7455
  }
7456
7456
 
7457
7457
  export namespace AdjustmentInterval {
7458
- export interface AmountDiscountAdjustment {
7458
+ export interface PlanPhaseUsageDiscountAdjustment {
7459
7459
  id: string;
7460
7460
 
7461
- adjustment_type: 'amount_discount';
7462
-
7463
- /**
7464
- * The amount by which to discount the prices this adjustment applies to in a given
7465
- * billing period.
7466
- */
7467
- amount_discount: string;
7461
+ adjustment_type: 'usage_discount';
7468
7462
 
7469
7463
  /**
7470
7464
  * The price IDs that this adjustment applies to.
@@ -7486,12 +7480,24 @@ export namespace SubscriptionUpdateTrialResponse {
7486
7480
  * The reason for the adjustment.
7487
7481
  */
7488
7482
  reason: string | null;
7483
+
7484
+ /**
7485
+ * The number of usage units by which to discount the price this adjustment applies
7486
+ * to in a given billing period.
7487
+ */
7488
+ usage_discount: number;
7489
7489
  }
7490
7490
 
7491
- export interface PercentageDiscountAdjustment {
7491
+ export interface PlanPhaseAmountDiscountAdjustment {
7492
7492
  id: string;
7493
7493
 
7494
- adjustment_type: 'percentage_discount';
7494
+ adjustment_type: 'amount_discount';
7495
+
7496
+ /**
7497
+ * The amount by which to discount the prices this adjustment applies to in a given
7498
+ * billing period.
7499
+ */
7500
+ amount_discount: string;
7495
7501
 
7496
7502
  /**
7497
7503
  * The price IDs that this adjustment applies to.
@@ -7504,12 +7510,6 @@ export namespace SubscriptionUpdateTrialResponse {
7504
7510
  */
7505
7511
  is_invoice_level: boolean;
7506
7512
 
7507
- /**
7508
- * The percentage (as a value between 0 and 1) by which to discount the price
7509
- * intervals this adjustment applies to in a given billing period.
7510
- */
7511
- percentage_discount: number;
7512
-
7513
7513
  /**
7514
7514
  * The plan phase in which this adjustment is active.
7515
7515
  */
@@ -7521,10 +7521,10 @@ export namespace SubscriptionUpdateTrialResponse {
7521
7521
  reason: string | null;
7522
7522
  }
7523
7523
 
7524
- export interface UsageDiscountAdjustment {
7524
+ export interface PlanPhasePercentageDiscountAdjustment {
7525
7525
  id: string;
7526
7526
 
7527
- adjustment_type: 'usage_discount';
7527
+ adjustment_type: 'percentage_discount';
7528
7528
 
7529
7529
  /**
7530
7530
  * The price IDs that this adjustment applies to.
@@ -7537,6 +7537,12 @@ export namespace SubscriptionUpdateTrialResponse {
7537
7537
  */
7538
7538
  is_invoice_level: boolean;
7539
7539
 
7540
+ /**
7541
+ * The percentage (as a value between 0 and 1) by which to discount the price
7542
+ * intervals this adjustment applies to in a given billing period.
7543
+ */
7544
+ percentage_discount: number;
7545
+
7540
7546
  /**
7541
7547
  * The plan phase in which this adjustment is active.
7542
7548
  */
@@ -7546,15 +7552,9 @@ export namespace SubscriptionUpdateTrialResponse {
7546
7552
  * The reason for the adjustment.
7547
7553
  */
7548
7554
  reason: string | null;
7549
-
7550
- /**
7551
- * The number of usage units by which to discount the price this adjustment applies
7552
- * to in a given billing period.
7553
- */
7554
- usage_discount: number;
7555
7555
  }
7556
7556
 
7557
- export interface MinimumAdjustment {
7557
+ export interface PlanPhaseMinimumAdjustment {
7558
7558
  id: string;
7559
7559
 
7560
7560
  adjustment_type: 'minimum';
@@ -7592,7 +7592,7 @@ export namespace SubscriptionUpdateTrialResponse {
7592
7592
  reason: string | null;
7593
7593
  }
7594
7594
 
7595
- export interface MaximumAdjustment {
7595
+ export interface PlanPhaseMaximumAdjustment {
7596
7596
  id: string;
7597
7597
 
7598
7598
  adjustment_type: 'maximum';
@@ -8046,8 +8046,7 @@ export namespace SubscriptionCreateParams {
8046
8046
 
8047
8047
  /**
8048
8048
  * The end date of the adjustment interval. This is the date that the adjustment
8049
- * will stop affecting prices on the subscription. If null, the adjustment will
8050
- * start when the phase or subscription starts.
8049
+ * will stop affecting prices on the subscription.
8051
8050
  */
8052
8051
  end_date?: string | null;
8053
8052
 
@@ -8157,6 +8156,11 @@ export namespace SubscriptionCreateParams {
8157
8156
  }
8158
8157
 
8159
8158
  export interface AddPrice {
8159
+ /**
8160
+ * The definition of a new allocation price to create and add to the subscription.
8161
+ */
8162
+ allocation_price?: AddPrice.AllocationPrice | null;
8163
+
8160
8164
  /**
8161
8165
  * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
8162
8166
  * discounts for this price.
@@ -8230,6 +8234,33 @@ export namespace SubscriptionCreateParams {
8230
8234
  }
8231
8235
 
8232
8236
  export namespace AddPrice {
8237
+ /**
8238
+ * The definition of a new allocation price to create and add to the subscription.
8239
+ */
8240
+ export interface AllocationPrice {
8241
+ /**
8242
+ * An amount of the currency to allocate to the customer at the specified cadence.
8243
+ */
8244
+ amount: string;
8245
+
8246
+ /**
8247
+ * The cadence at which to allocate the amount to the customer.
8248
+ */
8249
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
8250
+
8251
+ /**
8252
+ * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
8253
+ * this price.
8254
+ */
8255
+ currency: string;
8256
+
8257
+ /**
8258
+ * Whether the allocated amount should expire at the end of the cadence or roll
8259
+ * over to the next period.
8260
+ */
8261
+ expires_at_end_of_cadence: boolean;
8262
+ }
8263
+
8233
8264
  export interface Discount {
8234
8265
  discount_type: 'percentage' | 'usage' | 'amount';
8235
8266
 
@@ -10722,6 +10753,11 @@ export namespace SubscriptionCreateParams {
10722
10753
  */
10723
10754
  replaces_price_id: string;
10724
10755
 
10756
+ /**
10757
+ * The definition of a new allocation price to create and add to the subscription.
10758
+ */
10759
+ allocation_price?: ReplacePrice.AllocationPrice | null;
10760
+
10725
10761
  /**
10726
10762
  * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
10727
10763
  * discounts for the replacement price.
@@ -10781,6 +10817,33 @@ export namespace SubscriptionCreateParams {
10781
10817
  }
10782
10818
 
10783
10819
  export namespace ReplacePrice {
10820
+ /**
10821
+ * The definition of a new allocation price to create and add to the subscription.
10822
+ */
10823
+ export interface AllocationPrice {
10824
+ /**
10825
+ * An amount of the currency to allocate to the customer at the specified cadence.
10826
+ */
10827
+ amount: string;
10828
+
10829
+ /**
10830
+ * The cadence at which to allocate the amount to the customer.
10831
+ */
10832
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
10833
+
10834
+ /**
10835
+ * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
10836
+ * this price.
10837
+ */
10838
+ currency: string;
10839
+
10840
+ /**
10841
+ * Whether the allocated amount should expire at the end of the cadence or roll
10842
+ * over to the next period.
10843
+ */
10844
+ expires_at_end_of_cadence: boolean;
10845
+ }
10846
+
10784
10847
  export interface Discount {
10785
10848
  discount_type: 'percentage' | 'usage' | 'amount';
10786
10849
 
@@ -17018,8 +17081,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
17018
17081
 
17019
17082
  /**
17020
17083
  * The end date of the adjustment interval. This is the date that the adjustment
17021
- * will stop affecting prices on the subscription. If null, the adjustment will
17022
- * start when the phase or subscription starts.
17084
+ * will stop affecting prices on the subscription.
17023
17085
  */
17024
17086
  end_date?: string | null;
17025
17087
 
@@ -17129,6 +17191,11 @@ export namespace SubscriptionSchedulePlanChangeParams {
17129
17191
  }
17130
17192
 
17131
17193
  export interface AddPrice {
17194
+ /**
17195
+ * The definition of a new allocation price to create and add to the subscription.
17196
+ */
17197
+ allocation_price?: AddPrice.AllocationPrice | null;
17198
+
17132
17199
  /**
17133
17200
  * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
17134
17201
  * discounts for this price.
@@ -17202,6 +17269,33 @@ export namespace SubscriptionSchedulePlanChangeParams {
17202
17269
  }
17203
17270
 
17204
17271
  export namespace AddPrice {
17272
+ /**
17273
+ * The definition of a new allocation price to create and add to the subscription.
17274
+ */
17275
+ export interface AllocationPrice {
17276
+ /**
17277
+ * An amount of the currency to allocate to the customer at the specified cadence.
17278
+ */
17279
+ amount: string;
17280
+
17281
+ /**
17282
+ * The cadence at which to allocate the amount to the customer.
17283
+ */
17284
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
17285
+
17286
+ /**
17287
+ * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
17288
+ * this price.
17289
+ */
17290
+ currency: string;
17291
+
17292
+ /**
17293
+ * Whether the allocated amount should expire at the end of the cadence or roll
17294
+ * over to the next period.
17295
+ */
17296
+ expires_at_end_of_cadence: boolean;
17297
+ }
17298
+
17205
17299
  export interface Discount {
17206
17300
  discount_type: 'percentage' | 'usage' | 'amount';
17207
17301
 
@@ -19694,6 +19788,11 @@ export namespace SubscriptionSchedulePlanChangeParams {
19694
19788
  */
19695
19789
  replaces_price_id: string;
19696
19790
 
19791
+ /**
19792
+ * The definition of a new allocation price to create and add to the subscription.
19793
+ */
19794
+ allocation_price?: ReplacePrice.AllocationPrice | null;
19795
+
19697
19796
  /**
19698
19797
  * @deprecated [DEPRECATED] Use add_adjustments instead. The subscription's
19699
19798
  * discounts for the replacement price.
@@ -19753,6 +19852,33 @@ export namespace SubscriptionSchedulePlanChangeParams {
19753
19852
  }
19754
19853
 
19755
19854
  export namespace ReplacePrice {
19855
+ /**
19856
+ * The definition of a new allocation price to create and add to the subscription.
19857
+ */
19858
+ export interface AllocationPrice {
19859
+ /**
19860
+ * An amount of the currency to allocate to the customer at the specified cadence.
19861
+ */
19862
+ amount: string;
19863
+
19864
+ /**
19865
+ * The cadence at which to allocate the amount to the customer.
19866
+ */
19867
+ cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
19868
+
19869
+ /**
19870
+ * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
19871
+ * this price.
19872
+ */
19873
+ currency: string;
19874
+
19875
+ /**
19876
+ * Whether the allocated amount should expire at the end of the cadence or roll
19877
+ * over to the next period.
19878
+ */
19879
+ expires_at_end_of_cadence: boolean;
19880
+ }
19881
+
19756
19882
  export interface Discount {
19757
19883
  discount_type: 'percentage' | 'usage' | 'amount';
19758
19884