orb-billing 5.5.1 → 5.6.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 (81) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/index.d.mts +4 -13
  3. package/index.d.ts +4 -13
  4. package/index.d.ts.map +1 -1
  5. package/index.js.map +1 -1
  6. package/index.mjs.map +1 -1
  7. package/package.json +4 -1
  8. package/resources/alerts.d.ts +1 -1
  9. package/resources/beta/beta.d.ts +168 -2
  10. package/resources/beta/beta.d.ts.map +1 -1
  11. package/resources/beta/beta.js.map +1 -1
  12. package/resources/beta/beta.mjs.map +1 -1
  13. package/resources/beta/external-plan-id.d.ts +168 -2
  14. package/resources/beta/external-plan-id.d.ts.map +1 -1
  15. package/resources/customers/balance-transactions.d.ts +2 -2
  16. package/resources/customers/balance-transactions.d.ts.map +1 -1
  17. package/resources/customers/balance-transactions.js.map +1 -1
  18. package/resources/customers/balance-transactions.mjs.map +1 -1
  19. package/resources/customers/credits/ledger.d.ts +22 -8
  20. package/resources/customers/credits/ledger.d.ts.map +1 -1
  21. package/resources/customers/credits/ledger.js.map +1 -1
  22. package/resources/customers/credits/ledger.mjs.map +1 -1
  23. package/resources/customers/customers.d.ts +27 -0
  24. package/resources/customers/customers.d.ts.map +1 -1
  25. package/resources/customers/customers.js.map +1 -1
  26. package/resources/customers/customers.mjs.map +1 -1
  27. package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +1 -1
  28. package/resources/dimensional-price-groups/dimensional-price-groups.js +1 -1
  29. package/resources/dimensional-price-groups/dimensional-price-groups.mjs +1 -1
  30. package/resources/events/backfills.d.ts +2 -2
  31. package/resources/events/backfills.js +2 -2
  32. package/resources/events/backfills.mjs +2 -2
  33. package/resources/index.d.ts +1 -1
  34. package/resources/index.d.ts.map +1 -1
  35. package/resources/index.js.map +1 -1
  36. package/resources/index.mjs.map +1 -1
  37. package/resources/invoice-line-items.d.ts +1 -1
  38. package/resources/invoices.d.ts +36 -11
  39. package/resources/invoices.d.ts.map +1 -1
  40. package/resources/invoices.js +4 -4
  41. package/resources/invoices.js.map +1 -1
  42. package/resources/invoices.mjs +4 -4
  43. package/resources/invoices.mjs.map +1 -1
  44. package/resources/plans/plans.d.ts +84 -1
  45. package/resources/plans/plans.d.ts.map +1 -1
  46. package/resources/plans/plans.js.map +1 -1
  47. package/resources/plans/plans.mjs.map +1 -1
  48. package/resources/prices/prices.d.ts +262 -166
  49. package/resources/prices/prices.d.ts.map +1 -1
  50. package/resources/prices/prices.js.map +1 -1
  51. package/resources/prices/prices.mjs.map +1 -1
  52. package/resources/shared.d.ts +216 -615
  53. package/resources/shared.d.ts.map +1 -1
  54. package/resources/shared.js.map +1 -1
  55. package/resources/shared.mjs.map +1 -1
  56. package/resources/subscriptions.d.ts +460 -192
  57. package/resources/subscriptions.d.ts.map +1 -1
  58. package/resources/subscriptions.js +1 -1
  59. package/resources/subscriptions.js.map +1 -1
  60. package/resources/subscriptions.mjs +1 -1
  61. package/resources/subscriptions.mjs.map +1 -1
  62. package/src/index.ts +5 -17
  63. package/src/resources/alerts.ts +1 -1
  64. package/src/resources/beta/beta.ts +198 -6
  65. package/src/resources/beta/external-plan-id.ts +198 -6
  66. package/src/resources/customers/balance-transactions.ts +4 -2
  67. package/src/resources/customers/credits/ledger.ts +24 -8
  68. package/src/resources/customers/customers.ts +31 -0
  69. package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +1 -1
  70. package/src/resources/events/backfills.ts +2 -2
  71. package/src/resources/index.ts +1 -3
  72. package/src/resources/invoice-line-items.ts +1 -1
  73. package/src/resources/invoices.ts +41 -11
  74. package/src/resources/plans/plans.ts +99 -3
  75. package/src/resources/prices/prices.ts +283 -179
  76. package/src/resources/shared.ts +260 -747
  77. package/src/resources/subscriptions.ts +540 -238
  78. package/src/version.ts +1 -1
  79. package/version.d.ts +1 -1
  80. package/version.js +1 -1
  81. package/version.mjs +1 -1
@@ -190,7 +190,7 @@ export declare namespace PriceEvaluatePreviewEventsResponse {
190
190
  price_id?: string | null;
191
191
  }
192
192
  }
