orb-billing 4.53.0 → 4.55.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.
- package/CHANGELOG.md +22 -0
- package/core.d.ts.map +1 -1
- package/core.js +12 -6
- package/core.js.map +1 -1
- package/core.mjs +12 -6
- package/core.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/customers/credits/ledger.d.ts +2 -2
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/events/backfills.d.ts +30 -0
- package/resources/events/backfills.d.ts.map +1 -1
- package/resources/events/backfills.js.map +1 -1
- package/resources/events/backfills.mjs.map +1 -1
- package/resources/invoice-line-items.d.ts +175 -2
- package/resources/invoice-line-items.d.ts.map +1 -1
- package/resources/invoices.d.ts +350 -4
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs.map +1 -1
- package/resources/plans/plans.d.ts +213 -25
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/prices.d.ts +530 -61
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/subscriptions.d.ts +453 -269
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs.map +1 -1
- package/src/core.ts +14 -6
- package/src/resources/customers/credits/ledger.ts +2 -2
- package/src/resources/events/backfills.ts +35 -0
- package/src/resources/invoice-line-items.ts +221 -2
- package/src/resources/invoices.ts +442 -4
- package/src/resources/plans/plans.ts +259 -31
- package/src/resources/prices/prices.ts +752 -88
- package/src/resources/subscriptions.ts +569 -345
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -88,7 +88,7 @@ export interface EvaluatePriceGroup {
|
|
|
88
88
|
* For more on the types of prices, see
|
|
89
89
|
* [the core concepts documentation](/core-concepts#plan-and-price)
|
|
90
90
|
*/
|
|
91
|
-
export type Price = Price.UnitPrice | Price.PackagePrice | Price.MatrixPrice | Price.TieredPrice | Price.TieredBpsPrice | Price.BpsPrice | Price.BulkBpsPrice | Price.BulkPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.GroupedTieredPrice | Price.TieredWithMinimumPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.MatrixWithDisplayNamePrice | Price.BulkWithProrationPrice | Price.GroupedTieredPackagePrice | Price.MaxGroupTieredPackagePrice;
|
|
91
|
+
export type Price = Price.UnitPrice | Price.PackagePrice | Price.MatrixPrice | Price.TieredPrice | Price.TieredBpsPrice | Price.BpsPrice | Price.BulkBpsPrice | Price.BulkPrice | Price.ThresholdTotalAmountPrice | Price.TieredPackagePrice | Price.GroupedTieredPrice | Price.TieredWithMinimumPrice | Price.TieredPackageWithMinimumPrice | Price.PackageWithAllocationPrice | Price.UnitWithPercentPrice | Price.MatrixWithAllocationPrice | Price.TieredWithProrationPrice | Price.UnitWithProrationPrice | Price.GroupedAllocationPrice | Price.GroupedWithProratedMinimumPrice | Price.GroupedWithMeteredMinimumPrice | Price.MatrixWithDisplayNamePrice | Price.BulkWithProrationPrice | Price.GroupedTieredPackagePrice | Price.MaxGroupTieredPackagePrice | Price.ScalableMatrixWithUnitPricingPrice | Price.ScalableMatrixWithTieredPricingPrice;
|
|
92
92
|
export declare namespace Price {
|
|
93
93
|
interface UnitPrice {
|
|
94
94
|
id: string;
|
|
@@ -120,6 +120,7 @@ export declare namespace Price {
|
|
|
120
120
|
plan_phase_order: number | null;
|
|
121
121
|
price_type: 'usage_price' | 'fixed_price';
|
|
122
122
|
unit_config: UnitPrice.UnitConfig;
|
|
123
|
+
dimensional_price_configuration?: UnitPrice.DimensionalPriceConfiguration | null;
|
|
123
124
|
}
|
|
124
125
|
namespace UnitPrice {
|
|
125
126
|
interface BillableMetric {
|
|
@@ -169,6 +170,10 @@ export declare namespace Price {
|
|
|
169
170
|
*/
|
|
170
171
|
unit_amount: string;
|
|
171
172
|
}
|
|
173
|
+
interface DimensionalPriceConfiguration {
|
|
174
|
+
dimension_values: Array<string>;
|
|
175
|
+
dimensional_price_group_id: string;
|
|
176
|
+
}
|
|
172
177
|
}
|
|
173
178
|
interface PackagePrice {
|
|
174
179
|
id: string;
|
|
@@ -200,6 +205,7 @@ export declare namespace Price {
|
|
|
200
205
|
package_config: PackagePrice.PackageConfig;
|
|
201
206
|
plan_phase_order: number | null;
|
|
202
207
|
price_type: 'usage_price' | 'fixed_price';
|
|
208
|
+
dimensional_price_configuration?: PackagePrice.DimensionalPriceConfiguration | null;
|
|
203
209
|
}
|
|
204
210
|
namespace PackagePrice {
|
|
205
211
|
interface BillableMetric {
|
|
@@ -254,6 +260,10 @@ export declare namespace Price {
|
|
|
254
260
|
*/
|
|
255
261
|
package_size: number;
|
|
256
262
|
}
|
|
263
|
+
interface DimensionalPriceConfiguration {
|
|
264
|
+
dimension_values: Array<string>;
|
|
265
|
+
dimensional_price_group_id: string;
|
|
266
|
+
}
|
|
257
267
|
}
|
|
258
268
|
interface MatrixPrice {
|
|
259
269
|
id: string;
|
|
@@ -285,6 +295,7 @@ export declare namespace Price {
|
|
|
285
295
|
name: string;
|
|
286
296
|
plan_phase_order: number | null;
|
|
287
297
|
price_type: 'usage_price' | 'fixed_price';
|
|
298
|
+
dimensional_price_configuration?: MatrixPrice.DimensionalPriceConfiguration | null;
|
|
288
299
|
}
|
|
289
300
|
namespace MatrixPrice {
|
|
290
301
|
interface BillableMetric {
|
|
@@ -356,6 +367,10 @@ export declare namespace Price {
|
|
|
356
367
|
*/
|
|
357
368
|
minimum_amount: string;
|
|
358
369
|
}
|
|
370
|
+
interface DimensionalPriceConfiguration {
|
|
371
|
+
dimension_values: Array<string>;
|
|
372
|
+
dimensional_price_group_id: string;
|
|
373
|
+
}
|
|
359
374
|
}
|
|
360
375
|
interface TieredPrice {
|
|
361
376
|
id: string;
|
|
@@ -387,6 +402,7 @@ export declare namespace Price {
|
|
|
387
402
|
plan_phase_order: number | null;
|
|
388
403
|
price_type: 'usage_price' | 'fixed_price';
|
|
389
404
|
tiered_config: TieredPrice.TieredConfig;
|
|
405
|
+
dimensional_price_configuration?: TieredPrice.DimensionalPriceConfiguration | null;
|
|
390
406
|
}
|
|
391
407
|
namespace TieredPrice {
|
|
392
408
|
interface BillableMetric {
|
|
@@ -452,6 +468,10 @@ export declare namespace Price {
|
|
|
452
468
|
last_unit?: number | null;
|
|
453
469
|
}
|
|
454
470
|
}
|
|
471
|
+
interface DimensionalPriceConfiguration {
|
|
472
|
+
dimension_values: Array<string>;
|
|
473
|
+
dimensional_price_group_id: string;
|
|
474
|
+
}
|
|
455
475
|
}
|
|
456
476
|
interface TieredBpsPrice {
|
|
457
477
|
id: string;
|
|
@@ -483,6 +503,7 @@ export declare namespace Price {
|
|
|
483
503
|
plan_phase_order: number | null;
|
|
484
504
|
price_type: 'usage_price' | 'fixed_price';
|
|
485
505
|
tiered_bps_config: TieredBpsPrice.TieredBpsConfig;
|
|
506
|
+
dimensional_price_configuration?: TieredBpsPrice.DimensionalPriceConfiguration | null;
|
|
486
507
|
}
|
|
487
508
|
namespace TieredBpsPrice {
|
|
488
509
|
interface BillableMetric {
|
|
@@ -553,6 +574,10 @@ export declare namespace Price {
|
|
|
553
574
|
per_unit_maximum?: string | null;
|
|
554
575
|
}
|
|
555
576
|
}
|
|
577
|
+
interface DimensionalPriceConfiguration {
|
|
578
|
+
dimension_values: Array<string>;
|
|
579
|
+
dimensional_price_group_id: string;
|
|
580
|
+
}
|
|
556
581
|
}
|
|
557
582
|
interface BpsPrice {
|
|
558
583
|
id: string;
|
|
@@ -584,6 +609,7 @@ export declare namespace Price {
|
|
|
584
609
|
name: string;
|
|
585
610
|
plan_phase_order: number | null;
|
|
586
611
|
price_type: 'usage_price' | 'fixed_price';
|
|
612
|
+
dimensional_price_configuration?: BpsPrice.DimensionalPriceConfiguration | null;
|
|
587
613
|
}
|
|
588
614
|
namespace BpsPrice {
|
|
589
615
|
interface BillableMetric {
|
|
@@ -637,6 +663,10 @@ export declare namespace Price {
|
|
|
637
663
|
*/
|
|
638
664
|
minimum_amount: string;
|
|
639
665
|
}
|
|
666
|
+
interface DimensionalPriceConfiguration {
|
|
667
|
+
dimension_values: Array<string>;
|
|
668
|
+
dimensional_price_group_id: string;
|
|
669
|
+
}
|
|
640
670
|
}
|
|
641
671
|
interface BulkBpsPrice {
|
|
642
672
|
id: string;
|
|
@@ -668,6 +698,7 @@ export declare namespace Price {
|
|
|
668
698
|
name: string;
|
|
669
699
|
plan_phase_order: number | null;
|
|
670
700
|
price_type: 'usage_price' | 'fixed_price';
|
|
701
|
+
dimensional_price_configuration?: BulkBpsPrice.DimensionalPriceConfiguration | null;
|
|
671
702
|
}
|
|
672
703
|
namespace BulkBpsPrice {
|
|
673
704
|
interface BillableMetric {
|
|
@@ -734,6 +765,10 @@ export declare namespace Price {
|
|
|
734
765
|
*/
|
|
735
766
|
minimum_amount: string;
|
|
736
767
|
}
|
|
768
|
+
interface DimensionalPriceConfiguration {
|
|
769
|
+
dimension_values: Array<string>;
|
|
770
|
+
dimensional_price_group_id: string;
|
|
771
|
+
}
|
|
737
772
|
}
|
|
738
773
|
interface BulkPrice {
|
|
739
774
|
id: string;
|
|
@@ -765,6 +800,7 @@ export declare namespace Price {
|
|
|
765
800
|
name: string;
|
|
766
801
|
plan_phase_order: number | null;
|
|
767
802
|
price_type: 'usage_price' | 'fixed_price';
|
|
803
|
+
dimensional_price_configuration?: BulkPrice.DimensionalPriceConfiguration | null;
|
|
768
804
|
}
|
|
769
805
|
namespace BulkPrice {
|
|
770
806
|
interface BillableMetric {
|
|
@@ -826,6 +862,10 @@ export declare namespace Price {
|
|
|
826
862
|
*/
|
|
827
863
|
minimum_amount: string;
|
|
828
864
|
}
|
|
865
|
+
interface DimensionalPriceConfiguration {
|
|
866
|
+
dimension_values: Array<string>;
|
|
867
|
+
dimensional_price_group_id: string;
|
|
868
|
+
}
|
|
829
869
|
}
|
|
830
870
|
interface ThresholdTotalAmountPrice {
|
|
831
871
|
id: string;
|
|
@@ -857,6 +897,7 @@ export declare namespace Price {
|
|
|
857
897
|
plan_phase_order: number | null;
|
|
858
898
|
price_type: 'usage_price' | 'fixed_price';
|
|
859
899
|
threshold_total_amount_config: Record<string, unknown>;
|
|
900
|
+
dimensional_price_configuration?: ThresholdTotalAmountPrice.DimensionalPriceConfiguration | null;
|
|
860
901
|
}
|
|
861
902
|
namespace ThresholdTotalAmountPrice {
|
|
862
903
|
interface BillableMetric {
|
|
@@ -900,6 +941,10 @@ export declare namespace Price {
|
|
|
900
941
|
*/
|
|
901
942
|
minimum_amount: string;
|
|
902
943
|
}
|
|
944
|
+
interface DimensionalPriceConfiguration {
|
|
945
|
+
dimension_values: Array<string>;
|
|
946
|
+
dimensional_price_group_id: string;
|
|
947
|
+
}
|
|
903
948
|
}
|
|
904
949
|
interface TieredPackagePrice {
|
|
905
950
|
id: string;
|
|
@@ -931,6 +976,7 @@ export declare namespace Price {
|
|
|
931
976
|
plan_phase_order: number | null;
|
|
932
977
|
price_type: 'usage_price' | 'fixed_price';
|
|
933
978
|
tiered_package_config: Record<string, unknown>;
|
|
979
|
+
dimensional_price_configuration?: TieredPackagePrice.DimensionalPriceConfiguration | null;
|
|
934
980
|
}
|
|
935
981
|
namespace TieredPackagePrice {
|
|
936
982
|
interface BillableMetric {
|
|
@@ -974,6 +1020,10 @@ export declare namespace Price {
|
|
|
974
1020
|
*/
|
|
975
1021
|
minimum_amount: string;
|
|
976
1022
|
}
|
|
1023
|
+
interface DimensionalPriceConfiguration {
|
|
1024
|
+
dimension_values: Array<string>;
|
|
1025
|
+
dimensional_price_group_id: string;
|
|
1026
|
+
}
|
|
977
1027
|
}
|
|
978
1028
|
interface GroupedTieredPrice {
|
|
979
1029
|
id: string;
|
|
@@ -1005,6 +1055,7 @@ export declare namespace Price {
|
|
|
1005
1055
|
name: string;
|
|
1006
1056
|
plan_phase_order: number | null;
|
|
1007
1057
|
price_type: 'usage_price' | 'fixed_price';
|
|
1058
|
+
dimensional_price_configuration?: GroupedTieredPrice.DimensionalPriceConfiguration | null;
|
|
1008
1059
|
}
|
|
1009
1060
|
namespace GroupedTieredPrice {
|
|
1010
1061
|
interface BillableMetric {
|
|
@@ -1048,6 +1099,10 @@ export declare namespace Price {
|
|
|
1048
1099
|
*/
|
|
1049
1100
|
minimum_amount: string;
|
|
1050
1101
|
}
|
|
1102
|
+
interface DimensionalPriceConfiguration {
|
|
1103
|
+
dimension_values: Array<string>;
|
|
1104
|
+
dimensional_price_group_id: string;
|
|
1105
|
+
}
|
|
1051
1106
|
}
|
|
1052
1107
|
interface TieredWithMinimumPrice {
|
|
1053
1108
|
id: string;
|
|
@@ -1079,6 +1134,7 @@ export declare namespace Price {
|
|
|
1079
1134
|
plan_phase_order: number | null;
|
|
1080
1135
|
price_type: 'usage_price' | 'fixed_price';
|
|
1081
1136
|
tiered_with_minimum_config: Record<string, unknown>;
|
|
1137
|
+
dimensional_price_configuration?: TieredWithMinimumPrice.DimensionalPriceConfiguration | null;
|
|
1082
1138
|
}
|
|
1083
1139
|
namespace TieredWithMinimumPrice {
|
|
1084
1140
|
interface BillableMetric {
|
|
@@ -1122,6 +1178,10 @@ export declare namespace Price {
|
|
|
1122
1178
|
*/
|
|
1123
1179
|
minimum_amount: string;
|
|
1124
1180
|
}
|
|
1181
|
+
interface DimensionalPriceConfiguration {
|
|
1182
|
+
dimension_values: Array<string>;
|
|
1183
|
+
dimensional_price_group_id: string;
|
|
1184
|
+
}
|
|
1125
1185
|
}
|
|
1126
1186
|
interface TieredPackageWithMinimumPrice {
|
|
1127
1187
|
id: string;
|
|
@@ -1153,6 +1213,7 @@ export declare namespace Price {
|
|
|
1153
1213
|
plan_phase_order: number | null;
|
|
1154
1214
|
price_type: 'usage_price' | 'fixed_price';
|
|
1155
1215
|
tiered_package_with_minimum_config: Record<string, unknown>;
|
|
1216
|
+
dimensional_price_configuration?: TieredPackageWithMinimumPrice.DimensionalPriceConfiguration | null;
|
|
1156
1217
|
}
|
|
1157
1218
|
namespace TieredPackageWithMinimumPrice {
|
|
1158
1219
|
interface BillableMetric {
|
|
@@ -1196,6 +1257,10 @@ export declare namespace Price {
|
|
|
1196
1257
|
*/
|
|
1197
1258
|
minimum_amount: string;
|
|
1198
1259
|
}
|
|
1260
|
+
interface DimensionalPriceConfiguration {
|
|
1261
|
+
dimension_values: Array<string>;
|
|
1262
|
+
dimensional_price_group_id: string;
|
|
1263
|
+
}
|
|
1199
1264
|
}
|
|
1200
1265
|
interface PackageWithAllocationPrice {
|
|
1201
1266
|
id: string;
|
|
@@ -1227,6 +1292,7 @@ export declare namespace Price {
|
|
|
1227
1292
|
package_with_allocation_config: Record<string, unknown>;
|
|
1228
1293
|
plan_phase_order: number | null;
|
|
1229
1294
|
price_type: 'usage_price' | 'fixed_price';
|
|
1295
|
+
dimensional_price_configuration?: PackageWithAllocationPrice.DimensionalPriceConfiguration | null;
|
|
1230
1296
|
}
|
|
1231
1297
|
namespace PackageWithAllocationPrice {
|
|
1232
1298
|
interface BillableMetric {
|
|
@@ -1270,6 +1336,10 @@ export declare namespace Price {
|
|
|
1270
1336
|
*/
|
|
1271
1337
|
minimum_amount: string;
|
|
1272
1338
|
}
|
|
1339
|
+
interface DimensionalPriceConfiguration {
|
|
1340
|
+
dimension_values: Array<string>;
|
|
1341
|
+
dimensional_price_group_id: string;
|
|
1342
|
+
}
|
|
1273
1343
|
}
|
|
1274
1344
|
interface UnitWithPercentPrice {
|
|
1275
1345
|
id: string;
|
|
@@ -1301,6 +1371,7 @@ export declare namespace Price {
|
|
|
1301
1371
|
plan_phase_order: number | null;
|
|
1302
1372
|
price_type: 'usage_price' | 'fixed_price';
|
|
1303
1373
|
unit_with_percent_config: Record<string, unknown>;
|
|
1374
|
+
dimensional_price_configuration?: UnitWithPercentPrice.DimensionalPriceConfiguration | null;
|
|
1304
1375
|
}
|
|
1305
1376
|
namespace UnitWithPercentPrice {
|
|
1306
1377
|
interface BillableMetric {
|
|
@@ -1344,6 +1415,10 @@ export declare namespace Price {
|
|
|
1344
1415
|
*/
|
|
1345
1416
|
minimum_amount: string;
|
|
1346
1417
|
}
|
|
1418
|
+
interface DimensionalPriceConfiguration {
|
|
1419
|
+
dimension_values: Array<string>;
|
|
1420
|
+
dimensional_price_group_id: string;
|
|
1421
|
+
}
|
|
1347
1422
|
}
|
|
1348
1423
|
interface MatrixWithAllocationPrice {
|
|
1349
1424
|
id: string;
|
|
@@ -1375,6 +1450,7 @@ export declare namespace Price {
|
|
|
1375
1450
|
name: string;
|
|
1376
1451
|
plan_phase_order: number | null;
|
|
1377
1452
|
price_type: 'usage_price' | 'fixed_price';
|
|
1453
|
+
dimensional_price_configuration?: MatrixWithAllocationPrice.DimensionalPriceConfiguration | null;
|
|
1378
1454
|
}
|
|
1379
1455
|
namespace MatrixWithAllocationPrice {
|
|
1380
1456
|
interface BillableMetric {
|
|
@@ -1450,6 +1526,10 @@ export declare namespace Price {
|
|
|
1450
1526
|
*/
|
|
1451
1527
|
minimum_amount: string;
|
|
1452
1528
|
}
|
|
1529
|
+
interface DimensionalPriceConfiguration {
|
|
1530
|
+
dimension_values: Array<string>;
|
|
1531
|
+
dimensional_price_group_id: string;
|
|
1532
|
+
}
|
|
1453
1533
|
}
|
|
1454
1534
|
interface TieredWithProrationPrice {
|
|
1455
1535
|
id: string;
|
|
@@ -1481,6 +1561,7 @@ export declare namespace Price {
|
|
|
1481
1561
|
plan_phase_order: number | null;
|
|
1482
1562
|
price_type: 'usage_price' | 'fixed_price';
|
|
1483
1563
|
tiered_with_proration_config: Record<string, unknown>;
|
|
1564
|
+
dimensional_price_configuration?: TieredWithProrationPrice.DimensionalPriceConfiguration | null;
|
|
1484
1565
|
}
|
|
1485
1566
|
namespace TieredWithProrationPrice {
|
|
1486
1567
|
interface BillableMetric {
|
|
@@ -1524,6 +1605,10 @@ export declare namespace Price {
|
|
|
1524
1605
|
*/
|
|
1525
1606
|
minimum_amount: string;
|
|
1526
1607
|
}
|
|
1608
|
+
interface DimensionalPriceConfiguration {
|
|
1609
|
+
dimension_values: Array<string>;
|
|
1610
|
+
dimensional_price_group_id: string;
|
|
1611
|
+
}
|
|
1527
1612
|
}
|
|
1528
1613
|
interface UnitWithProrationPrice {
|
|
1529
1614
|
id: string;
|
|
@@ -1555,6 +1640,7 @@ export declare namespace Price {
|
|
|
1555
1640
|
plan_phase_order: number | null;
|
|
1556
1641
|
price_type: 'usage_price' | 'fixed_price';
|
|
1557
1642
|
unit_with_proration_config: Record<string, unknown>;
|
|
1643
|
+
dimensional_price_configuration?: UnitWithProrationPrice.DimensionalPriceConfiguration | null;
|
|
1558
1644
|
}
|
|
1559
1645
|
namespace UnitWithProrationPrice {
|
|
1560
1646
|
interface BillableMetric {
|
|
@@ -1598,6 +1684,10 @@ export declare namespace Price {
|
|
|
1598
1684
|
*/
|
|
1599
1685
|
minimum_amount: string;
|
|
1600
1686
|
}
|
|
1687
|
+
interface DimensionalPriceConfiguration {
|
|
1688
|
+
dimension_values: Array<string>;
|
|
1689
|
+
dimensional_price_group_id: string;
|
|
1690
|
+
}
|
|
1601
1691
|
}
|
|
1602
1692
|
interface GroupedAllocationPrice {
|
|
1603
1693
|
id: string;
|
|
@@ -1629,6 +1719,7 @@ export declare namespace Price {
|
|
|
1629
1719
|
name: string;
|
|
1630
1720
|
plan_phase_order: number | null;
|
|
1631
1721
|
price_type: 'usage_price' | 'fixed_price';
|
|
1722
|
+
dimensional_price_configuration?: GroupedAllocationPrice.DimensionalPriceConfiguration | null;
|
|
1632
1723
|
}
|
|
1633
1724
|
namespace GroupedAllocationPrice {
|
|
1634
1725
|
interface BillableMetric {
|
|
@@ -1672,6 +1763,10 @@ export declare namespace Price {
|
|
|
1672
1763
|
*/
|
|
1673
1764
|
minimum_amount: string;
|
|
1674
1765
|
}
|
|
1766
|
+
interface DimensionalPriceConfiguration {
|
|
1767
|
+
dimension_values: Array<string>;
|
|
1768
|
+
dimensional_price_group_id: string;
|
|
1769
|
+
}
|
|
1675
1770
|
}
|
|
1676
1771
|
interface GroupedWithProratedMinimumPrice {
|
|
1677
1772
|
id: string;
|
|
@@ -1703,6 +1798,7 @@ export declare namespace Price {
|
|
|
1703
1798
|
name: string;
|
|
1704
1799
|
plan_phase_order: number | null;
|
|
1705
1800
|
price_type: 'usage_price' | 'fixed_price';
|
|
1801
|
+
dimensional_price_configuration?: GroupedWithProratedMinimumPrice.DimensionalPriceConfiguration | null;
|
|
1706
1802
|
}
|
|
1707
1803
|
namespace GroupedWithProratedMinimumPrice {
|
|
1708
1804
|
interface BillableMetric {
|
|
@@ -1746,6 +1842,10 @@ export declare namespace Price {
|
|
|
1746
1842
|
*/
|
|
1747
1843
|
minimum_amount: string;
|
|
1748
1844
|
}
|
|
1845
|
+
interface DimensionalPriceConfiguration {
|
|
1846
|
+
dimension_values: Array<string>;
|
|
1847
|
+
dimensional_price_group_id: string;
|
|
1848
|
+
}
|
|
1749
1849
|
}
|
|
1750
1850
|
interface GroupedWithMeteredMinimumPrice {
|
|
1751
1851
|
id: string;
|
|
@@ -1777,6 +1877,7 @@ export declare namespace Price {
|
|
|
1777
1877
|
name: string;
|
|
1778
1878
|
plan_phase_order: number | null;
|
|
1779
1879
|
price_type: 'usage_price' | 'fixed_price';
|
|
1880
|
+
dimensional_price_configuration?: GroupedWithMeteredMinimumPrice.DimensionalPriceConfiguration | null;
|
|
1780
1881
|
}
|
|
1781
1882
|
namespace GroupedWithMeteredMinimumPrice {
|
|
1782
1883
|
interface BillableMetric {
|
|
@@ -1820,6 +1921,10 @@ export declare namespace Price {
|
|
|
1820
1921
|
*/
|
|
1821
1922
|
minimum_amount: string;
|
|
1822
1923
|
}
|
|
1924
|
+
interface DimensionalPriceConfiguration {
|
|
1925
|
+
dimension_values: Array<string>;
|
|
1926
|
+
dimensional_price_group_id: string;
|
|
1927
|
+
}
|
|
1823
1928
|
}
|
|
1824
1929
|
interface MatrixWithDisplayNamePrice {
|
|
1825
1930
|
id: string;
|
|
@@ -1851,6 +1956,7 @@ export declare namespace Price {
|
|
|
1851
1956
|
name: string;
|
|
1852
1957
|
plan_phase_order: number | null;
|
|
1853
1958
|
price_type: 'usage_price' | 'fixed_price';
|
|
1959
|
+
dimensional_price_configuration?: MatrixWithDisplayNamePrice.DimensionalPriceConfiguration | null;
|
|
1854
1960
|
}
|
|
1855
1961
|
namespace MatrixWithDisplayNamePrice {
|
|
1856
1962
|
interface BillableMetric {
|
|
@@ -1894,6 +2000,10 @@ export declare namespace Price {
|
|
|
1894
2000
|
*/
|
|
1895
2001
|
minimum_amount: string;
|
|
1896
2002
|
}
|
|
2003
|
+
interface DimensionalPriceConfiguration {
|
|
2004
|
+
dimension_values: Array<string>;
|
|
2005
|
+
dimensional_price_group_id: string;
|
|
2006
|
+
}
|
|
1897
2007
|
}
|
|
1898
2008
|
interface BulkWithProrationPrice {
|
|
1899
2009
|
id: string;
|
|
@@ -1925,6 +2035,7 @@ export declare namespace Price {
|
|
|
1925
2035
|
name: string;
|
|
1926
2036
|
plan_phase_order: number | null;
|
|
1927
2037
|
price_type: 'usage_price' | 'fixed_price';
|
|
2038
|
+
dimensional_price_configuration?: BulkWithProrationPrice.DimensionalPriceConfiguration | null;
|
|
1928
2039
|
}
|
|
1929
2040
|
namespace BulkWithProrationPrice {
|
|
1930
2041
|
interface BillableMetric {
|
|
@@ -1968,6 +2079,10 @@ export declare namespace Price {
|
|
|
1968
2079
|
*/
|
|
1969
2080
|
minimum_amount: string;
|
|
1970
2081
|
}
|
|
2082
|
+
interface DimensionalPriceConfiguration {
|
|
2083
|
+
dimension_values: Array<string>;
|
|
2084
|
+
dimensional_price_group_id: string;
|
|
2085
|
+
}
|
|
1971
2086
|
}
|
|
1972
2087
|
interface GroupedTieredPackagePrice {
|
|
1973
2088
|
id: string;
|
|
@@ -1999,6 +2114,7 @@ export declare namespace Price {
|
|
|
1999
2114
|
name: string;
|
|
2000
2115
|
plan_phase_order: number | null;
|
|
2001
2116
|
price_type: 'usage_price' | 'fixed_price';
|
|
2117
|
+
dimensional_price_configuration?: GroupedTieredPackagePrice.DimensionalPriceConfiguration | null;
|
|
2002
2118
|
}
|
|
2003
2119
|
namespace GroupedTieredPackagePrice {
|
|
2004
2120
|
interface BillableMetric {
|
|
@@ -2042,6 +2158,10 @@ export declare namespace Price {
|
|
|
2042
2158
|
*/
|
|
2043
2159
|
minimum_amount: string;
|
|
2044
2160
|
}
|
|
2161
|
+
interface DimensionalPriceConfiguration {
|
|
2162
|
+
dimension_values: Array<string>;
|
|
2163
|
+
dimensional_price_group_id: string;
|
|
2164
|
+
}
|
|
2045
2165
|
}
|
|
2046
2166
|
interface MaxGroupTieredPackagePrice {
|
|
2047
2167
|
id: string;
|
|
@@ -2073,6 +2193,7 @@ export declare namespace Price {
|
|
|
2073
2193
|
name: string;
|
|
2074
2194
|
plan_phase_order: number | null;
|
|
2075
2195
|
price_type: 'usage_price' | 'fixed_price';
|
|
2196
|
+
dimensional_price_configuration?: MaxGroupTieredPackagePrice.DimensionalPriceConfiguration | null;
|
|
2076
2197
|
}
|
|
2077
2198
|
namespace MaxGroupTieredPackagePrice {
|
|
2078
2199
|
interface BillableMetric {
|
|
@@ -2116,12 +2237,174 @@ export declare namespace Price {
|
|
|
2116
2237
|
*/
|
|
2117
2238
|
minimum_amount: string;
|
|
2118
2239
|
}
|
|
2240
|
+
interface DimensionalPriceConfiguration {
|
|
2241
|
+
dimension_values: Array<string>;
|
|
2242
|
+
dimensional_price_group_id: string;
|
|
2243
|
+
}
|
|
2244
|
+
}
|
|
2245
|
+
interface ScalableMatrixWithUnitPricingPrice {
|
|
2246
|
+
id: string;
|
|
2247
|
+
billable_metric: ScalableMatrixWithUnitPricingPrice.BillableMetric | null;
|
|
2248
|
+
billing_cycle_configuration: ScalableMatrixWithUnitPricingPrice.BillingCycleConfiguration;
|
|
2249
|
+
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
2250
|
+
conversion_rate: number | null;
|
|
2251
|
+
created_at: string;
|
|
2252
|
+
credit_allocation: ScalableMatrixWithUnitPricingPrice.CreditAllocation | null;
|
|
2253
|
+
currency: string;
|
|
2254
|
+
discount: Shared.Discount | null;
|
|
2255
|
+
external_price_id: string | null;
|
|
2256
|
+
fixed_price_quantity: number | null;
|
|
2257
|
+
invoicing_cycle_configuration: ScalableMatrixWithUnitPricingPrice.InvoicingCycleConfiguration | null;
|
|
2258
|
+
item: ScalableMatrixWithUnitPricingPrice.Item;
|
|
2259
|
+
maximum: ScalableMatrixWithUnitPricingPrice.Maximum | null;
|
|
2260
|
+
maximum_amount: string | null;
|
|
2261
|
+
/**
|
|
2262
|
+
* User specified key-value pairs for the resource. If not present, this defaults
|
|
2263
|
+
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
2264
|
+
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
2265
|
+
* `null`.
|
|
2266
|
+
*/
|
|
2267
|
+
metadata: Record<string, string>;
|
|
2268
|
+
minimum: ScalableMatrixWithUnitPricingPrice.Minimum | null;
|
|
2269
|
+
minimum_amount: string | null;
|
|
2270
|
+
model_type: 'scalable_matrix_with_unit_pricing';
|
|
2271
|
+
name: string;
|
|
2272
|
+
plan_phase_order: number | null;
|
|
2273
|
+
price_type: 'usage_price' | 'fixed_price';
|
|
2274
|
+
scalable_matrix_with_unit_pricing_config: Record<string, unknown>;
|
|
2275
|
+
dimensional_price_configuration?: ScalableMatrixWithUnitPricingPrice.DimensionalPriceConfiguration | null;
|
|
2276
|
+
}
|
|
2277
|
+
namespace ScalableMatrixWithUnitPricingPrice {
|
|
2278
|
+
interface BillableMetric {
|
|
2279
|
+
id: string;
|
|
2280
|
+
}
|
|
2281
|
+
interface BillingCycleConfiguration {
|
|
2282
|
+
duration: number;
|
|
2283
|
+
duration_unit: 'day' | 'month';
|
|
2284
|
+
}
|
|
2285
|
+
interface CreditAllocation {
|
|
2286
|
+
allows_rollover: boolean;
|
|
2287
|
+
currency: string;
|
|
2288
|
+
}
|
|
2289
|
+
interface InvoicingCycleConfiguration {
|
|
2290
|
+
duration: number;
|
|
2291
|
+
duration_unit: 'day' | 'month';
|
|
2292
|
+
}
|
|
2293
|
+
interface Item {
|
|
2294
|
+
id: string;
|
|
2295
|
+
name: string;
|
|
2296
|
+
}
|
|
2297
|
+
interface Maximum {
|
|
2298
|
+
/**
|
|
2299
|
+
* List of price_ids that this maximum amount applies to. For plan/plan phase
|
|
2300
|
+
* maximums, this can be a subset of prices.
|
|
2301
|
+
*/
|
|
2302
|
+
applies_to_price_ids: Array<string>;
|
|
2303
|
+
/**
|
|
2304
|
+
* Maximum amount applied
|
|
2305
|
+
*/
|
|
2306
|
+
maximum_amount: string;
|
|
2307
|
+
}
|
|
2308
|
+
interface Minimum {
|
|
2309
|
+
/**
|
|
2310
|
+
* List of price_ids that this minimum amount applies to. For plan/plan phase
|
|
2311
|
+
* minimums, this can be a subset of prices.
|
|
2312
|
+
*/
|
|
2313
|
+
applies_to_price_ids: Array<string>;
|
|
2314
|
+
/**
|
|
2315
|
+
* Minimum amount applied
|
|
2316
|
+
*/
|
|
2317
|
+
minimum_amount: string;
|
|
2318
|
+
}
|
|
2319
|
+
interface DimensionalPriceConfiguration {
|
|
2320
|
+
dimension_values: Array<string>;
|
|
2321
|
+
dimensional_price_group_id: string;
|
|
2322
|
+
}
|
|
2323
|
+
}
|
|
2324
|
+
interface ScalableMatrixWithTieredPricingPrice {
|
|
2325
|
+
id: string;
|
|
2326
|
+
billable_metric: ScalableMatrixWithTieredPricingPrice.BillableMetric | null;
|
|
2327
|
+
billing_cycle_configuration: ScalableMatrixWithTieredPricingPrice.BillingCycleConfiguration;
|
|
2328
|
+
cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
|
|
2329
|
+
conversion_rate: number | null;
|
|
2330
|
+
created_at: string;
|
|
2331
|
+
credit_allocation: ScalableMatrixWithTieredPricingPrice.CreditAllocation | null;
|
|
2332
|
+
currency: string;
|
|
2333
|
+
discount: Shared.Discount | null;
|
|
2334
|
+
external_price_id: string | null;
|
|
2335
|
+
fixed_price_quantity: number | null;
|
|
2336
|
+
invoicing_cycle_configuration: ScalableMatrixWithTieredPricingPrice.InvoicingCycleConfiguration | null;
|
|
2337
|
+
item: ScalableMatrixWithTieredPricingPrice.Item;
|
|
2338
|
+
maximum: ScalableMatrixWithTieredPricingPrice.Maximum | null;
|
|
2339
|
+
maximum_amount: string | null;
|
|
2340
|
+
/**
|
|
2341
|
+
* User specified key-value pairs for the resource. If not present, this defaults
|
|
2342
|
+
* to an empty dictionary. Individual keys can be removed by setting the value to
|
|
2343
|
+
* `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
2344
|
+
* `null`.
|
|
2345
|
+
*/
|
|
2346
|
+
metadata: Record<string, string>;
|
|
2347
|
+
minimum: ScalableMatrixWithTieredPricingPrice.Minimum | null;
|
|
2348
|
+
minimum_amount: string | null;
|
|
2349
|
+
model_type: 'scalable_matrix_with_tiered_pricing';
|
|
2350
|
+
name: string;
|
|
2351
|
+
plan_phase_order: number | null;
|
|
2352
|
+
price_type: 'usage_price' | 'fixed_price';
|
|
2353
|
+
scalable_matrix_with_tiered_pricing_config: Record<string, unknown>;
|
|
2354
|
+
dimensional_price_configuration?: ScalableMatrixWithTieredPricingPrice.DimensionalPriceConfiguration | null;
|
|
2355
|
+
}
|
|
2356
|
+
namespace ScalableMatrixWithTieredPricingPrice {
|
|
2357
|
+
interface BillableMetric {
|
|
2358
|
+
id: string;
|
|
2359
|
+
}
|
|
2360
|
+
interface BillingCycleConfiguration {
|
|
2361
|
+
duration: number;
|
|
2362
|
+
duration_unit: 'day' | 'month';
|
|
2363
|
+
}
|
|
2364
|
+
interface CreditAllocation {
|
|
2365
|
+
allows_rollover: boolean;
|
|
2366
|
+
currency: string;
|
|
2367
|
+
}
|
|
2368
|
+
interface InvoicingCycleConfiguration {
|
|
2369
|
+
duration: number;
|
|
2370
|
+
duration_unit: 'day' | 'month';
|
|
2371
|
+
}
|
|
2372
|
+
interface Item {
|
|
2373
|
+
id: string;
|
|
2374
|
+
name: string;
|
|
2375
|
+
}
|
|
2376
|
+
interface Maximum {
|
|
2377
|
+
/**
|
|
2378
|
+
* List of price_ids that this maximum amount applies to. For plan/plan phase
|
|
2379
|
+
* maximums, this can be a subset of prices.
|
|
2380
|
+
*/
|
|
2381
|
+
applies_to_price_ids: Array<string>;
|
|
2382
|
+
/**
|
|
2383
|
+
* Maximum amount applied
|
|
2384
|
+
*/
|
|
2385
|
+
maximum_amount: string;
|
|
2386
|
+
}
|
|
2387
|
+
interface Minimum {
|
|
2388
|
+
/**
|
|
2389
|
+
* List of price_ids that this minimum amount applies to. For plan/plan phase
|
|
2390
|
+
* minimums, this can be a subset of prices.
|
|
2391
|
+
*/
|
|
2392
|
+
applies_to_price_ids: Array<string>;
|
|
2393
|
+
/**
|
|
2394
|
+
* Minimum amount applied
|
|
2395
|
+
*/
|
|
2396
|
+
minimum_amount: string;
|
|
2397
|
+
}
|
|
2398
|
+
interface DimensionalPriceConfiguration {
|
|
2399
|
+
dimension_values: Array<string>;
|
|
2400
|
+
dimensional_price_group_id: string;
|
|
2401
|
+
}
|
|
2119
2402
|
}
|
|
2120
2403
|
}
|
|
2121
2404
|
export interface PriceEvaluateResponse {
|
|
2122
2405
|
data: Array<EvaluatePriceGroup>;
|
|
2123
2406
|
}
|
|
2124
|
-
export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingTieredBpsPrice | PriceCreateParams.NewFloatingBpsPrice | PriceCreateParams.NewFloatingBulkBpsPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice;
|
|
2407
|
+
export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingTieredBpsPrice | PriceCreateParams.NewFloatingBpsPrice | PriceCreateParams.NewFloatingBulkBpsPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice;
|
|
2125
2408
|
export declare namespace PriceCreateParams {
|
|
2126
2409
|
interface NewFloatingUnitPrice {
|
|
2127
2410
|
/**
|
|
@@ -2141,7 +2424,7 @@ export declare namespace PriceCreateParams {
|
|
|
2141
2424
|
* The name of the price.
|
|
2142
2425
|
*/
|
|
2143
2426
|
name: string;
|
|
2144
|
-
unit_config:
|
|
2427
|
+
unit_config: NewFloatingUnitPrice.UnitConfig;
|
|
2145
2428
|
/**
|
|
2146
2429
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2147
2430
|
* usage-based.
|
|
@@ -2156,7 +2439,7 @@ export declare namespace PriceCreateParams {
|
|
|
2156
2439
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
2157
2440
|
* months.
|
|
2158
2441
|
*/
|
|
2159
|
-
billing_cycle_configuration?:
|
|
2442
|
+
billing_cycle_configuration?: NewFloatingUnitPrice.BillingCycleConfiguration | null;
|
|
2160
2443
|
/**
|
|
2161
2444
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2162
2445
|
*/
|
|
@@ -2178,7 +2461,7 @@ export declare namespace PriceCreateParams {
|
|
|
2178
2461
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2179
2462
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
2180
2463
|
*/
|
|
2181
|
-
invoicing_cycle_configuration?:
|
|
2464
|
+
invoicing_cycle_configuration?: NewFloatingUnitPrice.InvoicingCycleConfiguration | null;
|
|
2182
2465
|
/**
|
|
2183
2466
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2184
2467
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -2240,7 +2523,7 @@ export declare namespace PriceCreateParams {
|
|
|
2240
2523
|
* The name of the price.
|
|
2241
2524
|
*/
|
|
2242
2525
|
name: string;
|
|
2243
|
-
package_config:
|
|
2526
|
+
package_config: NewFloatingPackagePrice.PackageConfig;
|
|
2244
2527
|
/**
|
|
2245
2528
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2246
2529
|
* usage-based.
|
|
@@ -2255,7 +2538,7 @@ export declare namespace PriceCreateParams {
|
|
|
2255
2538
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
2256
2539
|
* months.
|
|
2257
2540
|
*/
|
|
2258
|
-
billing_cycle_configuration?:
|
|
2541
|
+
billing_cycle_configuration?: NewFloatingPackagePrice.BillingCycleConfiguration | null;
|
|
2259
2542
|
/**
|
|
2260
2543
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2261
2544
|
*/
|
|
@@ -2277,7 +2560,7 @@ export declare namespace PriceCreateParams {
|
|
|
2277
2560
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2278
2561
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
2279
2562
|
*/
|
|
2280
|
-
invoicing_cycle_configuration?:
|
|
2563
|
+
invoicing_cycle_configuration?: NewFloatingPackagePrice.InvoicingCycleConfiguration | null;
|
|
2281
2564
|
/**
|
|
2282
2565
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2283
2566
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -2339,7 +2622,7 @@ export declare namespace PriceCreateParams {
|
|
|
2339
2622
|
* The id of the item the plan will be associated with.
|
|
2340
2623
|
*/
|
|
2341
2624
|
item_id: string;
|
|
2342
|
-
matrix_config:
|
|
2625
|
+
matrix_config: NewFloatingMatrixPrice.MatrixConfig;
|
|
2343
2626
|
model_type: 'matrix';
|
|
2344
2627
|
/**
|
|
2345
2628
|
* The name of the price.
|
|
@@ -2359,7 +2642,7 @@ export declare namespace PriceCreateParams {
|
|
|
2359
2642
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
2360
2643
|
* months.
|
|
2361
2644
|
*/
|
|
2362
|
-
billing_cycle_configuration?:
|
|
2645
|
+
billing_cycle_configuration?: NewFloatingMatrixPrice.BillingCycleConfiguration | null;
|
|
2363
2646
|
/**
|
|
2364
2647
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2365
2648
|
*/
|
|
@@ -2381,7 +2664,7 @@ export declare namespace PriceCreateParams {
|
|
|
2381
2664
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2382
2665
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
2383
2666
|
*/
|
|
2384
|
-
invoicing_cycle_configuration?:
|
|
2667
|
+
invoicing_cycle_configuration?: NewFloatingMatrixPrice.InvoicingCycleConfiguration | null;
|
|
2385
2668
|
/**
|
|
2386
2669
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2387
2670
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -2460,7 +2743,7 @@ export declare namespace PriceCreateParams {
|
|
|
2460
2743
|
* The id of the item the plan will be associated with.
|
|
2461
2744
|
*/
|
|
2462
2745
|
item_id: string;
|
|
2463
|
-
matrix_with_allocation_config:
|
|
2746
|
+
matrix_with_allocation_config: NewFloatingMatrixWithAllocationPrice.MatrixWithAllocationConfig;
|
|
2464
2747
|
model_type: 'matrix_with_allocation';
|
|
2465
2748
|
/**
|
|
2466
2749
|
* The name of the price.
|
|
@@ -2480,7 +2763,7 @@ export declare namespace PriceCreateParams {
|
|
|
2480
2763
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
2481
2764
|
* months.
|
|
2482
2765
|
*/
|
|
2483
|
-
billing_cycle_configuration?:
|
|
2766
|
+
billing_cycle_configuration?: NewFloatingMatrixWithAllocationPrice.BillingCycleConfiguration | null;
|
|
2484
2767
|
/**
|
|
2485
2768
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2486
2769
|
*/
|
|
@@ -2502,7 +2785,7 @@ export declare namespace PriceCreateParams {
|
|
|
2502
2785
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2503
2786
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
2504
2787
|
*/
|
|
2505
|
-
invoicing_cycle_configuration?:
|
|
2788
|
+
invoicing_cycle_configuration?: NewFloatingMatrixWithAllocationPrice.InvoicingCycleConfiguration | null;
|
|
2506
2789
|
/**
|
|
2507
2790
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2508
2791
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -2590,7 +2873,7 @@ export declare namespace PriceCreateParams {
|
|
|
2590
2873
|
* The name of the price.
|
|
2591
2874
|
*/
|
|
2592
2875
|
name: string;
|
|
2593
|
-
tiered_config:
|
|
2876
|
+
tiered_config: NewFloatingTieredPrice.TieredConfig;
|
|
2594
2877
|
/**
|
|
2595
2878
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2596
2879
|
* usage-based.
|
|
@@ -2605,7 +2888,7 @@ export declare namespace PriceCreateParams {
|
|
|
2605
2888
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
2606
2889
|
* months.
|
|
2607
2890
|
*/
|
|
2608
|
-
billing_cycle_configuration?:
|
|
2891
|
+
billing_cycle_configuration?: NewFloatingTieredPrice.BillingCycleConfiguration | null;
|
|
2609
2892
|
/**
|
|
2610
2893
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2611
2894
|
*/
|
|
@@ -2627,7 +2910,7 @@ export declare namespace PriceCreateParams {
|
|
|
2627
2910
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2628
2911
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
2629
2912
|
*/
|
|
2630
|
-
invoicing_cycle_configuration?:
|
|
2913
|
+
invoicing_cycle_configuration?: NewFloatingTieredPrice.InvoicingCycleConfiguration | null;
|
|
2631
2914
|
/**
|
|
2632
2915
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2633
2916
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -2705,7 +2988,7 @@ export declare namespace PriceCreateParams {
|
|
|
2705
2988
|
* The name of the price.
|
|
2706
2989
|
*/
|
|
2707
2990
|
name: string;
|
|
2708
|
-
tiered_bps_config:
|
|
2991
|
+
tiered_bps_config: NewFloatingTieredBpsPrice.TieredBpsConfig;
|
|
2709
2992
|
/**
|
|
2710
2993
|
* The id of the billable metric for the price. Only needed if the price is
|
|
2711
2994
|
* usage-based.
|
|
@@ -2720,7 +3003,7 @@ export declare namespace PriceCreateParams {
|
|
|
2720
3003
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
2721
3004
|
* months.
|
|
2722
3005
|
*/
|
|
2723
|
-
billing_cycle_configuration?:
|
|
3006
|
+
billing_cycle_configuration?: NewFloatingTieredBpsPrice.BillingCycleConfiguration | null;
|
|
2724
3007
|
/**
|
|
2725
3008
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2726
3009
|
*/
|
|
@@ -2742,7 +3025,7 @@ export declare namespace PriceCreateParams {
|
|
|
2742
3025
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2743
3026
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
2744
3027
|
*/
|
|
2745
|
-
invoicing_cycle_configuration?:
|
|
3028
|
+
invoicing_cycle_configuration?: NewFloatingTieredBpsPrice.InvoicingCycleConfiguration | null;
|
|
2746
3029
|
/**
|
|
2747
3030
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2748
3031
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -2808,7 +3091,7 @@ export declare namespace PriceCreateParams {
|
|
|
2808
3091
|
}
|
|
2809
3092
|
}
|
|
2810
3093
|
interface NewFloatingBpsPrice {
|
|
2811
|
-
bps_config:
|
|
3094
|
+
bps_config: NewFloatingBpsPrice.BpsConfig;
|
|
2812
3095
|
/**
|
|
2813
3096
|
* The cadence to bill for this price on.
|
|
2814
3097
|
*/
|
|
@@ -2840,7 +3123,7 @@ export declare namespace PriceCreateParams {
|
|
|
2840
3123
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
2841
3124
|
* months.
|
|
2842
3125
|
*/
|
|
2843
|
-
billing_cycle_configuration?:
|
|
3126
|
+
billing_cycle_configuration?: NewFloatingBpsPrice.BillingCycleConfiguration | null;
|
|
2844
3127
|
/**
|
|
2845
3128
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2846
3129
|
*/
|
|
@@ -2862,7 +3145,7 @@ export declare namespace PriceCreateParams {
|
|
|
2862
3145
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2863
3146
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
2864
3147
|
*/
|
|
2865
|
-
invoicing_cycle_configuration?:
|
|
3148
|
+
invoicing_cycle_configuration?: NewFloatingBpsPrice.InvoicingCycleConfiguration | null;
|
|
2866
3149
|
/**
|
|
2867
3150
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2868
3151
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -2911,7 +3194,7 @@ export declare namespace PriceCreateParams {
|
|
|
2911
3194
|
}
|
|
2912
3195
|
}
|
|
2913
3196
|
interface NewFloatingBulkBpsPrice {
|
|
2914
|
-
bulk_bps_config:
|
|
3197
|
+
bulk_bps_config: NewFloatingBulkBpsPrice.BulkBpsConfig;
|
|
2915
3198
|
/**
|
|
2916
3199
|
* The cadence to bill for this price on.
|
|
2917
3200
|
*/
|
|
@@ -2943,7 +3226,7 @@ export declare namespace PriceCreateParams {
|
|
|
2943
3226
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
2944
3227
|
* months.
|
|
2945
3228
|
*/
|
|
2946
|
-
billing_cycle_configuration?:
|
|
3229
|
+
billing_cycle_configuration?: NewFloatingBulkBpsPrice.BillingCycleConfiguration | null;
|
|
2947
3230
|
/**
|
|
2948
3231
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
2949
3232
|
*/
|
|
@@ -2965,7 +3248,7 @@ export declare namespace PriceCreateParams {
|
|
|
2965
3248
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
2966
3249
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
2967
3250
|
*/
|
|
2968
|
-
invoicing_cycle_configuration?:
|
|
3251
|
+
invoicing_cycle_configuration?: NewFloatingBulkBpsPrice.InvoicingCycleConfiguration | null;
|
|
2969
3252
|
/**
|
|
2970
3253
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
2971
3254
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3027,7 +3310,7 @@ export declare namespace PriceCreateParams {
|
|
|
3027
3310
|
}
|
|
3028
3311
|
}
|
|
3029
3312
|
interface NewFloatingBulkPrice {
|
|
3030
|
-
bulk_config:
|
|
3313
|
+
bulk_config: NewFloatingBulkPrice.BulkConfig;
|
|
3031
3314
|
/**
|
|
3032
3315
|
* The cadence to bill for this price on.
|
|
3033
3316
|
*/
|
|
@@ -3059,7 +3342,7 @@ export declare namespace PriceCreateParams {
|
|
|
3059
3342
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3060
3343
|
* months.
|
|
3061
3344
|
*/
|
|
3062
|
-
billing_cycle_configuration?:
|
|
3345
|
+
billing_cycle_configuration?: NewFloatingBulkPrice.BillingCycleConfiguration | null;
|
|
3063
3346
|
/**
|
|
3064
3347
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3065
3348
|
*/
|
|
@@ -3081,7 +3364,7 @@ export declare namespace PriceCreateParams {
|
|
|
3081
3364
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3082
3365
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3083
3366
|
*/
|
|
3084
|
-
invoicing_cycle_configuration?:
|
|
3367
|
+
invoicing_cycle_configuration?: NewFloatingBulkPrice.InvoicingCycleConfiguration | null;
|
|
3085
3368
|
/**
|
|
3086
3369
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3087
3370
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3170,7 +3453,7 @@ export declare namespace PriceCreateParams {
|
|
|
3170
3453
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3171
3454
|
* months.
|
|
3172
3455
|
*/
|
|
3173
|
-
billing_cycle_configuration?:
|
|
3456
|
+
billing_cycle_configuration?: NewFloatingThresholdTotalAmountPrice.BillingCycleConfiguration | null;
|
|
3174
3457
|
/**
|
|
3175
3458
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3176
3459
|
*/
|
|
@@ -3192,7 +3475,7 @@ export declare namespace PriceCreateParams {
|
|
|
3192
3475
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3193
3476
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3194
3477
|
*/
|
|
3195
|
-
invoicing_cycle_configuration?:
|
|
3478
|
+
invoicing_cycle_configuration?: NewFloatingThresholdTotalAmountPrice.InvoicingCycleConfiguration | null;
|
|
3196
3479
|
/**
|
|
3197
3480
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3198
3481
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3263,7 +3546,7 @@ export declare namespace PriceCreateParams {
|
|
|
3263
3546
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3264
3547
|
* months.
|
|
3265
3548
|
*/
|
|
3266
|
-
billing_cycle_configuration?:
|
|
3549
|
+
billing_cycle_configuration?: NewFloatingTieredPackagePrice.BillingCycleConfiguration | null;
|
|
3267
3550
|
/**
|
|
3268
3551
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3269
3552
|
*/
|
|
@@ -3285,7 +3568,7 @@ export declare namespace PriceCreateParams {
|
|
|
3285
3568
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3286
3569
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3287
3570
|
*/
|
|
3288
|
-
invoicing_cycle_configuration?:
|
|
3571
|
+
invoicing_cycle_configuration?: NewFloatingTieredPackagePrice.InvoicingCycleConfiguration | null;
|
|
3289
3572
|
/**
|
|
3290
3573
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3291
3574
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3356,7 +3639,7 @@ export declare namespace PriceCreateParams {
|
|
|
3356
3639
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3357
3640
|
* months.
|
|
3358
3641
|
*/
|
|
3359
|
-
billing_cycle_configuration?:
|
|
3642
|
+
billing_cycle_configuration?: NewFloatingGroupedTieredPrice.BillingCycleConfiguration | null;
|
|
3360
3643
|
/**
|
|
3361
3644
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3362
3645
|
*/
|
|
@@ -3378,7 +3661,7 @@ export declare namespace PriceCreateParams {
|
|
|
3378
3661
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3379
3662
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3380
3663
|
*/
|
|
3381
|
-
invoicing_cycle_configuration?:
|
|
3664
|
+
invoicing_cycle_configuration?: NewFloatingGroupedTieredPrice.InvoicingCycleConfiguration | null;
|
|
3382
3665
|
/**
|
|
3383
3666
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3384
3667
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3449,7 +3732,7 @@ export declare namespace PriceCreateParams {
|
|
|
3449
3732
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3450
3733
|
* months.
|
|
3451
3734
|
*/
|
|
3452
|
-
billing_cycle_configuration?:
|
|
3735
|
+
billing_cycle_configuration?: NewFloatingMaxGroupTieredPackagePrice.BillingCycleConfiguration | null;
|
|
3453
3736
|
/**
|
|
3454
3737
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3455
3738
|
*/
|
|
@@ -3471,7 +3754,7 @@ export declare namespace PriceCreateParams {
|
|
|
3471
3754
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3472
3755
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3473
3756
|
*/
|
|
3474
|
-
invoicing_cycle_configuration?:
|
|
3757
|
+
invoicing_cycle_configuration?: NewFloatingMaxGroupTieredPackagePrice.InvoicingCycleConfiguration | null;
|
|
3475
3758
|
/**
|
|
3476
3759
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3477
3760
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3542,7 +3825,7 @@ export declare namespace PriceCreateParams {
|
|
|
3542
3825
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3543
3826
|
* months.
|
|
3544
3827
|
*/
|
|
3545
|
-
billing_cycle_configuration?:
|
|
3828
|
+
billing_cycle_configuration?: NewFloatingTieredWithMinimumPrice.BillingCycleConfiguration | null;
|
|
3546
3829
|
/**
|
|
3547
3830
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3548
3831
|
*/
|
|
@@ -3564,7 +3847,7 @@ export declare namespace PriceCreateParams {
|
|
|
3564
3847
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3565
3848
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3566
3849
|
*/
|
|
3567
|
-
invoicing_cycle_configuration?:
|
|
3850
|
+
invoicing_cycle_configuration?: NewFloatingTieredWithMinimumPrice.InvoicingCycleConfiguration | null;
|
|
3568
3851
|
/**
|
|
3569
3852
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3570
3853
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3635,7 +3918,7 @@ export declare namespace PriceCreateParams {
|
|
|
3635
3918
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3636
3919
|
* months.
|
|
3637
3920
|
*/
|
|
3638
|
-
billing_cycle_configuration?:
|
|
3921
|
+
billing_cycle_configuration?: NewFloatingPackageWithAllocationPrice.BillingCycleConfiguration | null;
|
|
3639
3922
|
/**
|
|
3640
3923
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3641
3924
|
*/
|
|
@@ -3657,7 +3940,7 @@ export declare namespace PriceCreateParams {
|
|
|
3657
3940
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3658
3941
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3659
3942
|
*/
|
|
3660
|
-
invoicing_cycle_configuration?:
|
|
3943
|
+
invoicing_cycle_configuration?: NewFloatingPackageWithAllocationPrice.InvoicingCycleConfiguration | null;
|
|
3661
3944
|
/**
|
|
3662
3945
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3663
3946
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3728,7 +4011,7 @@ export declare namespace PriceCreateParams {
|
|
|
3728
4011
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3729
4012
|
* months.
|
|
3730
4013
|
*/
|
|
3731
|
-
billing_cycle_configuration?:
|
|
4014
|
+
billing_cycle_configuration?: NewFloatingTieredPackageWithMinimumPrice.BillingCycleConfiguration | null;
|
|
3732
4015
|
/**
|
|
3733
4016
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3734
4017
|
*/
|
|
@@ -3750,7 +4033,7 @@ export declare namespace PriceCreateParams {
|
|
|
3750
4033
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3751
4034
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3752
4035
|
*/
|
|
3753
|
-
invoicing_cycle_configuration?:
|
|
4036
|
+
invoicing_cycle_configuration?: NewFloatingTieredPackageWithMinimumPrice.InvoicingCycleConfiguration | null;
|
|
3754
4037
|
/**
|
|
3755
4038
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3756
4039
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3821,7 +4104,7 @@ export declare namespace PriceCreateParams {
|
|
|
3821
4104
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3822
4105
|
* months.
|
|
3823
4106
|
*/
|
|
3824
|
-
billing_cycle_configuration?:
|
|
4107
|
+
billing_cycle_configuration?: NewFloatingUnitWithPercentPrice.BillingCycleConfiguration | null;
|
|
3825
4108
|
/**
|
|
3826
4109
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3827
4110
|
*/
|
|
@@ -3843,7 +4126,7 @@ export declare namespace PriceCreateParams {
|
|
|
3843
4126
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3844
4127
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3845
4128
|
*/
|
|
3846
|
-
invoicing_cycle_configuration?:
|
|
4129
|
+
invoicing_cycle_configuration?: NewFloatingUnitWithPercentPrice.InvoicingCycleConfiguration | null;
|
|
3847
4130
|
/**
|
|
3848
4131
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3849
4132
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -3914,7 +4197,7 @@ export declare namespace PriceCreateParams {
|
|
|
3914
4197
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
3915
4198
|
* months.
|
|
3916
4199
|
*/
|
|
3917
|
-
billing_cycle_configuration?:
|
|
4200
|
+
billing_cycle_configuration?: NewFloatingTieredWithProrationPrice.BillingCycleConfiguration | null;
|
|
3918
4201
|
/**
|
|
3919
4202
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
3920
4203
|
*/
|
|
@@ -3936,7 +4219,7 @@ export declare namespace PriceCreateParams {
|
|
|
3936
4219
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3937
4220
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
3938
4221
|
*/
|
|
3939
|
-
invoicing_cycle_configuration?:
|
|
4222
|
+
invoicing_cycle_configuration?: NewFloatingTieredWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
3940
4223
|
/**
|
|
3941
4224
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3942
4225
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4007,7 +4290,7 @@ export declare namespace PriceCreateParams {
|
|
|
4007
4290
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
4008
4291
|
* months.
|
|
4009
4292
|
*/
|
|
4010
|
-
billing_cycle_configuration?:
|
|
4293
|
+
billing_cycle_configuration?: NewFloatingUnitWithProrationPrice.BillingCycleConfiguration | null;
|
|
4011
4294
|
/**
|
|
4012
4295
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4013
4296
|
*/
|
|
@@ -4029,7 +4312,7 @@ export declare namespace PriceCreateParams {
|
|
|
4029
4312
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4030
4313
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
4031
4314
|
*/
|
|
4032
|
-
invoicing_cycle_configuration?:
|
|
4315
|
+
invoicing_cycle_configuration?: NewFloatingUnitWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
4033
4316
|
/**
|
|
4034
4317
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4035
4318
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4100,7 +4383,7 @@ export declare namespace PriceCreateParams {
|
|
|
4100
4383
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
4101
4384
|
* months.
|
|
4102
4385
|
*/
|
|
4103
|
-
billing_cycle_configuration?:
|
|
4386
|
+
billing_cycle_configuration?: NewFloatingGroupedAllocationPrice.BillingCycleConfiguration | null;
|
|
4104
4387
|
/**
|
|
4105
4388
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4106
4389
|
*/
|
|
@@ -4122,7 +4405,7 @@ export declare namespace PriceCreateParams {
|
|
|
4122
4405
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4123
4406
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
4124
4407
|
*/
|
|
4125
|
-
invoicing_cycle_configuration?:
|
|
4408
|
+
invoicing_cycle_configuration?: NewFloatingGroupedAllocationPrice.InvoicingCycleConfiguration | null;
|
|
4126
4409
|
/**
|
|
4127
4410
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4128
4411
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4193,7 +4476,7 @@ export declare namespace PriceCreateParams {
|
|
|
4193
4476
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
4194
4477
|
* months.
|
|
4195
4478
|
*/
|
|
4196
|
-
billing_cycle_configuration?:
|
|
4479
|
+
billing_cycle_configuration?: NewFloatingGroupedWithProratedMinimumPrice.BillingCycleConfiguration | null;
|
|
4197
4480
|
/**
|
|
4198
4481
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4199
4482
|
*/
|
|
@@ -4215,7 +4498,7 @@ export declare namespace PriceCreateParams {
|
|
|
4215
4498
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4216
4499
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
4217
4500
|
*/
|
|
4218
|
-
invoicing_cycle_configuration?:
|
|
4501
|
+
invoicing_cycle_configuration?: NewFloatingGroupedWithProratedMinimumPrice.InvoicingCycleConfiguration | null;
|
|
4219
4502
|
/**
|
|
4220
4503
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4221
4504
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4286,7 +4569,7 @@ export declare namespace PriceCreateParams {
|
|
|
4286
4569
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
4287
4570
|
* months.
|
|
4288
4571
|
*/
|
|
4289
|
-
billing_cycle_configuration?:
|
|
4572
|
+
billing_cycle_configuration?: NewFloatingGroupedWithMeteredMinimumPrice.BillingCycleConfiguration | null;
|
|
4290
4573
|
/**
|
|
4291
4574
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4292
4575
|
*/
|
|
@@ -4308,7 +4591,7 @@ export declare namespace PriceCreateParams {
|
|
|
4308
4591
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4309
4592
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
4310
4593
|
*/
|
|
4311
|
-
invoicing_cycle_configuration?:
|
|
4594
|
+
invoicing_cycle_configuration?: NewFloatingGroupedWithMeteredMinimumPrice.InvoicingCycleConfiguration | null;
|
|
4312
4595
|
/**
|
|
4313
4596
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4314
4597
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4379,7 +4662,7 @@ export declare namespace PriceCreateParams {
|
|
|
4379
4662
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
4380
4663
|
* months.
|
|
4381
4664
|
*/
|
|
4382
|
-
billing_cycle_configuration?:
|
|
4665
|
+
billing_cycle_configuration?: NewFloatingMatrixWithDisplayNamePrice.BillingCycleConfiguration | null;
|
|
4383
4666
|
/**
|
|
4384
4667
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4385
4668
|
*/
|
|
@@ -4401,7 +4684,7 @@ export declare namespace PriceCreateParams {
|
|
|
4401
4684
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4402
4685
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
4403
4686
|
*/
|
|
4404
|
-
invoicing_cycle_configuration?:
|
|
4687
|
+
invoicing_cycle_configuration?: NewFloatingMatrixWithDisplayNamePrice.InvoicingCycleConfiguration | null;
|
|
4405
4688
|
/**
|
|
4406
4689
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4407
4690
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4472,7 +4755,7 @@ export declare namespace PriceCreateParams {
|
|
|
4472
4755
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
4473
4756
|
* months.
|
|
4474
4757
|
*/
|
|
4475
|
-
billing_cycle_configuration?:
|
|
4758
|
+
billing_cycle_configuration?: NewFloatingBulkWithProrationPrice.BillingCycleConfiguration | null;
|
|
4476
4759
|
/**
|
|
4477
4760
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4478
4761
|
*/
|
|
@@ -4494,7 +4777,7 @@ export declare namespace PriceCreateParams {
|
|
|
4494
4777
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4495
4778
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
4496
4779
|
*/
|
|
4497
|
-
invoicing_cycle_configuration?:
|
|
4780
|
+
invoicing_cycle_configuration?: NewFloatingBulkWithProrationPrice.InvoicingCycleConfiguration | null;
|
|
4498
4781
|
/**
|
|
4499
4782
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4500
4783
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4565,7 +4848,7 @@ export declare namespace PriceCreateParams {
|
|
|
4565
4848
|
* For custom cadence: specifies the duration of the billing period in days or
|
|
4566
4849
|
* months.
|
|
4567
4850
|
*/
|
|
4568
|
-
billing_cycle_configuration?:
|
|
4851
|
+
billing_cycle_configuration?: NewFloatingGroupedTieredPackagePrice.BillingCycleConfiguration | null;
|
|
4569
4852
|
/**
|
|
4570
4853
|
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4571
4854
|
*/
|
|
@@ -4587,7 +4870,7 @@ export declare namespace PriceCreateParams {
|
|
|
4587
4870
|
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4588
4871
|
* If unspecified, a single invoice is produced per billing cycle.
|
|
4589
4872
|
*/
|
|
4590
|
-
invoicing_cycle_configuration?:
|
|
4873
|
+
invoicing_cycle_configuration?: NewFloatingGroupedTieredPackagePrice.InvoicingCycleConfiguration | null;
|
|
4591
4874
|
/**
|
|
4592
4875
|
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4593
4876
|
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
@@ -4625,6 +4908,192 @@ export declare namespace PriceCreateParams {
|
|
|
4625
4908
|
duration_unit: 'day' | 'month';
|
|
4626
4909
|
}
|
|
4627
4910
|
}
|
|
4911
|
+
interface NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
4912
|
+
/**
|
|
4913
|
+
* The cadence to bill for this price on.
|
|
4914
|
+
*/
|
|
4915
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
4916
|
+
/**
|
|
4917
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
4918
|
+
*/
|
|
4919
|
+
currency: string;
|
|
4920
|
+
/**
|
|
4921
|
+
* The id of the item the plan will be associated with.
|
|
4922
|
+
*/
|
|
4923
|
+
item_id: string;
|
|
4924
|
+
model_type: 'scalable_matrix_with_unit_pricing';
|
|
4925
|
+
/**
|
|
4926
|
+
* The name of the price.
|
|
4927
|
+
*/
|
|
4928
|
+
name: string;
|
|
4929
|
+
scalable_matrix_with_unit_pricing_config: Record<string, unknown>;
|
|
4930
|
+
/**
|
|
4931
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
4932
|
+
* usage-based.
|
|
4933
|
+
*/
|
|
4934
|
+
billable_metric_id?: string | null;
|
|
4935
|
+
/**
|
|
4936
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
4937
|
+
* this is true, and in-arrears if this is false.
|
|
4938
|
+
*/
|
|
4939
|
+
billed_in_advance?: boolean | null;
|
|
4940
|
+
/**
|
|
4941
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4942
|
+
* months.
|
|
4943
|
+
*/
|
|
4944
|
+
billing_cycle_configuration?: NewFloatingScalableMatrixWithUnitPricingPrice.BillingCycleConfiguration | null;
|
|
4945
|
+
/**
|
|
4946
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
4947
|
+
*/
|
|
4948
|
+
conversion_rate?: number | null;
|
|
4949
|
+
/**
|
|
4950
|
+
* An alias for the price.
|
|
4951
|
+
*/
|
|
4952
|
+
external_price_id?: string | null;
|
|
4953
|
+
/**
|
|
4954
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
4955
|
+
* applied.
|
|
4956
|
+
*/
|
|
4957
|
+
fixed_price_quantity?: number | null;
|
|
4958
|
+
/**
|
|
4959
|
+
* The property used to group this price on an invoice
|
|
4960
|
+
*/
|
|
4961
|
+
invoice_grouping_key?: string | null;
|
|
4962
|
+
/**
|
|
4963
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4964
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4965
|
+
*/
|
|
4966
|
+
invoicing_cycle_configuration?: NewFloatingScalableMatrixWithUnitPricingPrice.InvoicingCycleConfiguration | null;
|
|
4967
|
+
/**
|
|
4968
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
4969
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
4970
|
+
* by setting `metadata` to `null`.
|
|
4971
|
+
*/
|
|
4972
|
+
metadata?: Record<string, string | null> | null;
|
|
4973
|
+
}
|
|
4974
|
+
namespace NewFloatingScalableMatrixWithUnitPricingPrice {
|
|
4975
|
+
/**
|
|
4976
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
4977
|
+
* months.
|
|
4978
|
+
*/
|
|
4979
|
+
interface BillingCycleConfiguration {
|
|
4980
|
+
/**
|
|
4981
|
+
* The duration of the billing period.
|
|
4982
|
+
*/
|
|
4983
|
+
duration: number;
|
|
4984
|
+
/**
|
|
4985
|
+
* The unit of billing period duration.
|
|
4986
|
+
*/
|
|
4987
|
+
duration_unit: 'day' | 'month';
|
|
4988
|
+
}
|
|
4989
|
+
/**
|
|
4990
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
4991
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
4992
|
+
*/
|
|
4993
|
+
interface InvoicingCycleConfiguration {
|
|
4994
|
+
/**
|
|
4995
|
+
* The duration of the billing period.
|
|
4996
|
+
*/
|
|
4997
|
+
duration: number;
|
|
4998
|
+
/**
|
|
4999
|
+
* The unit of billing period duration.
|
|
5000
|
+
*/
|
|
5001
|
+
duration_unit: 'day' | 'month';
|
|
5002
|
+
}
|
|
5003
|
+
}
|
|
5004
|
+
interface NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
5005
|
+
/**
|
|
5006
|
+
* The cadence to bill for this price on.
|
|
5007
|
+
*/
|
|
5008
|
+
cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
|
|
5009
|
+
/**
|
|
5010
|
+
* An ISO 4217 currency string for which this price is billed in.
|
|
5011
|
+
*/
|
|
5012
|
+
currency: string;
|
|
5013
|
+
/**
|
|
5014
|
+
* The id of the item the plan will be associated with.
|
|
5015
|
+
*/
|
|
5016
|
+
item_id: string;
|
|
5017
|
+
model_type: 'scalable_matrix_with_tiered_pricing';
|
|
5018
|
+
/**
|
|
5019
|
+
* The name of the price.
|
|
5020
|
+
*/
|
|
5021
|
+
name: string;
|
|
5022
|
+
scalable_matrix_with_tiered_pricing_config: Record<string, unknown>;
|
|
5023
|
+
/**
|
|
5024
|
+
* The id of the billable metric for the price. Only needed if the price is
|
|
5025
|
+
* usage-based.
|
|
5026
|
+
*/
|
|
5027
|
+
billable_metric_id?: string | null;
|
|
5028
|
+
/**
|
|
5029
|
+
* If the Price represents a fixed cost, the price will be billed in-advance if
|
|
5030
|
+
* this is true, and in-arrears if this is false.
|
|
5031
|
+
*/
|
|
5032
|
+
billed_in_advance?: boolean | null;
|
|
5033
|
+
/**
|
|
5034
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5035
|
+
* months.
|
|
5036
|
+
*/
|
|
5037
|
+
billing_cycle_configuration?: NewFloatingScalableMatrixWithTieredPricingPrice.BillingCycleConfiguration | null;
|
|
5038
|
+
/**
|
|
5039
|
+
* The per unit conversion rate of the price currency to the invoicing currency.
|
|
5040
|
+
*/
|
|
5041
|
+
conversion_rate?: number | null;
|
|
5042
|
+
/**
|
|
5043
|
+
* An alias for the price.
|
|
5044
|
+
*/
|
|
5045
|
+
external_price_id?: string | null;
|
|
5046
|
+
/**
|
|
5047
|
+
* If the Price represents a fixed cost, this represents the quantity of units
|
|
5048
|
+
* applied.
|
|
5049
|
+
*/
|
|
5050
|
+
fixed_price_quantity?: number | null;
|
|
5051
|
+
/**
|
|
5052
|
+
* The property used to group this price on an invoice
|
|
5053
|
+
*/
|
|
5054
|
+
invoice_grouping_key?: string | null;
|
|
5055
|
+
/**
|
|
5056
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5057
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5058
|
+
*/
|
|
5059
|
+
invoicing_cycle_configuration?: NewFloatingScalableMatrixWithTieredPricingPrice.InvoicingCycleConfiguration | null;
|
|
5060
|
+
/**
|
|
5061
|
+
* User-specified key/value pairs for the resource. Individual keys can be removed
|
|
5062
|
+
* by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
5063
|
+
* by setting `metadata` to `null`.
|
|
5064
|
+
*/
|
|
5065
|
+
metadata?: Record<string, string | null> | null;
|
|
5066
|
+
}
|
|
5067
|
+
namespace NewFloatingScalableMatrixWithTieredPricingPrice {
|
|
5068
|
+
/**
|
|
5069
|
+
* For custom cadence: specifies the duration of the billing period in days or
|
|
5070
|
+
* months.
|
|
5071
|
+
*/
|
|
5072
|
+
interface BillingCycleConfiguration {
|
|
5073
|
+
/**
|
|
5074
|
+
* The duration of the billing period.
|
|
5075
|
+
*/
|
|
5076
|
+
duration: number;
|
|
5077
|
+
/**
|
|
5078
|
+
* The unit of billing period duration.
|
|
5079
|
+
*/
|
|
5080
|
+
duration_unit: 'day' | 'month';
|
|
5081
|
+
}
|
|
5082
|
+
/**
|
|
5083
|
+
* Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
5084
|
+
* If unspecified, a single invoice is produced per billing cycle.
|
|
5085
|
+
*/
|
|
5086
|
+
interface InvoicingCycleConfiguration {
|
|
5087
|
+
/**
|
|
5088
|
+
* The duration of the billing period.
|
|
5089
|
+
*/
|
|
5090
|
+
duration: number;
|
|
5091
|
+
/**
|
|
5092
|
+
* The unit of billing period duration.
|
|
5093
|
+
*/
|
|
5094
|
+
duration_unit: 'day' | 'month';
|
|
5095
|
+
}
|
|
5096
|
+
}
|
|
4628
5097
|
}
|
|
4629
5098
|
export interface PriceUpdateParams {
|
|
4630
5099
|
/**
|