193
- 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 | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice;
193
+ export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredPrice | 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 | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice | PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice | PriceCreateParams.NewFloatingMinimumCompositePrice;
194
194
  export declare namespace PriceCreateParams {
195
195
  interface NewFloatingUnitPrice {
196
196
  /**
@@ -557,7 +557,8 @@ export declare namespace PriceCreateParams {
557
557
  [key: string]: string | null;
558
558
  } | null;
559
559
  }
560
- interface NewFloatingTieredBPSPrice {
560
+ interface NewFloatingBulkPrice {
561
+ bulk_config: Shared.BulkConfig;
561
562
  /**
562
563
  * The cadence to bill for this price on.
563
564
  */
@@ -570,12 +571,11 @@ export declare namespace PriceCreateParams {
570
571
  * The id of the item the price will be associated with.
571
572
  */
572
573
  item_id: string;
573
- model_type: 'tiered_bps';
574
+ model_type: 'bulk';
574
575
  /**
575
576
  * The name of the price.
576
577
  */
577
578
  name: string;
578
- tiered_bps_config: Shared.TieredBPSConfig;
579
579
  /**
580
580
  * The id of the billable metric for the price. Only needed if the price is
581
581
  * usage-based.
@@ -630,8 +630,7 @@ export declare namespace PriceCreateParams {
630
630
  [key: string]: string | null;
631
631
  } | null;
632
632
  }
633
- interface NewFloatingBPSPrice {
634
- bps_config: Shared.BPSConfig;
633
+ interface NewFloatingThresholdTotalAmountPrice {
635
634
  /**
636
635
  * The cadence to bill for this price on.
637
636
  */
@@ -644,11 +643,14 @@ export declare namespace PriceCreateParams {
644
643
  * The id of the item the price will be associated with.
645
644
  */
646
645
  item_id: string;
647
- model_type: 'bps';
646
+ model_type: 'threshold_total_amount';
648
647
  /**
649
648
  * The name of the price.
650
649
  */
651
650
  name: string;
651
+ threshold_total_amount_config: {
652
+ [key: string]: unknown;
653
+ };
652
654
  /**
653
655
  * The id of the billable metric for the price. Only needed if the price is
654
656
  * usage-based.
@@ -703,8 +705,7 @@ export declare namespace PriceCreateParams {
703
705
  [key: string]: string | null;
704
706
  } | null;
705
707
  }
706
- interface NewFloatingBulkBPSPrice {
707
- bulk_bps_config: Shared.BulkBPSConfig;
708
+ interface NewFloatingTieredPackagePrice {
708
709
  /**
709
710
  * The cadence to bill for this price on.
710
711
  */
@@ -717,11 +718,14 @@ export declare namespace PriceCreateParams {
717
718
  * The id of the item the price will be associated with.
718
719
  */
719
720
  item_id: string;
720
- model_type: 'bulk_bps';
721
+ model_type: 'tiered_package';
721
722
  /**
722
723
  * The name of the price.
723
724
  */
724
725
  name: string;
726
+ tiered_package_config: {
727
+ [key: string]: unknown;
728
+ };
725
729
  /**
726
730
  * The id of the billable metric for the price. Only needed if the price is
727
731
  * usage-based.
@@ -776,8 +780,7 @@ export declare namespace PriceCreateParams {
776
780
  [key: string]: string | null;
777
781
  } | null;
778
782
  }
779
- interface NewFloatingBulkPrice {
780
- bulk_config: Shared.BulkConfig;
783
+ interface NewFloatingGroupedTieredPrice {
781
784
  /**
782
785
  * The cadence to bill for this price on.
783
786
  */
@@ -786,11 +789,14 @@ export declare namespace PriceCreateParams {
786
789
  * An ISO 4217 currency string for which this price is billed in.
787
790
  */
788
791
  currency: string;
792
+ grouped_tiered_config: {
793
+ [key: string]: unknown;
794
+ };
789
795
  /**
790
796
  * The id of the item the price will be associated with.
791
797
  */
792
798
  item_id: string;
793
- model_type: 'bulk';
799
+ model_type: 'grouped_tiered';
794
800
  /**
795
801
  * The name of the price.
796
802
  */
@@ -849,7 +855,7 @@ export declare namespace PriceCreateParams {
849
855
  [key: string]: string | null;
850
856
  } | null;
851
857
  }
852
- interface NewFloatingThresholdTotalAmountPrice {
858
+ interface NewFloatingMaxGroupTieredPackagePrice {
853
859
  /**
854
860
  * The cadence to bill for this price on.
855
861
  */
@@ -862,14 +868,14 @@ export declare namespace PriceCreateParams {
862
868
  * The id of the item the price will be associated with.
863
869
  */
864
870
  item_id: string;
865
- model_type: 'threshold_total_amount';
871
+ max_group_tiered_package_config: {
872
+ [key: string]: unknown;
873
+ };
874
+ model_type: 'max_group_tiered_package';
866
875
  /**
867
876
  * The name of the price.
868
877
  */
869
878
  name: string;
870
- threshold_total_amount_config: {
871
- [key: string]: unknown;
872
- };
873
879
  /**
874
880
  * The id of the billable metric for the price. Only needed if the price is
875
881
  * usage-based.
@@ -924,7 +930,7 @@ export declare namespace PriceCreateParams {
924
930
  [key: string]: string | null;
925
931
  } | null;
926
932
  }
927
- interface NewFloatingTieredPackagePrice {
933
+ interface NewFloatingTieredWithMinimumPrice {
928
934
  /**
929
935
  * The cadence to bill for this price on.
930
936
  */
@@ -937,12 +943,12 @@ export declare namespace PriceCreateParams {
937
943
  * The id of the item the price will be associated with.
938
944
  */
939
945
  item_id: string;
940
- model_type: 'tiered_package';
946
+ model_type: 'tiered_with_minimum';
941
947
  /**
942
948
  * The name of the price.
943
949
  */
944
950
  name: string;
945
- tiered_package_config: {
951
+ tiered_with_minimum_config: {
946
952
  [key: string]: unknown;
947
953
  };
948
954
  /**
@@ -999,7 +1005,7 @@ export declare namespace PriceCreateParams {
999
1005
  [key: string]: string | null;
1000
1006
  } | null;
1001
1007
  }
1002
- interface NewFloatingGroupedTieredPrice {
1008
+ interface NewFloatingPackageWithAllocationPrice {
1003
1009
  /**
1004
1010
  * The cadence to bill for this price on.
1005
1011
  */
@@ -1008,93 +1014,18 @@ export declare namespace PriceCreateParams {
1008
1014
  * An ISO 4217 currency string for which this price is billed in.
1009
1015
  */
1010
1016
  currency: string;
1011
- grouped_tiered_config: {
1012
- [key: string]: unknown;
1013
- };
1014
1017
  /**
1015
1018
  * The id of the item the price will be associated with.
1016
1019
  */
1017
1020
  item_id: string;
1018
- model_type: 'grouped_tiered';
1021
+ model_type: 'package_with_allocation';
1019
1022
  /**
1020
1023
  * The name of the price.
1021
1024
  */
1022
1025
  name: string;
1023
- /**
1024
- * The id of the billable metric for the price. Only needed if the price is
1025
- * usage-based.
1026
- */
1027
- billable_metric_id?: string | null;
1028
- /**
1029
- * If the Price represents a fixed cost, the price will be billed in-advance if
1030
- * this is true, and in-arrears if this is false.
1031
- */
1032
- billed_in_advance?: boolean | null;
1033
- /**
1034
- * For custom cadence: specifies the duration of the billing period in days or
1035
- * months.
1036
- */
1037
- billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1038
- /**
1039
- * The per unit conversion rate of the price currency to the invoicing currency.
1040
- */
1041
- conversion_rate?: number | null;
1042
- /**
1043
- * The configuration for the rate of the price currency to the invoicing currency.
1044
- */
1045
- conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
1046
- /**
1047
- * For dimensional price: specifies a price group and dimension values
1048
- */
1049
- dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
1050
- /**
1051
- * An alias for the price.
1052
- */
1053
- external_price_id?: string | null;
1054
- /**
1055
- * If the Price represents a fixed cost, this represents the quantity of units
1056
- * applied.
1057
- */
1058
- fixed_price_quantity?: number | null;
1059
- /**
1060
- * The property used to group this price on an invoice
1061
- */
1062
- invoice_grouping_key?: string | null;
1063
- /**
1064
- * Within each billing cycle, specifies the cadence at which invoices are produced.
1065
- * If unspecified, a single invoice is produced per billing cycle.
1066
- */
1067
- invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1068
- /**
1069
- * User-specified key/value pairs for the resource. Individual keys can be removed
1070
- * by setting the value to `null`, and the entire metadata mapping can be cleared
1071
- * by setting `metadata` to `null`.
1072
- */
1073
- metadata?: {
1074
- [key: string]: string | null;
1075
- } | null;
1076
- }
1077
- interface NewFloatingMaxGroupTieredPackagePrice {
1078
- /**
1079
- * The cadence to bill for this price on.
1080
- */
1081
- cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1082
- /**
1083
- * An ISO 4217 currency string for which this price is billed in.
1084
- */
1085
- currency: string;
1086
- /**
1087
- * The id of the item the price will be associated with.
1088
- */
1089
- item_id: string;
1090
- max_group_tiered_package_config: {
1026
+ package_with_allocation_config: {
1091
1027
  [key: string]: unknown;
1092
1028
  };
1093
- model_type: 'max_group_tiered_package';
1094
- /**
1095
- * The name of the price.
1096
- */
1097
- name: string;
1098
1029
  /**
1099
1030
  * The id of the billable metric for the price. Only needed if the price is
1100
1031
  * usage-based.
@@ -1149,7 +1080,7 @@ export declare namespace PriceCreateParams {
1149
1080
  [key: string]: string | null;
1150
1081
  } | null;
1151
1082
  }
1152
- interface NewFloatingTieredWithMinimumPrice {
1083
+ interface NewFloatingTieredPackageWithMinimumPrice {
1153
1084
  /**
1154
1085
  * The cadence to bill for this price on.
1155
1086
  */
@@ -1162,12 +1093,12 @@ export declare namespace PriceCreateParams {
1162
1093
  * The id of the item the price will be associated with.
1163
1094
  */
1164
1095
  item_id: string;
1165
- model_type: 'tiered_with_minimum';
1096
+ model_type: 'tiered_package_with_minimum';
1166
1097
  /**
1167
1098
  * The name of the price.
1168
1099
  */
1169
1100
  name: string;
1170
- tiered_with_minimum_config: {
1101
+ tiered_package_with_minimum_config: {
1171
1102
  [key: string]: unknown;
1172
1103
  };
1173
1104
  /**
@@ -1224,7 +1155,7 @@ export declare namespace PriceCreateParams {
1224
1155
  [key: string]: string | null;
1225
1156
  } | null;
1226
1157
  }
1227
- interface NewFloatingPackageWithAllocationPrice {
1158
+ interface NewFloatingUnitWithPercentPrice {
1228
1159
  /**
1229
1160
  * The cadence to bill for this price on.
1230
1161
  */
@@ -1237,12 +1168,12 @@ export declare namespace PriceCreateParams {
1237
1168
  * The id of the item the price will be associated with.
1238
1169
  */
1239
1170
  item_id: string;
1240
- model_type: 'package_with_allocation';
1171
+ model_type: 'unit_with_percent';
1241
1172
  /**
1242
1173
  * The name of the price.
1243
1174
  */
1244
1175
  name: string;
1245
- package_with_allocation_config: {
1176
+ unit_with_percent_config: {
1246
1177
  [key: string]: unknown;
1247
1178
  };
1248
1179
  /**
@@ -1299,7 +1230,7 @@ export declare namespace PriceCreateParams {
1299
1230
  [key: string]: string | null;
1300
1231
  } | null;
1301
1232
  }
1302
- interface NewFloatingTieredPackageWithMinimumPrice {
1233
+ interface NewFloatingTieredWithProrationPrice {
1303
1234
  /**
1304
1235
  * The cadence to bill for this price on.
1305
1236
  */
@@ -1312,12 +1243,12 @@ export declare namespace PriceCreateParams {
1312
1243
  * The id of the item the price will be associated with.
1313
1244
  */
1314
1245
  item_id: string;
1315
- model_type: 'tiered_package_with_minimum';
1246
+ model_type: 'tiered_with_proration';
1316
1247
  /**
1317
1248
  * The name of the price.
1318
1249
  */
1319
1250
  name: string;
1320
- tiered_package_with_minimum_config: {
1251
+ tiered_with_proration_config: {
1321
1252
  [key: string]: unknown;
1322
1253
  };
1323
1254
  /**
@@ -1374,7 +1305,7 @@ export declare namespace PriceCreateParams {
1374
1305
  [key: string]: string | null;
1375
1306
  } | null;
1376
1307
  }
1377
- interface NewFloatingUnitWithPercentPrice {
1308
+ interface NewFloatingUnitWithProrationPrice {
1378
1309
  /**
1379
1310
  * The cadence to bill for this price on.
1380
1311
  */
@@ -1387,12 +1318,12 @@ export declare namespace PriceCreateParams {
1387
1318
  * The id of the item the price will be associated with.
1388
1319
  */
1389
1320
  item_id: string;
1390
- model_type: 'unit_with_percent';
1321
+ model_type: 'unit_with_proration';
1391
1322
  /**
1392
1323
  * The name of the price.
1393
1324
  */
1394
1325
  name: string;
1395
- unit_with_percent_config: {
1326
+ unit_with_proration_config: {
1396
1327
  [key: string]: unknown;
1397
1328
  };
1398
1329
  /**
@@ -1449,7 +1380,7 @@ export declare namespace PriceCreateParams {
1449
1380
  [key: string]: string | null;
1450
1381
  } | null;
1451
1382
  }
1452
- interface NewFloatingTieredWithProrationPrice {
1383
+ interface NewFloatingGroupedAllocationPrice {
1453
1384
  /**
1454
1385
  * The cadence to bill for this price on.
1455
1386
  */
@@ -1458,18 +1389,18 @@ export declare namespace PriceCreateParams {
1458
1389
  * An ISO 4217 currency string for which this price is billed in.
1459
1390
  */
1460
1391
  currency: string;
1392
+ grouped_allocation_config: {
1393
+ [key: string]: unknown;
1394
+ };
1461
1395
  /**
1462
1396
  * The id of the item the price will be associated with.
1463
1397
  */
1464
1398
  item_id: string;
1465
- model_type: 'tiered_with_proration';
1399
+ model_type: 'grouped_allocation';
1466
1400
  /**
1467
1401
  * The name of the price.
1468
1402
  */
1469
1403
  name: string;
1470
- tiered_with_proration_config: {
1471
- [key: string]: unknown;
1472
- };
1473
1404
  /**
1474
1405
  * The id of the billable metric for the price. Only needed if the price is
1475
1406
  * usage-based.
@@ -1524,7 +1455,7 @@ export declare namespace PriceCreateParams {
1524
1455
  [key: string]: string | null;
1525
1456
  } | null;
1526
1457
  }
1527
- interface NewFloatingUnitWithProrationPrice {
1458
+ interface NewFloatingGroupedWithProratedMinimumPrice {
1528
1459
  /**
1529
1460
  * The cadence to bill for this price on.
1530
1461
  */
@@ -1533,18 +1464,18 @@ export declare namespace PriceCreateParams {
1533
1464
  * An ISO 4217 currency string for which this price is billed in.
1534
1465
  */
1535
1466
  currency: string;
1467
+ grouped_with_prorated_minimum_config: {
1468
+ [key: string]: unknown;
1469
+ };
1536
1470
  /**
1537
1471
  * The id of the item the price will be associated with.
1538
1472
  */
1539
1473
  item_id: string;
1540
- model_type: 'unit_with_proration';
1474
+ model_type: 'grouped_with_prorated_minimum';
1541
1475
  /**
1542
1476
  * The name of the price.
1543
1477
  */
1544
1478
  name: string;
1545
- unit_with_proration_config: {
1546
- [key: string]: unknown;
1547
- };
1548
1479
  /**
1549
1480
  * The id of the billable metric for the price. Only needed if the price is
1550
1481
  * usage-based.
@@ -1599,7 +1530,7 @@ export declare namespace PriceCreateParams {
1599
1530
  [key: string]: string | null;
1600
1531
  } | null;
1601
1532
  }
1602
- interface NewFloatingGroupedAllocationPrice {
1533
+ interface NewFloatingGroupedWithMeteredMinimumPrice {
1603
1534
  /**
1604
1535
  * The cadence to bill for this price on.
1605
1536
  */
@@ -1608,14 +1539,14 @@ export declare namespace PriceCreateParams {
1608
1539
  * An ISO 4217 currency string for which this price is billed in.
1609
1540
  */
1610
1541
  currency: string;
1611
- grouped_allocation_config: {
1542
+ grouped_with_metered_minimum_config: {
1612
1543
  [key: string]: unknown;
1613
1544
  };
1614
1545
  /**
1615
1546
  * The id of the item the price will be associated with.
1616
1547
  */
1617
1548
  item_id: string;
1618
- model_type: 'grouped_allocation';
1549
+ model_type: 'grouped_with_metered_minimum';
1619
1550
  /**
1620
1551
  * The name of the price.
1621
1552
  */
@@ -1674,7 +1605,7 @@ export declare namespace PriceCreateParams {
1674
1605
  [key: string]: string | null;
1675
1606
  } | null;
1676
1607
  }
1677
- interface NewFloatingGroupedWithProratedMinimumPrice {
1608
+ interface NewFloatingMatrixWithDisplayNamePrice {
1678
1609
  /**
1679
1610
  * The cadence to bill for this price on.
1680
1611
  */
@@ -1683,14 +1614,14 @@ export declare namespace PriceCreateParams {
1683
1614
  * An ISO 4217 currency string for which this price is billed in.
1684
1615
  */
1685
1616
  currency: string;
1686
- grouped_with_prorated_minimum_config: {
1687
- [key: string]: unknown;
1688
- };
1689
1617
  /**
1690
1618
  * The id of the item the price will be associated with.
1691
1619
  */
1692
1620
  item_id: string;
1693
- model_type: 'grouped_with_prorated_minimum';
1621
+ matrix_with_display_name_config: {
1622
+ [key: string]: unknown;
1623
+ };
1624
+ model_type: 'matrix_with_display_name';
1694
1625
  /**
1695
1626
  * The name of the price.
1696
1627
  */
@@ -1749,7 +1680,10 @@ export declare namespace PriceCreateParams {
1749
1680
  [key: string]: string | null;
1750
1681
  } | null;
1751
1682
  }
1752
- interface NewFloatingGroupedWithMeteredMinimumPrice {
1683
+ interface NewFloatingBulkWithProrationPrice {
1684
+ bulk_with_proration_config: {
1685
+ [key: string]: unknown;
1686
+ };
1753
1687
  /**
1754
1688
  * The cadence to bill for this price on.
1755
1689
  */
@@ -1758,14 +1692,11 @@ export declare namespace PriceCreateParams {
1758
1692
  * An ISO 4217 currency string for which this price is billed in.
1759
1693
  */
1760
1694
  currency: string;
1761
- grouped_with_metered_minimum_config: {
1762
- [key: string]: unknown;
1763
- };
1764
1695
  /**
1765
1696
  * The id of the item the price will be associated with.
1766
1697
  */
1767
1698
  item_id: string;
1768
- model_type: 'grouped_with_metered_minimum';
1699
+ model_type: 'bulk_with_proration';
1769
1700
  /**
1770
1701
  * The name of the price.
1771
1702
  */
@@ -1824,7 +1755,7 @@ export declare namespace PriceCreateParams {
1824
1755
  [key: string]: string | null;
1825
1756
  } | null;
1826
1757
  }
1827
- interface NewFloatingMatrixWithDisplayNamePrice {
1758
+ interface NewFloatingGroupedTieredPackagePrice {
1828
1759
  /**
1829
1760
  * The cadence to bill for this price on.
1830
1761
  */
@@ -1833,14 +1764,14 @@ export declare namespace PriceCreateParams {
1833
1764
  * An ISO 4217 currency string for which this price is billed in.
1834
1765
  */
1835
1766
  currency: string;
1767
+ grouped_tiered_package_config: {
1768
+ [key: string]: unknown;
1769
+ };
1836
1770
  /**
1837
1771
  * The id of the item the price will be associated with.
1838
1772
  */
1839
1773
  item_id: string;
1840
- matrix_with_display_name_config: {
1841
- [key: string]: unknown;
1842
- };
1843
- model_type: 'matrix_with_display_name';
1774
+ model_type: 'grouped_tiered_package';
1844
1775
  /**
1845
1776
  * The name of the price.
1846
1777
  */
@@ -1899,10 +1830,7 @@ export declare namespace PriceCreateParams {
1899
1830
  [key: string]: string | null;
1900
1831
  } | null;
1901
1832
  }
1902
- interface NewFloatingBulkWithProrationPrice {
1903
- bulk_with_proration_config: {
1904
- [key: string]: unknown;
1905
- };
1833
+ interface NewFloatingScalableMatrixWithUnitPricingPrice {
1906
1834
  /**
1907
1835
  * The cadence to bill for this price on.
1908
1836
  */
@@ -1915,11 +1843,14 @@ export declare namespace PriceCreateParams {
1915
1843
  * The id of the item the price will be associated with.
1916
1844
  */
1917
1845
  item_id: string;
1918
- model_type: 'bulk_with_proration';
1846
+ model_type: 'scalable_matrix_with_unit_pricing';
1919
1847
  /**
1920
1848
  * The name of the price.
1921
1849
  */
1922
1850
  name: string;
1851
+ scalable_matrix_with_unit_pricing_config: {
1852
+ [key: string]: unknown;
1853
+ };
1923
1854
  /**
1924
1855
  * The id of the billable metric for the price. Only needed if the price is
1925
1856
  * usage-based.
@@ -1974,7 +1905,7 @@ export declare namespace PriceCreateParams {
1974
1905
  [key: string]: string | null;
1975
1906
  } | null;
1976
1907
  }
1977
- interface NewFloatingGroupedTieredPackagePrice {
1908
+ interface NewFloatingScalableMatrixWithTieredPricingPrice {
1978
1909
  /**
1979
1910
  * The cadence to bill for this price on.
1980
1911
  */
@@ -1983,18 +1914,18 @@ export declare namespace PriceCreateParams {
1983
1914
  * An ISO 4217 currency string for which this price is billed in.
1984
1915
  */
1985
1916
  currency: string;
1986
- grouped_tiered_package_config: {
1987
- [key: string]: unknown;
1988
- };
1989
1917
  /**
1990
1918
  * The id of the item the price will be associated with.
1991
1919
  */
1992
1920
  item_id: string;
1993
- model_type: 'grouped_tiered_package';
1921
+ model_type: 'scalable_matrix_with_tiered_pricing';
1994
1922
  /**
1995
1923
  * The name of the price.
1996
1924
  */
1997
1925
  name: string;
1926
+ scalable_matrix_with_tiered_pricing_config: {
1927
+ [key: string]: unknown;
1928
+ };
1998
1929
  /**
1999
1930
  * The id of the billable metric for the price. Only needed if the price is
2000
1931
  * usage-based.
@@ -2049,11 +1980,14 @@ export declare namespace PriceCreateParams {
2049
1980
  [key: string]: string | null;
2050
1981
  } | null;
2051
1982
  }
2052
- interface NewFloatingScalableMatrixWithUnitPricingPrice {
1983
+ interface NewFloatingCumulativeGroupedBulkPrice {
2053
1984
  /**
2054
1985
  * The cadence to bill for this price on.
2055
1986
  */
2056
1987
  cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1988
+ cumulative_grouped_bulk_config: {
1989
+ [key: string]: unknown;
1990
+ };
2057
1991
  /**
2058
1992
  * An ISO 4217 currency string for which this price is billed in.
2059
1993
  */
@@ -2062,14 +1996,11 @@ export declare namespace PriceCreateParams {
2062
1996
  * The id of the item the price will be associated with.
2063
1997
  */
2064
1998
  item_id: string;
2065
- model_type: 'scalable_matrix_with_unit_pricing';
1999
+ model_type: 'cumulative_grouped_bulk';
2066
2000
  /**
2067
2001
  * The name of the price.
2068
2002
  */
2069
2003
  name: string;
2070
- scalable_matrix_with_unit_pricing_config: {
2071
- [key: string]: unknown;
2072
- };
2073
2004
  /**
2074
2005
  * The id of the billable metric for the price. Only needed if the price is
2075
2006
  * usage-based.
@@ -2124,7 +2055,7 @@ export declare namespace PriceCreateParams {
2124
2055
  [key: string]: string | null;
2125
2056
  } | null;
2126
2057
  }
2127
- interface NewFloatingScalableMatrixWithTieredPricingPrice {
2058
+ interface NewFloatingGroupedWithMinMaxThresholdsPrice {
2128
2059
  /**
2129
2060
  * The cadence to bill for this price on.
2130
2061
  */
@@ -2133,18 +2064,18 @@ export declare namespace PriceCreateParams {
2133
2064
  * An ISO 4217 currency string for which this price is billed in.
2134
2065
  */
2135
2066
  currency: string;
2067
+ grouped_with_min_max_thresholds_config: {
2068
+ [key: string]: unknown;
2069
+ };
2136
2070
  /**
2137
2071
  * The id of the item the price will be associated with.
2138
2072
  */
2139
2073
  item_id: string;
2140
- model_type: 'scalable_matrix_with_tiered_pricing';
2074
+ model_type: 'grouped_with_min_max_thresholds';
2141
2075
  /**
2142
2076
  * The name of the price.
2143
2077
  */
2144
2078
  name: string;
2145
- scalable_matrix_with_tiered_pricing_config: {
2146
- [key: string]: unknown;
2147
- };
2148
2079
  /**
2149
2080
  * The id of the billable metric for the price. Only needed if the price is
2150
2081
  * usage-based.
@@ -2199,14 +2130,11 @@ export declare namespace PriceCreateParams {
2199
2130
  [key: string]: string | null;
2200
2131
  } | null;
2201
2132
  }
2202
- interface NewFloatingCumulativeGroupedBulkPrice {
2133
+ interface NewFloatingMinimumCompositePrice {
2203
2134
  /**
2204
2135
  * The cadence to bill for this price on.
2205
2136
  */
2206
2137
  cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2207
- cumulative_grouped_bulk_config: {
2208
- [key: string]: unknown;
2209
- };
2210
2138
  /**
2211
2139
  * An ISO 4217 currency string for which this price is billed in.
2212
2140
  */
@@ -2215,7 +2143,8 @@ export declare namespace PriceCreateParams {
2215
2143
  * The id of the item the price will be associated with.
2216
2144
  */
2217
2145
  item_id: string;
2218
- model_type: 'cumulative_grouped_bulk';
2146
+ minimum_config: NewFloatingMinimumCompositePrice.MinimumConfig;
2147
+ model_type: 'minimum';
2219
2148
  /**
2220
2149
  * The name of the price.
2221
2150
  */
@@ -2274,6 +2203,19 @@ export declare namespace PriceCreateParams {
2274
2203
  [key: string]: string | null;
2275
2204
  } | null;
2276
2205
  }
2206
+ namespace NewFloatingMinimumCompositePrice {
2207
+ interface MinimumConfig {
2208
+ /**
2209
+ * The minimum amount to apply
2210
+ */
2211
+ minimum_amount: string;
2212
+ /**
2213
+ * By default, subtotals from minimum composite prices are prorated based on the
2214
+ * service period. Set to false to disable proration.
2215
+ */
2216
+ prorated?: boolean | null;
2217
+ }
2218
+ }
2277
2219
  }
2278
2220
  export interface PriceUpdateParams {
2279
2221
  /**
@@ -2361,12 +2303,89 @@ export declare namespace PriceEvaluateMultipleParams {
2361
2303
  * An inline price definition to evaluate, allowing you to test price
2362
2304
  * configurations before adding them to Orb.
2363
2305
  */
2364
- price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingTieredBPSPrice | Shared.NewFloatingBPSPrice | Shared.NewFloatingBulkBPSPrice | Shared.NewFloatingBulkPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | null;
2306
+ price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMinimumCompositePrice | null;
2365
2307
  /**
2366
2308
  * The ID of a price to evaluate that exists in your Orb account.
2367
2309
  */
2368
2310
  price_id?: string | null;
2369
2311
  }
2312
+ namespace PriceEvaluation {
2313
+ interface NewFloatingGroupedWithMinMaxThresholdsPrice {
2314
+ /**
2315
+ * The cadence to bill for this price on.
2316
+ */
2317
+ cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2318
+ /**
2319
+ * An ISO 4217 currency string for which this price is billed in.
2320
+ */
2321
+ currency: string;
2322
+ grouped_with_min_max_thresholds_config: {
2323
+ [key: string]: unknown;
2324
+ };
2325
+ /**
2326
+ * The id of the item the price will be associated with.
2327
+ */
2328
+ item_id: string;
2329
+ model_type: 'grouped_with_min_max_thresholds';
2330
+ /**
2331
+ * The name of the price.
2332
+ */
2333
+ name: string;
2334
+ /**
2335
+ * The id of the billable metric for the price. Only needed if the price is
2336
+ * usage-based.
2337
+ */
2338
+ billable_metric_id?: string | null;
2339
+ /**
2340
+ * If the Price represents a fixed cost, the price will be billed in-advance if
2341
+ * this is true, and in-arrears if this is false.
2342
+ */
2343
+ billed_in_advance?: boolean | null;
2344
+ /**
2345
+ * For custom cadence: specifies the duration of the billing period in days or
2346
+ * months.
2347
+ */
2348
+ billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2349
+ /**
2350
+ * The per unit conversion rate of the price currency to the invoicing currency.
2351
+ */
2352
+ conversion_rate?: number | null;
2353
+ /**
2354
+ * The configuration for the rate of the price currency to the invoicing currency.
2355
+ */
2356
+ conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
2357
+ /**
2358
+ * For dimensional price: specifies a price group and dimension values
2359
+ */
2360
+ dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
2361
+ /**
2362
+ * An alias for the price.
2363
+ */
2364
+ external_price_id?: string | null;
2365
+ /**
2366
+ * If the Price represents a fixed cost, this represents the quantity of units
2367
+ * applied.
2368
+ */
2369
+ fixed_price_quantity?: number | null;
2370
+ /**
2371
+ * The property used to group this price on an invoice
2372
+ */
2373
+ invoice_grouping_key?: string | null;
2374
+ /**
2375
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
2376
+ * If unspecified, a single invoice is produced per billing cycle.
2377
+ */
2378
+ invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2379
+ /**
2380
+ * User-specified key/value pairs for the resource. Individual keys can be removed
2381
+ * by setting the value to `null`, and the entire metadata mapping can be cleared
2382
+ * by setting `metadata` to `null`.
2383
+ */
2384
+ metadata?: {
2385
+ [key: string]: string | null;
2386
+ } | null;
2387
+ }
2388
+ }
2370
2389
  }
2371
2390
  export interface PriceEvaluatePreviewEventsParams {
2372
2391
  /**
@@ -2444,12 +2463,89 @@ export declare namespace PriceEvaluatePreviewEventsParams {
2444
2463
  * An inline price definition to evaluate, allowing you to test price
2445
2464
  * configurations before adding them to Orb.
2446
2465
  */
2447
- price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingTieredBPSPrice | Shared.NewFloatingBPSPrice | Shared.NewFloatingBulkBPSPrice | Shared.NewFloatingBulkPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | null;
2466
+ price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMinimumCompositePrice | null;
2448
2467
  /**
2449
2468
  * The ID of a price to evaluate that exists in your Orb account.
2450
2469
  */
2451
2470
  price_id?: string | null;
2452
2471
  }
2472
+ namespace PriceEvaluation {
2473
+ interface NewFloatingGroupedWithMinMaxThresholdsPrice {
2474
+ /**
2475
+ * The cadence to bill for this price on.
2476
+ */
2477
+ cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
2478
+ /**
2479
+ * An ISO 4217 currency string for which this price is billed in.
2480
+ */
2481
+ currency: string;
2482
+ grouped_with_min_max_thresholds_config: {
2483
+ [key: string]: unknown;
2484
+ };
2485
+ /**
2486
+ * The id of the item the price will be associated with.
2487
+ */
2488
+ item_id: string;
2489
+ model_type: 'grouped_with_min_max_thresholds';
2490
+ /**
2491
+ * The name of the price.
2492
+ */
2493
+ name: string;
2494
+ /**
2495
+ * The id of the billable metric for the price. Only needed if the price is
2496
+ * usage-based.
2497
+ */
2498
+ billable_metric_id?: string | null;
2499
+ /**
2500
+ * If the Price represents a fixed cost, the price will be billed in-advance if
2501
+ * this is true, and in-arrears if this is false.
2502
+ */
2503
+ billed_in_advance?: boolean | null;
2504
+ /**
2505
+ * For custom cadence: specifies the duration of the billing period in days or
2506
+ * months.
2507
+ */
2508
+ billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2509
+ /**
2510
+ * The per unit conversion rate of the price currency to the invoicing currency.
2511
+ */
2512
+ conversion_rate?: number | null;
2513
+ /**
2514
+ * The configuration for the rate of the price currency to the invoicing currency.
2515
+ */
2516
+ conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
2517
+ /**
2518
+ * For dimensional price: specifies a price group and dimension values
2519
+ */
2520
+ dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
2521
+ /**
2522
+ * An alias for the price.
2523
+ */
2524
+ external_price_id?: string | null;
2525
+ /**
2526
+ * If the Price represents a fixed cost, this represents the quantity of units
2527
+ * applied.
2528
+ */
2529
+ fixed_price_quantity?: number | null;
2530
+ /**
2531
+ * The property used to group this price on an invoice
2532
+ */
2533
+ invoice_grouping_key?: string | null;
2534
+ /**
2535
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
2536
+ * If unspecified, a single invoice is produced per billing cycle.
2537
+ */
2538
+ invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2539
+ /**
2540
+ * User-specified key/value pairs for the resource. Individual keys can be removed
2541
+ * by setting the value to `null`, and the entire metadata mapping can be cleared
2542
+ * by setting `metadata` to `null`.
2543
+ */
2544
+ metadata?: {
2545
+ [key: string]: string | null;
2546
+ } | null;
2547
+ }
2548
+ }
2453
2549
  }
2454
2550
  export declare namespace Prices {
2455
2551
  export { type EvaluatePriceGroup as EvaluatePriceGroup, type PriceEvaluateResponse as PriceEvaluateResponse, type PriceEvaluateMultipleResponse as PriceEvaluateMultipleResponse, type PriceEvaluatePreviewEventsResponse as PriceEvaluatePreviewEventsResponse, type PriceCreateParams as PriceCreateParams, type PriceUpdateParams as PriceUpdateParams, type PriceListParams as PriceListParams, type PriceEvaluateParams as PriceEvaluateParams, type PriceEvaluateMultipleParams as PriceEvaluateMultipleParams, type PriceEvaluatePreviewEventsParams as PriceEvaluatePreviewEventsParams, };