orb-billing 5.43.0 → 5.45.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 (265) hide show
  1. package/CHANGELOG.md +52 -0
  2. package/core.d.ts +1 -1
  3. package/core.d.ts.map +1 -1
  4. package/core.js +13 -17
  5. package/core.js.map +1 -1
  6. package/core.mjs +13 -17
  7. package/core.mjs.map +1 -1
  8. package/index.d.mts +91 -5
  9. package/index.d.ts +91 -5
  10. package/index.d.ts.map +1 -1
  11. package/index.js +90 -2
  12. package/index.js.map +1 -1
  13. package/index.mjs +91 -3
  14. package/index.mjs.map +1 -1
  15. package/internal/utils/query.d.ts +2 -0
  16. package/internal/utils/query.d.ts.map +1 -0
  17. package/internal/utils/query.js +33 -0
  18. package/internal/utils/query.js.map +1 -0
  19. package/internal/utils/query.mjs +6 -0
  20. package/internal/utils/query.mjs.map +1 -0
  21. package/package.json +1 -1
  22. package/resources/alerts.d.ts +32 -1
  23. package/resources/alerts.d.ts.map +1 -1
  24. package/resources/alerts.js +6 -0
  25. package/resources/alerts.js.map +1 -1
  26. package/resources/alerts.mjs +6 -0
  27. package/resources/alerts.mjs.map +1 -1
  28. package/resources/beta/beta.d.ts +8293 -140
  29. package/resources/beta/beta.d.ts.map +1 -1
  30. package/resources/beta/beta.js +5 -0
  31. package/resources/beta/beta.js.map +1 -1
  32. package/resources/beta/beta.mjs +5 -0
  33. package/resources/beta/beta.mjs.map +1 -1
  34. package/resources/beta/external-plan-id.d.ts +8293 -140
  35. package/resources/beta/external-plan-id.d.ts.map +1 -1
  36. package/resources/beta/external-plan-id.js +5 -0
  37. package/resources/beta/external-plan-id.js.map +1 -1
  38. package/resources/beta/external-plan-id.mjs +5 -0
  39. package/resources/beta/external-plan-id.mjs.map +1 -1
  40. package/resources/coupons/coupons.d.ts +3 -0
  41. package/resources/coupons/coupons.d.ts.map +1 -1
  42. package/resources/coupons/coupons.js +3 -0
  43. package/resources/coupons/coupons.js.map +1 -1
  44. package/resources/coupons/coupons.mjs +3 -0
  45. package/resources/coupons/coupons.mjs.map +1 -1
  46. package/resources/coupons/subscriptions.d.ts +3 -0
  47. package/resources/coupons/subscriptions.d.ts.map +1 -1
  48. package/resources/coupons/subscriptions.js +3 -0
  49. package/resources/coupons/subscriptions.js.map +1 -1
  50. package/resources/coupons/subscriptions.mjs +3 -0
  51. package/resources/coupons/subscriptions.mjs.map +1 -1
  52. package/resources/credit-blocks.d.ts +85 -1
  53. package/resources/credit-blocks.d.ts.map +1 -1
  54. package/resources/credit-blocks.js +22 -0
  55. package/resources/credit-blocks.js.map +1 -1
  56. package/resources/credit-blocks.mjs +22 -0
  57. package/resources/credit-blocks.mjs.map +1 -1
  58. package/resources/credit-notes.d.ts +4 -0
  59. package/resources/credit-notes.d.ts.map +1 -1
  60. package/resources/credit-notes.js +4 -0
  61. package/resources/credit-notes.js.map +1 -1
  62. package/resources/credit-notes.mjs +4 -0
  63. package/resources/credit-notes.mjs.map +1 -1
  64. package/resources/customers/balance-transactions.d.ts +16 -0
  65. package/resources/customers/balance-transactions.d.ts.map +1 -1
  66. package/resources/customers/balance-transactions.js +16 -0
  67. package/resources/customers/balance-transactions.js.map +1 -1
  68. package/resources/customers/balance-transactions.mjs +16 -0
  69. package/resources/customers/balance-transactions.mjs.map +1 -1
  70. package/resources/customers/costs.d.ts +16 -0
  71. package/resources/customers/costs.d.ts.map +1 -1
  72. package/resources/customers/costs.js +16 -0
  73. package/resources/customers/costs.js.map +1 -1
  74. package/resources/customers/costs.mjs +16 -0
  75. package/resources/customers/costs.mjs.map +1 -1
  76. package/resources/customers/credits/credits.d.ts +39 -0
  77. package/resources/customers/credits/credits.d.ts.map +1 -1
  78. package/resources/customers/credits/credits.js +3 -0
  79. package/resources/customers/credits/credits.js.map +1 -1
  80. package/resources/customers/credits/credits.mjs +3 -0
  81. package/resources/customers/credits/credits.mjs.map +1 -1
  82. package/resources/customers/credits/ledger.d.ts +31 -4
  83. package/resources/customers/credits/ledger.d.ts.map +1 -1
  84. package/resources/customers/credits/ledger.js +19 -2
  85. package/resources/customers/credits/ledger.js.map +1 -1
  86. package/resources/customers/credits/ledger.mjs +19 -2
  87. package/resources/customers/credits/ledger.mjs.map +1 -1
  88. package/resources/customers/credits/top-ups.d.ts +3 -0
  89. package/resources/customers/credits/top-ups.d.ts.map +1 -1
  90. package/resources/customers/credits/top-ups.js +3 -0
  91. package/resources/customers/credits/top-ups.js.map +1 -1
  92. package/resources/customers/credits/top-ups.mjs +3 -0
  93. package/resources/customers/credits/top-ups.mjs.map +1 -1
  94. package/resources/customers/customers.d.ts +33 -12
  95. package/resources/customers/customers.d.ts.map +1 -1
  96. package/resources/customers/customers.js +20 -3
  97. package/resources/customers/customers.js.map +1 -1
  98. package/resources/customers/customers.mjs +20 -3
  99. package/resources/customers/customers.mjs.map +1 -1
  100. package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts +1 -1
  101. package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts.map +1 -1
  102. package/resources/events/backfills.d.ts +5 -0
  103. package/resources/events/backfills.d.ts.map +1 -1
  104. package/resources/events/backfills.js +5 -0
  105. package/resources/events/backfills.js.map +1 -1
  106. package/resources/events/backfills.mjs +5 -0
  107. package/resources/events/backfills.mjs.map +1 -1
  108. package/resources/events/events.d.ts +5 -0
  109. package/resources/events/events.d.ts.map +1 -1
  110. package/resources/events/events.js +5 -0
  111. package/resources/events/events.js.map +1 -1
  112. package/resources/events/events.mjs +5 -0
  113. package/resources/events/events.mjs.map +1 -1
  114. package/resources/events/volume.d.ts +5 -0
  115. package/resources/events/volume.d.ts.map +1 -1
  116. package/resources/events/volume.js +5 -0
  117. package/resources/events/volume.js.map +1 -1
  118. package/resources/events/volume.mjs +5 -0
  119. package/resources/events/volume.mjs.map +1 -1
  120. package/resources/index.d.ts +4 -2
  121. package/resources/index.d.ts.map +1 -1
  122. package/resources/index.js +7 -1
  123. package/resources/index.js.map +1 -1
  124. package/resources/index.mjs +3 -1
  125. package/resources/index.mjs.map +1 -1
  126. package/resources/invoice-line-items.d.ts +6 -0
  127. package/resources/invoice-line-items.d.ts.map +1 -1
  128. package/resources/invoice-line-items.js +6 -0
  129. package/resources/invoice-line-items.js.map +1 -1
  130. package/resources/invoice-line-items.mjs +6 -0
  131. package/resources/invoice-line-items.mjs.map +1 -1
  132. package/resources/invoices.d.ts +432 -7
  133. package/resources/invoices.d.ts.map +1 -1
  134. package/resources/invoices.js +18 -5
  135. package/resources/invoices.js.map +1 -1
  136. package/resources/invoices.mjs +18 -5
  137. package/resources/invoices.mjs.map +1 -1
  138. package/resources/items.d.ts +6 -2
  139. package/resources/items.d.ts.map +1 -1
  140. package/resources/items.js +4 -0
  141. package/resources/items.js.map +1 -1
  142. package/resources/items.mjs +4 -0
  143. package/resources/items.mjs.map +1 -1
  144. package/resources/license-types.d.ts +113 -0
  145. package/resources/license-types.d.ts.map +1 -0
  146. package/resources/license-types.js +44 -0
  147. package/resources/license-types.js.map +1 -0
  148. package/resources/license-types.mjs +39 -0
  149. package/resources/license-types.mjs.map +1 -0
  150. package/resources/licenses/external-licenses.d.ts +114 -0
  151. package/resources/licenses/external-licenses.d.ts.map +1 -0
  152. package/resources/licenses/external-licenses.js +18 -0
  153. package/resources/licenses/external-licenses.js.map +1 -0
  154. package/resources/licenses/external-licenses.mjs +14 -0
  155. package/resources/licenses/external-licenses.mjs.map +1 -0
  156. package/resources/licenses/index.d.ts +4 -0
  157. package/resources/licenses/index.d.ts.map +1 -0
  158. package/resources/licenses/index.js +12 -0
  159. package/resources/licenses/index.js.map +1 -0
  160. package/resources/licenses/index.mjs +5 -0
  161. package/resources/licenses/index.mjs.map +1 -0
  162. package/resources/licenses/licenses.d.ts +133 -0
  163. package/resources/licenses/licenses.d.ts.map +1 -0
  164. package/resources/licenses/licenses.js +86 -0
  165. package/resources/licenses/licenses.js.map +1 -0
  166. package/resources/licenses/licenses.mjs +58 -0
  167. package/resources/licenses/licenses.mjs.map +1 -0
  168. package/resources/licenses/usage.d.ts +211 -0
  169. package/resources/licenses/usage.d.ts.map +1 -0
  170. package/resources/licenses/usage.js +25 -0
  171. package/resources/licenses/usage.js.map +1 -0
  172. package/resources/licenses/usage.mjs +21 -0
  173. package/resources/licenses/usage.mjs.map +1 -0
  174. package/resources/licenses.d.ts +2 -0
  175. package/resources/licenses.d.ts.map +1 -0
  176. package/resources/licenses.js +19 -0
  177. package/resources/licenses.js.map +1 -0
  178. package/resources/licenses.mjs +3 -0
  179. package/resources/licenses.mjs.map +1 -0
  180. package/resources/metrics.d.ts +7 -0
  181. package/resources/metrics.d.ts.map +1 -1
  182. package/resources/metrics.js +4 -0
  183. package/resources/metrics.js.map +1 -1
  184. package/resources/metrics.mjs +4 -0
  185. package/resources/metrics.mjs.map +1 -1
  186. package/resources/plans/external-plan-id.d.ts +5 -0
  187. package/resources/plans/external-plan-id.d.ts.map +1 -1
  188. package/resources/plans/external-plan-id.js +5 -0
  189. package/resources/plans/external-plan-id.js.map +1 -1
  190. package/resources/plans/external-plan-id.mjs +5 -0
  191. package/resources/plans/external-plan-id.mjs.map +1 -1
  192. package/resources/plans/migrations.d.ts +5 -0
  193. package/resources/plans/migrations.d.ts.map +1 -1
  194. package/resources/plans/migrations.js +5 -0
  195. package/resources/plans/migrations.js.map +1 -1
  196. package/resources/plans/migrations.mjs +5 -0
  197. package/resources/plans/migrations.mjs.map +1 -1
  198. package/resources/plans/plans.d.ts +4200 -121
  199. package/resources/plans/plans.d.ts.map +1 -1
  200. package/resources/plans/plans.js +5 -0
  201. package/resources/plans/plans.js.map +1 -1
  202. package/resources/plans/plans.mjs +5 -0
  203. package/resources/plans/plans.mjs.map +1 -1
  204. package/resources/prices/external-price-id.d.ts +9 -0
  205. package/resources/prices/external-price-id.d.ts.map +1 -1
  206. package/resources/prices/external-price-id.js +9 -0
  207. package/resources/prices/external-price-id.js.map +1 -1
  208. package/resources/prices/external-price-id.mjs +9 -0
  209. package/resources/prices/external-price-id.mjs.map +1 -1
  210. package/resources/prices/prices.d.ts +198 -0
  211. package/resources/prices/prices.d.ts.map +1 -1
  212. package/resources/prices/prices.js +9 -0
  213. package/resources/prices/prices.js.map +1 -1
  214. package/resources/prices/prices.mjs +9 -0
  215. package/resources/prices/prices.mjs.map +1 -1
  216. package/resources/shared.d.ts +1040 -6
  217. package/resources/shared.d.ts.map +1 -1
  218. package/resources/shared.js.map +1 -1
  219. package/resources/shared.mjs.map +1 -1
  220. package/resources/subscriptions.d.ts +262 -0
  221. package/resources/subscriptions.d.ts.map +1 -1
  222. package/resources/subscriptions.js.map +1 -1
  223. package/resources/subscriptions.mjs.map +1 -1
  224. package/src/core.ts +16 -21
  225. package/src/index.ts +149 -5
  226. package/src/internal/utils/query.ts +7 -0
  227. package/src/resources/alerts.ts +38 -1
  228. package/src/resources/beta/beta.ts +9945 -194
  229. package/src/resources/beta/external-plan-id.ts +9945 -194
  230. package/src/resources/coupons/coupons.ts +3 -0
  231. package/src/resources/coupons/subscriptions.ts +3 -0
  232. package/src/resources/credit-blocks.ts +110 -1
  233. package/src/resources/credit-notes.ts +4 -0
  234. package/src/resources/customers/balance-transactions.ts +16 -0
  235. package/src/resources/customers/costs.ts +16 -0
  236. package/src/resources/customers/credits/credits.ts +45 -0
  237. package/src/resources/customers/credits/ledger.ts +33 -4
  238. package/src/resources/customers/credits/top-ups.ts +3 -0
  239. package/src/resources/customers/customers.ts +61 -12
  240. package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts +1 -1
  241. package/src/resources/events/backfills.ts +5 -0
  242. package/src/resources/events/events.ts +5 -0
  243. package/src/resources/events/volume.ts +5 -0
  244. package/src/resources/index.ts +29 -1
  245. package/src/resources/invoice-line-items.ts +6 -0
  246. package/src/resources/invoices.ts +523 -6
  247. package/src/resources/items.ts +8 -2
  248. package/src/resources/license-types.ts +163 -0
  249. package/src/resources/licenses/external-licenses.ts +147 -0
  250. package/src/resources/licenses/index.ts +27 -0
  251. package/src/resources/licenses/licenses.ts +248 -0
  252. package/src/resources/licenses/usage.ts +280 -0
  253. package/src/resources/licenses.ts +3 -0
  254. package/src/resources/metrics.ts +6 -0
  255. package/src/resources/plans/external-plan-id.ts +5 -0
  256. package/src/resources/plans/migrations.ts +5 -0
  257. package/src/resources/plans/plans.ts +5004 -126
  258. package/src/resources/prices/external-price-id.ts +9 -0
  259. package/src/resources/prices/prices.ts +237 -0
  260. package/src/resources/shared.ts +1213 -0
  261. package/src/resources/subscriptions.ts +311 -0
  262. package/src/version.ts +1 -1
  263. package/version.d.ts +1 -1
  264. package/version.js +1 -1
  265. package/version.mjs +1 -1
@@ -42,6 +42,7 @@ export interface Allocation {
42
42
  currency: string;
43
43
  custom_expiration: CustomExpiration | null;
44
44
  filters?: Array<Allocation.Filter>;
45
+ license_type_id?: string | null;
45
46
  }
46
47
  export declare namespace Allocation {
47
48
  interface Filter {
@@ -2078,6 +2079,10 @@ export interface NewAllocationPrice {
2078
2079
  * will be used (e.g. 'Included Allocation (USD)').
2079
2080
  */
2080
2081
  item_id?: string | null;
2082
+ /**
2083
+ * The license type ID to associate the price with license allocation.
2084
+ */
2085
+ license_type_id?: string | null;
2081
2086
  /**
2082
2087
  * The (per-unit) cost basis of each created block. If non-zero, a customer will be
2083
2088
  * invoiced according to the quantity and per unit cost basis specified for the
@@ -2248,6 +2253,10 @@ export interface NewFloatingBulkPrice {
2248
2253
  * If unspecified, a single invoice is produced per billing cycle.
2249
2254
  */
2250
2255
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2256
+ /**
2257
+ * The ID of the license type to associate with this price.
2258
+ */
2259
+ license_type_id?: string | null;
2251
2260
  /**
2252
2261
  * User-specified key/value pairs for the resource. Individual keys can be removed
2253
2262
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2327,6 +2336,10 @@ export interface NewFloatingBulkWithProrationPrice {
2327
2336
  * If unspecified, a single invoice is produced per billing cycle.
2328
2337
  */
2329
2338
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2339
+ /**
2340
+ * The ID of the license type to associate with this price.
2341
+ */
2342
+ license_type_id?: string | null;
2330
2343
  /**
2331
2344
  * User-specified key/value pairs for the resource. Individual keys can be removed
2332
2345
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2432,6 +2445,10 @@ export interface NewFloatingCumulativeGroupedBulkPrice {
2432
2445
  * If unspecified, a single invoice is produced per billing cycle.
2433
2446
  */
2434
2447
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2448
+ /**
2449
+ * The ID of the license type to associate with this price.
2450
+ */
2451
+ license_type_id?: string | null;
2435
2452
  /**
2436
2453
  * User-specified key/value pairs for the resource. Individual keys can be removed
2437
2454
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2542,6 +2559,10 @@ export interface NewFloatingGroupedAllocationPrice {
2542
2559
  * If unspecified, a single invoice is produced per billing cycle.
2543
2560
  */
2544
2561
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2562
+ /**
2563
+ * The ID of the license type to associate with this price.
2564
+ */
2565
+ license_type_id?: string | null;
2545
2566
  /**
2546
2567
  * User-specified key/value pairs for the resource. Individual keys can be removed
2547
2568
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2640,6 +2661,10 @@ export interface NewFloatingGroupedTieredPackagePrice {
2640
2661
  * If unspecified, a single invoice is produced per billing cycle.
2641
2662
  */
2642
2663
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2664
+ /**
2665
+ * The ID of the license type to associate with this price.
2666
+ */
2667
+ license_type_id?: string | null;
2643
2668
  /**
2644
2669
  * User-specified key/value pairs for the resource. Individual keys can be removed
2645
2670
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2748,6 +2773,10 @@ export interface NewFloatingGroupedTieredPrice {
2748
2773
  * If unspecified, a single invoice is produced per billing cycle.
2749
2774
  */
2750
2775
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2776
+ /**
2777
+ * The ID of the license type to associate with this price.
2778
+ */
2779
+ license_type_id?: string | null;
2751
2780
  /**
2752
2781
  * User-specified key/value pairs for the resource. Individual keys can be removed
2753
2782
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2855,6 +2884,10 @@ export interface NewFloatingGroupedWithMeteredMinimumPrice {
2855
2884
  * If unspecified, a single invoice is produced per billing cycle.
2856
2885
  */
2857
2886
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2887
+ /**
2888
+ * The ID of the license type to associate with this price.
2889
+ */
2890
+ license_type_id?: string | null;
2858
2891
  /**
2859
2892
  * User-specified key/value pairs for the resource. Individual keys can be removed
2860
2893
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2986,6 +3019,10 @@ export interface NewFloatingGroupedWithProratedMinimumPrice {
2986
3019
  * If unspecified, a single invoice is produced per billing cycle.
2987
3020
  */
2988
3021
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3022
+ /**
3023
+ * The ID of the license type to associate with this price.
3024
+ */
3025
+ license_type_id?: string | null;
2989
3026
  /**
2990
3027
  * User-specified key/value pairs for the resource. Individual keys can be removed
2991
3028
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3084,6 +3121,10 @@ export interface NewFloatingMatrixPrice {
3084
3121
  * If unspecified, a single invoice is produced per billing cycle.
3085
3122
  */
3086
3123
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3124
+ /**
3125
+ * The ID of the license type to associate with this price.
3126
+ */
3127
+ license_type_id?: string | null;
3087
3128
  /**
3088
3129
  * User-specified key/value pairs for the resource. Individual keys can be removed
3089
3130
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3163,6 +3204,10 @@ export interface NewFloatingMatrixWithAllocationPrice {
3163
3204
  * If unspecified, a single invoice is produced per billing cycle.
3164
3205
  */
3165
3206
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3207
+ /**
3208
+ * The ID of the license type to associate with this price.
3209
+ */
3210
+ license_type_id?: string | null;
3166
3211
  /**
3167
3212
  * User-specified key/value pairs for the resource. Individual keys can be removed
3168
3213
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3242,6 +3287,10 @@ export interface NewFloatingMatrixWithDisplayNamePrice {
3242
3287
  * If unspecified, a single invoice is produced per billing cycle.
3243
3288
  */
3244
3289
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3290
+ /**
3291
+ * The ID of the license type to associate with this price.
3292
+ */
3293
+ license_type_id?: string | null;
3245
3294
  /**
3246
3295
  * User-specified key/value pairs for the resource. Individual keys can be removed
3247
3296
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3355,6 +3404,10 @@ export interface NewFloatingMaxGroupTieredPackagePrice {
3355
3404
  * If unspecified, a single invoice is produced per billing cycle.
3356
3405
  */
3357
3406
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3407
+ /**
3408
+ * The ID of the license type to associate with this price.
3409
+ */
3410
+ license_type_id?: string | null;
3358
3411
  /**
3359
3412
  * User-specified key/value pairs for the resource. Individual keys can be removed
3360
3413
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3462,6 +3515,10 @@ export interface NewFloatingMinimumCompositePrice {
3462
3515
  * If unspecified, a single invoice is produced per billing cycle.
3463
3516
  */
3464
3517
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3518
+ /**
3519
+ * The ID of the license type to associate with this price.
3520
+ */
3521
+ license_type_id?: string | null;
3465
3522
  /**
3466
3523
  * User-specified key/value pairs for the resource. Individual keys can be removed
3467
3524
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3556,6 +3613,10 @@ export interface NewFloatingPackagePrice {
3556
3613
  * If unspecified, a single invoice is produced per billing cycle.
3557
3614
  */
3558
3615
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3616
+ /**
3617
+ * The ID of the license type to associate with this price.
3618
+ */
3619
+ license_type_id?: string | null;
3559
3620
  /**
3560
3621
  * User-specified key/value pairs for the resource. Individual keys can be removed
3561
3622
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3635,6 +3696,10 @@ export interface NewFloatingPackageWithAllocationPrice {
3635
3696
  * If unspecified, a single invoice is produced per billing cycle.
3636
3697
  */
3637
3698
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3699
+ /**
3700
+ * The ID of the license type to associate with this price.
3701
+ */
3702
+ license_type_id?: string | null;
3638
3703
  /**
3639
3704
  * User-specified key/value pairs for the resource. Individual keys can be removed
3640
3705
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3724,6 +3789,10 @@ export interface NewFloatingScalableMatrixWithTieredPricingPrice {
3724
3789
  * If unspecified, a single invoice is produced per billing cycle.
3725
3790
  */
3726
3791
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3792
+ /**
3793
+ * The ID of the license type to associate with this price.
3794
+ */
3795
+ license_type_id?: string | null;
3727
3796
  /**
3728
3797
  * User-specified key/value pairs for the resource. Individual keys can be removed
3729
3798
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3840,6 +3909,10 @@ export interface NewFloatingScalableMatrixWithUnitPricingPrice {
3840
3909
  * If unspecified, a single invoice is produced per billing cycle.
3841
3910
  */
3842
3911
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3912
+ /**
3913
+ * The ID of the license type to associate with this price.
3914
+ */
3915
+ license_type_id?: string | null;
3843
3916
  /**
3844
3917
  * User-specified key/value pairs for the resource. Individual keys can be removed
3845
3918
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3866,6 +3939,10 @@ export declare namespace NewFloatingScalableMatrixWithUnitPricingPrice {
3866
3939
  * The final unit price to rate against the output of the matrix
3867
3940
  */
3868
3941
  unit_price: string;
3942
+ /**
3943
+ * The property used to group this price
3944
+ */
3945
+ grouping_key?: string | null;
3869
3946
  /**
3870
3947
  * If true, the unit price will be prorated to the billing period
3871
3948
  */
@@ -3956,6 +4033,10 @@ export interface NewFloatingThresholdTotalAmountPrice {
3956
4033
  * If unspecified, a single invoice is produced per billing cycle.
3957
4034
  */
3958
4035
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4036
+ /**
4037
+ * The ID of the license type to associate with this price.
4038
+ */
4039
+ license_type_id?: string | null;
3959
4040
  /**
3960
4041
  * User-specified key/value pairs for the resource. Individual keys can be removed
3961
4042
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4063,6 +4144,10 @@ export interface NewFloatingTieredPackagePrice {
4063
4144
  * If unspecified, a single invoice is produced per billing cycle.
4064
4145
  */
4065
4146
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4147
+ /**
4148
+ * The ID of the license type to associate with this price.
4149
+ */
4150
+ license_type_id?: string | null;
4066
4151
  /**
4067
4152
  * User-specified key/value pairs for the resource. Individual keys can be removed
4068
4153
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4169,6 +4254,10 @@ export interface NewFloatingTieredPackageWithMinimumPrice {
4169
4254
  * If unspecified, a single invoice is produced per billing cycle.
4170
4255
  */
4171
4256
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4257
+ /**
4258
+ * The ID of the license type to associate with this price.
4259
+ */
4260
+ license_type_id?: string | null;
4172
4261
  /**
4173
4262
  * User-specified key/value pairs for the resource. Individual keys can be removed
4174
4263
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4271,6 +4360,10 @@ export interface NewFloatingTieredPrice {
4271
4360
  * If unspecified, a single invoice is produced per billing cycle.
4272
4361
  */
4273
4362
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4363
+ /**
4364
+ * The ID of the license type to associate with this price.
4365
+ */
4366
+ license_type_id?: string | null;
4274
4367
  /**
4275
4368
  * User-specified key/value pairs for the resource. Individual keys can be removed
4276
4369
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4350,6 +4443,10 @@ export interface NewFloatingTieredWithMinimumPrice {
4350
4443
  * If unspecified, a single invoice is produced per billing cycle.
4351
4444
  */
4352
4445
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4446
+ /**
4447
+ * The ID of the license type to associate with this price.
4448
+ */
4449
+ license_type_id?: string | null;
4353
4450
  /**
4354
4451
  * User-specified key/value pairs for the resource. Individual keys can be removed
4355
4452
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4462,6 +4559,10 @@ export interface NewFloatingTieredWithProrationPrice {
4462
4559
  * If unspecified, a single invoice is produced per billing cycle.
4463
4560
  */
4464
4561
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4562
+ /**
4563
+ * The ID of the license type to associate with this price.
4564
+ */
4565
+ license_type_id?: string | null;
4465
4566
  /**
4466
4567
  * User-specified key/value pairs for the resource. Individual keys can be removed
4467
4568
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4568,6 +4669,10 @@ export interface NewFloatingUnitPrice {
4568
4669
  * If unspecified, a single invoice is produced per billing cycle.
4569
4670
  */
4570
4671
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4672
+ /**
4673
+ * The ID of the license type to associate with this price.
4674
+ */
4675
+ license_type_id?: string | null;
4571
4676
  /**
4572
4677
  * User-specified key/value pairs for the resource. Individual keys can be removed
4573
4678
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4647,6 +4752,10 @@ export interface NewFloatingUnitWithPercentPrice {
4647
4752
  * If unspecified, a single invoice is produced per billing cycle.
4648
4753
  */
4649
4754
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4755
+ /**
4756
+ * The ID of the license type to associate with this price.
4757
+ */
4758
+ license_type_id?: string | null;
4650
4759
  /**
4651
4760
  * User-specified key/value pairs for the resource. Individual keys can be removed
4652
4761
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4741,6 +4850,10 @@ export interface NewFloatingUnitWithProrationPrice {
4741
4850
  * If unspecified, a single invoice is produced per billing cycle.
4742
4851
  */
4743
4852
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4853
+ /**
4854
+ * The ID of the license type to associate with this price.
4855
+ */
4856
+ license_type_id?: string | null;
4744
4857
  /**
4745
4858
  * User-specified key/value pairs for the resource. Individual keys can be removed
4746
4859
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4983,6 +5096,10 @@ export interface NewPlanBulkPrice {
4983
5096
  * If unspecified, a single invoice is produced per billing cycle.
4984
5097
  */
4985
5098
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5099
+ /**
5100
+ * The ID of the license type to associate with this price.
5101
+ */
5102
+ license_type_id?: string | null;
4986
5103
  /**
4987
5104
  * User-specified key/value pairs for the resource. Individual keys can be removed
4988
5105
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5068,6 +5185,10 @@ export interface NewPlanBulkWithProrationPrice {
5068
5185
  * If unspecified, a single invoice is produced per billing cycle.
5069
5186
  */
5070
5187
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5188
+ /**
5189
+ * The ID of the license type to associate with this price.
5190
+ */
5191
+ license_type_id?: string | null;
5071
5192
  /**
5072
5193
  * User-specified key/value pairs for the resource. Individual keys can be removed
5073
5194
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5179,6 +5300,10 @@ export interface NewPlanCumulativeGroupedBulkPrice {
5179
5300
  * If unspecified, a single invoice is produced per billing cycle.
5180
5301
  */
5181
5302
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5303
+ /**
5304
+ * The ID of the license type to associate with this price.
5305
+ */
5306
+ license_type_id?: string | null;
5182
5307
  /**
5183
5308
  * User-specified key/value pairs for the resource. Individual keys can be removed
5184
5309
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5295,6 +5420,10 @@ export interface NewPlanGroupedAllocationPrice {
5295
5420
  * If unspecified, a single invoice is produced per billing cycle.
5296
5421
  */
5297
5422
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5423
+ /**
5424
+ * The ID of the license type to associate with this price.
5425
+ */
5426
+ license_type_id?: string | null;
5298
5427
  /**
5299
5428
  * User-specified key/value pairs for the resource. Individual keys can be removed
5300
5429
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5399,6 +5528,10 @@ export interface NewPlanGroupedTieredPackagePrice {
5399
5528
  * If unspecified, a single invoice is produced per billing cycle.
5400
5529
  */
5401
5530
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5531
+ /**
5532
+ * The ID of the license type to associate with this price.
5533
+ */
5534
+ license_type_id?: string | null;
5402
5535
  /**
5403
5536
  * User-specified key/value pairs for the resource. Individual keys can be removed
5404
5537
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5513,6 +5646,10 @@ export interface NewPlanGroupedTieredPrice {
5513
5646
  * If unspecified, a single invoice is produced per billing cycle.
5514
5647
  */
5515
5648
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5649
+ /**
5650
+ * The ID of the license type to associate with this price.
5651
+ */
5652
+ license_type_id?: string | null;
5516
5653
  /**
5517
5654
  * User-specified key/value pairs for the resource. Individual keys can be removed
5518
5655
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5626,6 +5763,10 @@ export interface NewPlanGroupedWithMeteredMinimumPrice {
5626
5763
  * If unspecified, a single invoice is produced per billing cycle.
5627
5764
  */
5628
5765
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5766
+ /**
5767
+ * The ID of the license type to associate with this price.
5768
+ */
5769
+ license_type_id?: string | null;
5629
5770
  /**
5630
5771
  * User-specified key/value pairs for the resource. Individual keys can be removed
5631
5772
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5763,6 +5904,10 @@ export interface NewPlanGroupedWithProratedMinimumPrice {
5763
5904
  * If unspecified, a single invoice is produced per billing cycle.
5764
5905
  */
5765
5906
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5907
+ /**
5908
+ * The ID of the license type to associate with this price.
5909
+ */
5910
+ license_type_id?: string | null;
5766
5911
  /**
5767
5912
  * User-specified key/value pairs for the resource. Individual keys can be removed
5768
5913
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5867,6 +6012,10 @@ export interface NewPlanMatrixPrice {
5867
6012
  * If unspecified, a single invoice is produced per billing cycle.
5868
6013
  */
5869
6014
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6015
+ /**
6016
+ * The ID of the license type to associate with this price.
6017
+ */
6018
+ license_type_id?: string | null;
5870
6019
  /**
5871
6020
  * User-specified key/value pairs for the resource. Individual keys can be removed
5872
6021
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5952,6 +6101,10 @@ export interface NewPlanMatrixWithAllocationPrice {
5952
6101
  * If unspecified, a single invoice is produced per billing cycle.
5953
6102
  */
5954
6103
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6104
+ /**
6105
+ * The ID of the license type to associate with this price.
6106
+ */
6107
+ license_type_id?: string | null;
5955
6108
  /**
5956
6109
  * User-specified key/value pairs for the resource. Individual keys can be removed
5957
6110
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6037,6 +6190,10 @@ export interface NewPlanMatrixWithDisplayNamePrice {
6037
6190
  * If unspecified, a single invoice is produced per billing cycle.
6038
6191
  */
6039
6192
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6193
+ /**
6194
+ * The ID of the license type to associate with this price.
6195
+ */
6196
+ license_type_id?: string | null;
6040
6197
  /**
6041
6198
  * User-specified key/value pairs for the resource. Individual keys can be removed
6042
6199
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6156,6 +6313,10 @@ export interface NewPlanMaxGroupTieredPackagePrice {
6156
6313
  * If unspecified, a single invoice is produced per billing cycle.
6157
6314
  */
6158
6315
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6316
+ /**
6317
+ * The ID of the license type to associate with this price.
6318
+ */
6319
+ license_type_id?: string | null;
6159
6320
  /**
6160
6321
  * User-specified key/value pairs for the resource. Individual keys can be removed
6161
6322
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6269,6 +6430,10 @@ export interface NewPlanMinimumCompositePrice {
6269
6430
  * If unspecified, a single invoice is produced per billing cycle.
6270
6431
  */
6271
6432
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6433
+ /**
6434
+ * The ID of the license type to associate with this price.
6435
+ */
6436
+ license_type_id?: string | null;
6272
6437
  /**
6273
6438
  * User-specified key/value pairs for the resource. Individual keys can be removed
6274
6439
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6369,6 +6534,10 @@ export interface NewPlanPackagePrice {
6369
6534
  * If unspecified, a single invoice is produced per billing cycle.
6370
6535
  */
6371
6536
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6537
+ /**
6538
+ * The ID of the license type to associate with this price.
6539
+ */
6540
+ license_type_id?: string | null;
6372
6541
  /**
6373
6542
  * User-specified key/value pairs for the resource. Individual keys can be removed
6374
6543
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6454,6 +6623,10 @@ export interface NewPlanPackageWithAllocationPrice {
6454
6623
  * If unspecified, a single invoice is produced per billing cycle.
6455
6624
  */
6456
6625
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6626
+ /**
6627
+ * The ID of the license type to associate with this price.
6628
+ */
6629
+ license_type_id?: string | null;
6457
6630
  /**
6458
6631
  * User-specified key/value pairs for the resource. Individual keys can be removed
6459
6632
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6549,6 +6722,10 @@ export interface NewPlanScalableMatrixWithTieredPricingPrice {
6549
6722
  * If unspecified, a single invoice is produced per billing cycle.
6550
6723
  */
6551
6724
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6725
+ /**
6726
+ * The ID of the license type to associate with this price.
6727
+ */
6728
+ license_type_id?: string | null;
6552
6729
  /**
6553
6730
  * User-specified key/value pairs for the resource. Individual keys can be removed
6554
6731
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6671,6 +6848,10 @@ export interface NewPlanScalableMatrixWithUnitPricingPrice {
6671
6848
  * If unspecified, a single invoice is produced per billing cycle.
6672
6849
  */
6673
6850
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6851
+ /**
6852
+ * The ID of the license type to associate with this price.
6853
+ */
6854
+ license_type_id?: string | null;
6674
6855
  /**
6675
6856
  * User-specified key/value pairs for the resource. Individual keys can be removed
6676
6857
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6702,6 +6883,10 @@ export declare namespace NewPlanScalableMatrixWithUnitPricingPrice {
6702
6883
  * The final unit price to rate against the output of the matrix
6703
6884
  */
6704
6885
  unit_price: string;
6886
+ /**
6887
+ * The property used to group this price
6888
+ */
6889
+ grouping_key?: string | null;
6705
6890
  /**
6706
6891
  * If true, the unit price will be prorated to the billing period
6707
6892
  */
@@ -6793,6 +6978,10 @@ export interface NewPlanThresholdTotalAmountPrice {
6793
6978
  * If unspecified, a single invoice is produced per billing cycle.
6794
6979
  */
6795
6980
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6981
+ /**
6982
+ * The ID of the license type to associate with this price.
6983
+ */
6984
+ license_type_id?: string | null;
6796
6985
  /**
6797
6986
  * User-specified key/value pairs for the resource. Individual keys can be removed
6798
6987
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6906,6 +7095,10 @@ export interface NewPlanTieredPackagePrice {
6906
7095
  * If unspecified, a single invoice is produced per billing cycle.
6907
7096
  */
6908
7097
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7098
+ /**
7099
+ * The ID of the license type to associate with this price.
7100
+ */
7101
+ license_type_id?: string | null;
6909
7102
  /**
6910
7103
  * User-specified key/value pairs for the resource. Individual keys can be removed
6911
7104
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -7018,6 +7211,10 @@ export interface NewPlanTieredPackageWithMinimumPrice {
7018
7211
  * If unspecified, a single invoice is produced per billing cycle.
7019
7212
  */
7020
7213
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7214
+ /**
7215
+ * The ID of the license type to associate with this price.
7216
+ */
7217
+ license_type_id?: string | null;
7021
7218
  /**
7022
7219
  * User-specified key/value pairs for the resource. Individual keys can be removed
7023
7220
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -7126,6 +7323,10 @@ export interface NewPlanTieredPrice {
7126
7323
  * If unspecified, a single invoice is produced per billing cycle.
7127
7324
  */
7128
7325
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7326
+ /**
7327
+ * The ID of the license type to associate with this price.
7328
+ */
7329
+ license_type_id?: string | null;
7129
7330
  /**
7130
7331
  * User-specified key/value pairs for the resource. Individual keys can be removed
7131
7332
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -7211,6 +7412,10 @@ export interface NewPlanTieredWithMinimumPrice {
7211
7412
  * If unspecified, a single invoice is produced per billing cycle.
7212
7413
  */
7213
7414
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7415
+ /**
7416
+ * The ID of the license type to associate with this price.
7417
+ */
7418
+ license_type_id?: string | null;
7214
7419
  /**
7215
7420
  * User-specified key/value pairs for the resource. Individual keys can be removed
7216
7421
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -7329,6 +7534,10 @@ export interface NewPlanUnitPrice {
7329
7534
  * If unspecified, a single invoice is produced per billing cycle.
7330
7535
  */
7331
7536
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7537
+ /**
7538
+ * The ID of the license type to associate with this price.
7539
+ */
7540
+ license_type_id?: string | null;
7332
7541
  /**
7333
7542
  * User-specified key/value pairs for the resource. Individual keys can be removed
7334
7543
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -7414,6 +7623,10 @@ export interface NewPlanUnitWithPercentPrice {
7414
7623
  * If unspecified, a single invoice is produced per billing cycle.
7415
7624
  */
7416
7625
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7626
+ /**
7627
+ * The ID of the license type to associate with this price.
7628
+ */
7629
+ license_type_id?: string | null;
7417
7630
  /**
7418
7631
  * User-specified key/value pairs for the resource. Individual keys can be removed
7419
7632
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -7514,6 +7727,10 @@ export interface NewPlanUnitWithProrationPrice {
7514
7727
  * If unspecified, a single invoice is produced per billing cycle.
7515
7728
  */
7516
7729
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7730
+ /**
7731
+ * The ID of the license type to associate with this price.
7732
+ */
7733
+ license_type_id?: string | null;
7517
7734
  /**
7518
7735
  * User-specified key/value pairs for the resource. Individual keys can be removed
7519
7736
  * by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -8051,6 +8268,12 @@ export declare namespace Price {
8051
8268
  */
8052
8269
  unit_config: Shared.UnitConfig;
8053
8270
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
8271
+ /**
8272
+ * The LicenseType resource represents a type of license that can be assigned to
8273
+ * users. License types are used during billing by grouping metrics on the
8274
+ * configured grouping key.
8275
+ */
8276
+ license_type?: UnitPrice.LicenseType | null;
8054
8277
  }
8055
8278
  namespace UnitPrice {
8056
8279
  interface CompositePriceFilter {
@@ -8067,6 +8290,26 @@ export declare namespace Price {
8067
8290
  */
8068
8291
  values: Array<string>;
8069
8292
  }
8293
+ /**
8294
+ * The LicenseType resource represents a type of license that can be assigned to
8295
+ * users. License types are used during billing by grouping metrics on the
8296
+ * configured grouping key.
8297
+ */
8298
+ interface LicenseType {
8299
+ /**
8300
+ * The Orb-assigned unique identifier for the license type.
8301
+ */
8302
+ id: string;
8303
+ /**
8304
+ * The key used for grouping licenses of this type. This is typically a user
8305
+ * identifier field.
8306
+ */
8307
+ grouping_key: string;
8308
+ /**
8309
+ * The name of the license type.
8310
+ */
8311
+ name: string;
8312
+ }
8070
8313
  }
8071
8314
  interface TieredPrice {
8072
8315
  id: string;
@@ -8134,6 +8377,12 @@ export declare namespace Price {
8134
8377
  */
8135
8378
  tiered_config: Shared.TieredConfig;
8136
8379
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
8380
+ /**
8381
+ * The LicenseType resource represents a type of license that can be assigned to
8382
+ * users. License types are used during billing by grouping metrics on the
8383
+ * configured grouping key.
8384
+ */
8385
+ license_type?: TieredPrice.LicenseType | null;
8137
8386
  }
8138
8387
  namespace TieredPrice {
8139
8388
  interface CompositePriceFilter {
@@ -8150,6 +8399,26 @@ export declare namespace Price {
8150
8399
  */
8151
8400
  values: Array<string>;
8152
8401
  }
8402
+ /**
8403
+ * The LicenseType resource represents a type of license that can be assigned to
8404
+ * users. License types are used during billing by grouping metrics on the
8405
+ * configured grouping key.
8406
+ */
8407
+ interface LicenseType {
8408
+ /**
8409
+ * The Orb-assigned unique identifier for the license type.
8410
+ */
8411
+ id: string;
8412
+ /**
8413
+ * The key used for grouping licenses of this type. This is typically a user
8414
+ * identifier field.
8415
+ */
8416
+ grouping_key: string;
8417
+ /**
8418
+ * The name of the license type.
8419
+ */
8420
+ name: string;
8421
+ }
8153
8422
  }
8154
8423
  interface BulkPrice {
8155
8424
  id: string;
@@ -8217,6 +8486,12 @@ export declare namespace Price {
8217
8486
  */
8218
8487
  replaces_price_id: string | null;
8219
8488
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
8489
+ /**
8490
+ * The LicenseType resource represents a type of license that can be assigned to
8491
+ * users. License types are used during billing by grouping metrics on the
8492
+ * configured grouping key.
8493
+ */
8494
+ license_type?: BulkPrice.LicenseType | null;
8220
8495
  }
8221
8496
  namespace BulkPrice {
8222
8497
  interface CompositePriceFilter {
@@ -8233,6 +8508,26 @@ export declare namespace Price {
8233
8508
  */
8234
8509
  values: Array<string>;
8235
8510
  }
8511
+ /**
8512
+ * The LicenseType resource represents a type of license that can be assigned to
8513
+ * users. License types are used during billing by grouping metrics on the
8514
+ * configured grouping key.
8515
+ */
8516
+ interface LicenseType {
8517
+ /**
8518
+ * The Orb-assigned unique identifier for the license type.
8519
+ */
8520
+ id: string;
8521
+ /**
8522
+ * The key used for grouping licenses of this type. This is typically a user
8523
+ * identifier field.
8524
+ */
8525
+ grouping_key: string;
8526
+ /**
8527
+ * The name of the license type.
8528
+ */
8529
+ name: string;
8530
+ }
8236
8531
  }
8237
8532
  interface BulkWithFiltersPrice {
8238
8533
  id: string;
@@ -8300,6 +8595,12 @@ export declare namespace Price {
8300
8595
  */
8301
8596
  replaces_price_id: string | null;
8302
8597
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
8598
+ /**
8599
+ * The LicenseType resource represents a type of license that can be assigned to
8600
+ * users. License types are used during billing by grouping metrics on the
8601
+ * configured grouping key.
8602
+ */
8603
+ license_type?: BulkWithFiltersPrice.LicenseType | null;
8303
8604
  }
8304
8605
  namespace BulkWithFiltersPrice {
8305
8606
  /**
@@ -8357,6 +8658,26 @@ export declare namespace Price {
8357
8658
  */
8358
8659
  values: Array<string>;
8359
8660
  }
8661
+ /**
8662
+ * The LicenseType resource represents a type of license that can be assigned to
8663
+ * users. License types are used during billing by grouping metrics on the
8664
+ * configured grouping key.
8665
+ */
8666
+ interface LicenseType {
8667
+ /**
8668
+ * The Orb-assigned unique identifier for the license type.
8669
+ */
8670
+ id: string;
8671
+ /**
8672
+ * The key used for grouping licenses of this type. This is typically a user
8673
+ * identifier field.
8674
+ */
8675
+ grouping_key: string;
8676
+ /**
8677
+ * The name of the license type.
8678
+ */
8679
+ name: string;
8680
+ }
8360
8681
  }
8361
8682
  interface PackagePrice {
8362
8683
  id: string;
@@ -8424,6 +8745,12 @@ export declare namespace Price {
8424
8745
  */
8425
8746
  replaces_price_id: string | null;
8426
8747
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
8748
+ /**
8749
+ * The LicenseType resource represents a type of license that can be assigned to
8750
+ * users. License types are used during billing by grouping metrics on the
8751
+ * configured grouping key.
8752
+ */
8753
+ license_type?: PackagePrice.LicenseType | null;
8427
8754
  }
8428
8755
  namespace PackagePrice {
8429
8756
  interface CompositePriceFilter {
@@ -8440,6 +8767,26 @@ export declare namespace Price {
8440
8767
  */
8441
8768
  values: Array<string>;
8442
8769
  }
8770
+ /**
8771
+ * The LicenseType resource represents a type of license that can be assigned to
8772
+ * users. License types are used during billing by grouping metrics on the
8773
+ * configured grouping key.
8774
+ */
8775
+ interface LicenseType {
8776
+ /**
8777
+ * The Orb-assigned unique identifier for the license type.
8778
+ */
8779
+ id: string;
8780
+ /**
8781
+ * The key used for grouping licenses of this type. This is typically a user
8782
+ * identifier field.
8783
+ */
8784
+ grouping_key: string;
8785
+ /**
8786
+ * The name of the license type.
8787
+ */
8788
+ name: string;
8789
+ }
8443
8790
  }
8444
8791
  interface MatrixPrice {
8445
8792
  id: string;
@@ -8507,6 +8854,12 @@ export declare namespace Price {
8507
8854
  */
8508
8855
  replaces_price_id: string | null;
8509
8856
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
8857
+ /**
8858
+ * The LicenseType resource represents a type of license that can be assigned to
8859
+ * users. License types are used during billing by grouping metrics on the
8860
+ * configured grouping key.
8861
+ */
8862
+ license_type?: MatrixPrice.LicenseType | null;
8510
8863
  }
8511
8864
  namespace MatrixPrice {
8512
8865
  interface CompositePriceFilter {
@@ -8523,6 +8876,26 @@ export declare namespace Price {
8523
8876
  */
8524
8877
  values: Array<string>;
8525
8878
  }
8879
+ /**
8880
+ * The LicenseType resource represents a type of license that can be assigned to
8881
+ * users. License types are used during billing by grouping metrics on the
8882
+ * configured grouping key.
8883
+ */
8884
+ interface LicenseType {
8885
+ /**
8886
+ * The Orb-assigned unique identifier for the license type.
8887
+ */
8888
+ id: string;
8889
+ /**
8890
+ * The key used for grouping licenses of this type. This is typically a user
8891
+ * identifier field.
8892
+ */
8893
+ grouping_key: string;
8894
+ /**
8895
+ * The name of the license type.
8896
+ */
8897
+ name: string;
8898
+ }
8526
8899
  }
8527
8900
  interface ThresholdTotalAmountPrice {
8528
8901
  id: string;
@@ -8590,6 +8963,12 @@ export declare namespace Price {
8590
8963
  */
8591
8964
  threshold_total_amount_config: ThresholdTotalAmountPrice.ThresholdTotalAmountConfig;
8592
8965
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
8966
+ /**
8967
+ * The LicenseType resource represents a type of license that can be assigned to
8968
+ * users. License types are used during billing by grouping metrics on the
8969
+ * configured grouping key.
8970
+ */
8971
+ license_type?: ThresholdTotalAmountPrice.LicenseType | null;
8593
8972
  }
8594
8973
  namespace ThresholdTotalAmountPrice {
8595
8974
  interface CompositePriceFilter {
@@ -8632,6 +9011,26 @@ export declare namespace Price {
8632
9011
  total_amount: string;
8633
9012
  }
8634
9013
  }
9014
+ /**
9015
+ * The LicenseType resource represents a type of license that can be assigned to
9016
+ * users. License types are used during billing by grouping metrics on the
9017
+ * configured grouping key.
9018
+ */
9019
+ interface LicenseType {
9020
+ /**
9021
+ * The Orb-assigned unique identifier for the license type.
9022
+ */
9023
+ id: string;
9024
+ /**
9025
+ * The key used for grouping licenses of this type. This is typically a user
9026
+ * identifier field.
9027
+ */
9028
+ grouping_key: string;
9029
+ /**
9030
+ * The name of the license type.
9031
+ */
9032
+ name: string;
9033
+ }
8635
9034
  }
8636
9035
  interface TieredPackagePrice {
8637
9036
  id: string;
@@ -8699,6 +9098,12 @@ export declare namespace Price {
8699
9098
  */
8700
9099
  tiered_package_config: TieredPackagePrice.TieredPackageConfig;
8701
9100
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9101
+ /**
9102
+ * The LicenseType resource represents a type of license that can be assigned to
9103
+ * users. License types are used during billing by grouping metrics on the
9104
+ * configured grouping key.
9105
+ */
9106
+ license_type?: TieredPackagePrice.LicenseType | null;
8702
9107
  }
8703
9108
  namespace TieredPackagePrice {
8704
9109
  interface CompositePriceFilter {
@@ -8740,6 +9145,26 @@ export declare namespace Price {
8740
9145
  tier_lower_bound: string;
8741
9146
  }
8742
9147
  }
9148
+ /**
9149
+ * The LicenseType resource represents a type of license that can be assigned to
9150
+ * users. License types are used during billing by grouping metrics on the
9151
+ * configured grouping key.
9152
+ */
9153
+ interface LicenseType {
9154
+ /**
9155
+ * The Orb-assigned unique identifier for the license type.
9156
+ */
9157
+ id: string;
9158
+ /**
9159
+ * The key used for grouping licenses of this type. This is typically a user
9160
+ * identifier field.
9161
+ */
9162
+ grouping_key: string;
9163
+ /**
9164
+ * The name of the license type.
9165
+ */
9166
+ name: string;
9167
+ }
8743
9168
  }
8744
9169
  interface TieredWithMinimumPrice {
8745
9170
  id: string;
@@ -8807,6 +9232,12 @@ export declare namespace Price {
8807
9232
  */
8808
9233
  tiered_with_minimum_config: TieredWithMinimumPrice.TieredWithMinimumConfig;
8809
9234
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9235
+ /**
9236
+ * The LicenseType resource represents a type of license that can be assigned to
9237
+ * users. License types are used during billing by grouping metrics on the
9238
+ * configured grouping key.
9239
+ */
9240
+ license_type?: TieredWithMinimumPrice.LicenseType | null;
8810
9241
  }
8811
9242
  namespace TieredWithMinimumPrice {
8812
9243
  interface CompositePriceFilter {
@@ -8854,6 +9285,26 @@ export declare namespace Price {
8854
9285
  unit_amount: string;
8855
9286
  }
8856
9287
  }
9288
+ /**
9289
+ * The LicenseType resource represents a type of license that can be assigned to
9290
+ * users. License types are used during billing by grouping metrics on the
9291
+ * configured grouping key.
9292
+ */
9293
+ interface LicenseType {
9294
+ /**
9295
+ * The Orb-assigned unique identifier for the license type.
9296
+ */
9297
+ id: string;
9298
+ /**
9299
+ * The key used for grouping licenses of this type. This is typically a user
9300
+ * identifier field.
9301
+ */
9302
+ grouping_key: string;
9303
+ /**
9304
+ * The name of the license type.
9305
+ */
9306
+ name: string;
9307
+ }
8857
9308
  }
8858
9309
  interface GroupedTieredPrice {
8859
9310
  id: string;
@@ -8921,6 +9372,12 @@ export declare namespace Price {
8921
9372
  */
8922
9373
  replaces_price_id: string | null;
8923
9374
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9375
+ /**
9376
+ * The LicenseType resource represents a type of license that can be assigned to
9377
+ * users. License types are used during billing by grouping metrics on the
9378
+ * configured grouping key.
9379
+ */
9380
+ license_type?: GroupedTieredPrice.LicenseType | null;
8924
9381
  }
8925
9382
  namespace GroupedTieredPrice {
8926
9383
  interface CompositePriceFilter {
@@ -8963,6 +9420,26 @@ export declare namespace Price {
8963
9420
  unit_amount: string;
8964
9421
  }
8965
9422
  }
9423
+ /**
9424
+ * The LicenseType resource represents a type of license that can be assigned to
9425
+ * users. License types are used during billing by grouping metrics on the
9426
+ * configured grouping key.
9427
+ */
9428
+ interface LicenseType {
9429
+ /**
9430
+ * The Orb-assigned unique identifier for the license type.
9431
+ */
9432
+ id: string;
9433
+ /**
9434
+ * The key used for grouping licenses of this type. This is typically a user
9435
+ * identifier field.
9436
+ */
9437
+ grouping_key: string;
9438
+ /**
9439
+ * The name of the license type.
9440
+ */
9441
+ name: string;
9442
+ }
8966
9443
  }
8967
9444
  interface TieredPackageWithMinimumPrice {
8968
9445
  id: string;
@@ -9030,6 +9507,12 @@ export declare namespace Price {
9030
9507
  */
9031
9508
  tiered_package_with_minimum_config: TieredPackageWithMinimumPrice.TieredPackageWithMinimumConfig;
9032
9509
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9510
+ /**
9511
+ * The LicenseType resource represents a type of license that can be assigned to
9512
+ * users. License types are used during billing by grouping metrics on the
9513
+ * configured grouping key.
9514
+ */
9515
+ license_type?: TieredPackageWithMinimumPrice.LicenseType | null;
9033
9516
  }
9034
9517
  namespace TieredPackageWithMinimumPrice {
9035
9518
  interface CompositePriceFilter {
@@ -9067,12 +9550,32 @@ export declare namespace Price {
9067
9550
  tier_lower_bound: string;
9068
9551
  }
9069
9552
  }
9070
- }
9071
- interface PackageWithAllocationPrice {
9072
- id: string;
9073
- billable_metric: Shared.BillableMetricTiny | null;
9074
- billing_cycle_configuration: Shared.BillingCycleConfiguration;
9075
- billing_mode: 'in_advance' | 'in_arrear';
9553
+ /**
9554
+ * The LicenseType resource represents a type of license that can be assigned to
9555
+ * users. License types are used during billing by grouping metrics on the
9556
+ * configured grouping key.
9557
+ */
9558
+ interface LicenseType {
9559
+ /**
9560
+ * The Orb-assigned unique identifier for the license type.
9561
+ */
9562
+ id: string;
9563
+ /**
9564
+ * The key used for grouping licenses of this type. This is typically a user
9565
+ * identifier field.
9566
+ */
9567
+ grouping_key: string;
9568
+ /**
9569
+ * The name of the license type.
9570
+ */
9571
+ name: string;
9572
+ }
9573
+ }
9574
+ interface PackageWithAllocationPrice {
9575
+ id: string;
9576
+ billable_metric: Shared.BillableMetricTiny | null;
9577
+ billing_cycle_configuration: Shared.BillingCycleConfiguration;
9578
+ billing_mode: 'in_advance' | 'in_arrear';
9076
9579
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9077
9580
  composite_price_filters: Array<PackageWithAllocationPrice.CompositePriceFilter> | null;
9078
9581
  conversion_rate: number | null;
@@ -9134,6 +9637,12 @@ export declare namespace Price {
9134
9637
  */
9135
9638
  replaces_price_id: string | null;
9136
9639
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9640
+ /**
9641
+ * The LicenseType resource represents a type of license that can be assigned to
9642
+ * users. License types are used during billing by grouping metrics on the
9643
+ * configured grouping key.
9644
+ */
9645
+ license_type?: PackageWithAllocationPrice.LicenseType | null;
9137
9646
  }
9138
9647
  namespace PackageWithAllocationPrice {
9139
9648
  interface CompositePriceFilter {
@@ -9158,6 +9667,26 @@ export declare namespace Price {
9158
9667
  package_amount: string;
9159
9668
  package_size: string;
9160
9669
  }
9670
+ /**
9671
+ * The LicenseType resource represents a type of license that can be assigned to
9672
+ * users. License types are used during billing by grouping metrics on the
9673
+ * configured grouping key.
9674
+ */
9675
+ interface LicenseType {
9676
+ /**
9677
+ * The Orb-assigned unique identifier for the license type.
9678
+ */
9679
+ id: string;
9680
+ /**
9681
+ * The key used for grouping licenses of this type. This is typically a user
9682
+ * identifier field.
9683
+ */
9684
+ grouping_key: string;
9685
+ /**
9686
+ * The name of the license type.
9687
+ */
9688
+ name: string;
9689
+ }
9161
9690
  }
9162
9691
  interface UnitWithPercentPrice {
9163
9692
  id: string;
@@ -9225,6 +9754,12 @@ export declare namespace Price {
9225
9754
  */
9226
9755
  unit_with_percent_config: UnitWithPercentPrice.UnitWithPercentConfig;
9227
9756
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9757
+ /**
9758
+ * The LicenseType resource represents a type of license that can be assigned to
9759
+ * users. License types are used during billing by grouping metrics on the
9760
+ * configured grouping key.
9761
+ */
9762
+ license_type?: UnitWithPercentPrice.LicenseType | null;
9228
9763
  }
9229
9764
  namespace UnitWithPercentPrice {
9230
9765
  interface CompositePriceFilter {
@@ -9254,6 +9789,26 @@ export declare namespace Price {
9254
9789
  */
9255
9790
  unit_amount: string;
9256
9791
  }
9792
+ /**
9793
+ * The LicenseType resource represents a type of license that can be assigned to
9794
+ * users. License types are used during billing by grouping metrics on the
9795
+ * configured grouping key.
9796
+ */
9797
+ interface LicenseType {
9798
+ /**
9799
+ * The Orb-assigned unique identifier for the license type.
9800
+ */
9801
+ id: string;
9802
+ /**
9803
+ * The key used for grouping licenses of this type. This is typically a user
9804
+ * identifier field.
9805
+ */
9806
+ grouping_key: string;
9807
+ /**
9808
+ * The name of the license type.
9809
+ */
9810
+ name: string;
9811
+ }
9257
9812
  }
9258
9813
  interface MatrixWithAllocationPrice {
9259
9814
  id: string;
@@ -9321,6 +9876,12 @@ export declare namespace Price {
9321
9876
  */
9322
9877
  replaces_price_id: string | null;
9323
9878
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9879
+ /**
9880
+ * The LicenseType resource represents a type of license that can be assigned to
9881
+ * users. License types are used during billing by grouping metrics on the
9882
+ * configured grouping key.
9883
+ */
9884
+ license_type?: MatrixWithAllocationPrice.LicenseType | null;
9324
9885
  }
9325
9886
  namespace MatrixWithAllocationPrice {
9326
9887
  interface CompositePriceFilter {
@@ -9337,6 +9898,26 @@ export declare namespace Price {
9337
9898
  */
9338
9899
  values: Array<string>;
9339
9900
  }
9901
+ /**
9902
+ * The LicenseType resource represents a type of license that can be assigned to
9903
+ * users. License types are used during billing by grouping metrics on the
9904
+ * configured grouping key.
9905
+ */
9906
+ interface LicenseType {
9907
+ /**
9908
+ * The Orb-assigned unique identifier for the license type.
9909
+ */
9910
+ id: string;
9911
+ /**
9912
+ * The key used for grouping licenses of this type. This is typically a user
9913
+ * identifier field.
9914
+ */
9915
+ grouping_key: string;
9916
+ /**
9917
+ * The name of the license type.
9918
+ */
9919
+ name: string;
9920
+ }
9340
9921
  }
9341
9922
  interface TieredWithProrationPrice {
9342
9923
  id: string;
@@ -9404,6 +9985,12 @@ export declare namespace Price {
9404
9985
  */
9405
9986
  tiered_with_proration_config: TieredWithProrationPrice.TieredWithProrationConfig;
9406
9987
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9988
+ /**
9989
+ * The LicenseType resource represents a type of license that can be assigned to
9990
+ * users. License types are used during billing by grouping metrics on the
9991
+ * configured grouping key.
9992
+ */
9993
+ license_type?: TieredWithProrationPrice.LicenseType | null;
9407
9994
  }
9408
9995
  namespace TieredWithProrationPrice {
9409
9996
  interface CompositePriceFilter {
@@ -9445,6 +10032,26 @@ export declare namespace Price {
9445
10032
  unit_amount: string;
9446
10033
  }
9447
10034
  }
10035
+ /**
10036
+ * The LicenseType resource represents a type of license that can be assigned to
10037
+ * users. License types are used during billing by grouping metrics on the
10038
+ * configured grouping key.
10039
+ */
10040
+ interface LicenseType {
10041
+ /**
10042
+ * The Orb-assigned unique identifier for the license type.
10043
+ */
10044
+ id: string;
10045
+ /**
10046
+ * The key used for grouping licenses of this type. This is typically a user
10047
+ * identifier field.
10048
+ */
10049
+ grouping_key: string;
10050
+ /**
10051
+ * The name of the license type.
10052
+ */
10053
+ name: string;
10054
+ }
9448
10055
  }
9449
10056
  interface UnitWithProrationPrice {
9450
10057
  id: string;
@@ -9512,6 +10119,12 @@ export declare namespace Price {
9512
10119
  */
9513
10120
  unit_with_proration_config: UnitWithProrationPrice.UnitWithProrationConfig;
9514
10121
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
10122
+ /**
10123
+ * The LicenseType resource represents a type of license that can be assigned to
10124
+ * users. License types are used during billing by grouping metrics on the
10125
+ * configured grouping key.
10126
+ */
10127
+ license_type?: UnitWithProrationPrice.LicenseType | null;
9515
10128
  }
9516
10129
  namespace UnitWithProrationPrice {
9517
10130
  interface CompositePriceFilter {
@@ -9537,6 +10150,26 @@ export declare namespace Price {
9537
10150
  */
9538
10151
  unit_amount: string;
9539
10152
  }
10153
+ /**
10154
+ * The LicenseType resource represents a type of license that can be assigned to
10155
+ * users. License types are used during billing by grouping metrics on the
10156
+ * configured grouping key.
10157
+ */
10158
+ interface LicenseType {
10159
+ /**
10160
+ * The Orb-assigned unique identifier for the license type.
10161
+ */
10162
+ id: string;
10163
+ /**
10164
+ * The key used for grouping licenses of this type. This is typically a user
10165
+ * identifier field.
10166
+ */
10167
+ grouping_key: string;
10168
+ /**
10169
+ * The name of the license type.
10170
+ */
10171
+ name: string;
10172
+ }
9540
10173
  }
9541
10174
  interface GroupedAllocationPrice {
9542
10175
  id: string;
@@ -9604,6 +10237,12 @@ export declare namespace Price {
9604
10237
  */
9605
10238
  replaces_price_id: string | null;
9606
10239
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
10240
+ /**
10241
+ * The LicenseType resource represents a type of license that can be assigned to
10242
+ * users. License types are used during billing by grouping metrics on the
10243
+ * configured grouping key.
10244
+ */
10245
+ license_type?: GroupedAllocationPrice.LicenseType | null;
9607
10246
  }
9608
10247
  namespace GroupedAllocationPrice {
9609
10248
  interface CompositePriceFilter {
@@ -9637,6 +10276,26 @@ export declare namespace Price {
9637
10276
  */
9638
10277
  overage_unit_rate: string;
9639
10278
  }
10279
+ /**
10280
+ * The LicenseType resource represents a type of license that can be assigned to
10281
+ * users. License types are used during billing by grouping metrics on the
10282
+ * configured grouping key.
10283
+ */
10284
+ interface LicenseType {
10285
+ /**
10286
+ * The Orb-assigned unique identifier for the license type.
10287
+ */
10288
+ id: string;
10289
+ /**
10290
+ * The key used for grouping licenses of this type. This is typically a user
10291
+ * identifier field.
10292
+ */
10293
+ grouping_key: string;
10294
+ /**
10295
+ * The name of the license type.
10296
+ */
10297
+ name: string;
10298
+ }
9640
10299
  }
9641
10300
  interface BulkWithProrationPrice {
9642
10301
  id: string;
@@ -9704,6 +10363,12 @@ export declare namespace Price {
9704
10363
  */
9705
10364
  replaces_price_id: string | null;
9706
10365
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
10366
+ /**
10367
+ * The LicenseType resource represents a type of license that can be assigned to
10368
+ * users. License types are used during billing by grouping metrics on the
10369
+ * configured grouping key.
10370
+ */
10371
+ license_type?: BulkWithProrationPrice.LicenseType | null;
9707
10372
  }
9708
10373
  namespace BulkWithProrationPrice {
9709
10374
  /**
@@ -9744,6 +10409,26 @@ export declare namespace Price {
9744
10409
  */
9745
10410
  values: Array<string>;
9746
10411
  }
10412
+ /**
10413
+ * The LicenseType resource represents a type of license that can be assigned to
10414
+ * users. License types are used during billing by grouping metrics on the
10415
+ * configured grouping key.
10416
+ */
10417
+ interface LicenseType {
10418
+ /**
10419
+ * The Orb-assigned unique identifier for the license type.
10420
+ */
10421
+ id: string;
10422
+ /**
10423
+ * The key used for grouping licenses of this type. This is typically a user
10424
+ * identifier field.
10425
+ */
10426
+ grouping_key: string;
10427
+ /**
10428
+ * The name of the license type.
10429
+ */
10430
+ name: string;
10431
+ }
9747
10432
  }
9748
10433
  interface GroupedWithProratedMinimumPrice {
9749
10434
  id: string;
@@ -9811,6 +10496,12 @@ export declare namespace Price {
9811
10496
  */
9812
10497
  replaces_price_id: string | null;
9813
10498
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
10499
+ /**
10500
+ * The LicenseType resource represents a type of license that can be assigned to
10501
+ * users. License types are used during billing by grouping metrics on the
10502
+ * configured grouping key.
10503
+ */
10504
+ license_type?: GroupedWithProratedMinimumPrice.LicenseType | null;
9814
10505
  }
9815
10506
  namespace GroupedWithProratedMinimumPrice {
9816
10507
  interface CompositePriceFilter {
@@ -9844,6 +10535,26 @@ export declare namespace Price {
9844
10535
  */
9845
10536
  unit_rate: string;
9846
10537
  }
10538
+ /**
10539
+ * The LicenseType resource represents a type of license that can be assigned to
10540
+ * users. License types are used during billing by grouping metrics on the
10541
+ * configured grouping key.
10542
+ */
10543
+ interface LicenseType {
10544
+ /**
10545
+ * The Orb-assigned unique identifier for the license type.
10546
+ */
10547
+ id: string;
10548
+ /**
10549
+ * The key used for grouping licenses of this type. This is typically a user
10550
+ * identifier field.
10551
+ */
10552
+ grouping_key: string;
10553
+ /**
10554
+ * The name of the license type.
10555
+ */
10556
+ name: string;
10557
+ }
9847
10558
  }
9848
10559
  interface GroupedWithMeteredMinimumPrice {
9849
10560
  id: string;
@@ -9911,6 +10622,12 @@ export declare namespace Price {
9911
10622
  */
9912
10623
  replaces_price_id: string | null;
9913
10624
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
10625
+ /**
10626
+ * The LicenseType resource represents a type of license that can be assigned to
10627
+ * users. License types are used during billing by grouping metrics on the
10628
+ * configured grouping key.
10629
+ */
10630
+ license_type?: GroupedWithMeteredMinimumPrice.LicenseType | null;
9914
10631
  }
9915
10632
  namespace GroupedWithMeteredMinimumPrice {
9916
10633
  interface CompositePriceFilter {
@@ -9977,6 +10694,26 @@ export declare namespace Price {
9977
10694
  unit_amount: string;
9978
10695
  }
9979
10696
  }
10697
+ /**
10698
+ * The LicenseType resource represents a type of license that can be assigned to
10699
+ * users. License types are used during billing by grouping metrics on the
10700
+ * configured grouping key.
10701
+ */
10702
+ interface LicenseType {
10703
+ /**
10704
+ * The Orb-assigned unique identifier for the license type.
10705
+ */
10706
+ id: string;
10707
+ /**
10708
+ * The key used for grouping licenses of this type. This is typically a user
10709
+ * identifier field.
10710
+ */
10711
+ grouping_key: string;
10712
+ /**
10713
+ * The name of the license type.
10714
+ */
10715
+ name: string;
10716
+ }
9980
10717
  }
9981
10718
  interface GroupedWithMinMaxThresholdsPrice {
9982
10719
  id: string;
@@ -10044,6 +10781,12 @@ export declare namespace Price {
10044
10781
  */
10045
10782
  replaces_price_id: string | null;
10046
10783
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
10784
+ /**
10785
+ * The LicenseType resource represents a type of license that can be assigned to
10786
+ * users. License types are used during billing by grouping metrics on the
10787
+ * configured grouping key.
10788
+ */
10789
+ license_type?: GroupedWithMinMaxThresholdsPrice.LicenseType | null;
10047
10790
  }
10048
10791
  namespace GroupedWithMinMaxThresholdsPrice {
10049
10792
  interface CompositePriceFilter {
@@ -10081,6 +10824,26 @@ export declare namespace Price {
10081
10824
  */
10082
10825
  per_unit_rate: string;
10083
10826
  }
10827
+ /**
10828
+ * The LicenseType resource represents a type of license that can be assigned to
10829
+ * users. License types are used during billing by grouping metrics on the
10830
+ * configured grouping key.
10831
+ */
10832
+ interface LicenseType {
10833
+ /**
10834
+ * The Orb-assigned unique identifier for the license type.
10835
+ */
10836
+ id: string;
10837
+ /**
10838
+ * The key used for grouping licenses of this type. This is typically a user
10839
+ * identifier field.
10840
+ */
10841
+ grouping_key: string;
10842
+ /**
10843
+ * The name of the license type.
10844
+ */
10845
+ name: string;
10846
+ }
10084
10847
  }
10085
10848
  interface MatrixWithDisplayNamePrice {
10086
10849
  id: string;
@@ -10148,6 +10911,12 @@ export declare namespace Price {
10148
10911
  */
10149
10912
  replaces_price_id: string | null;
10150
10913
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
10914
+ /**
10915
+ * The LicenseType resource represents a type of license that can be assigned to
10916
+ * users. License types are used during billing by grouping metrics on the
10917
+ * configured grouping key.
10918
+ */
10919
+ license_type?: MatrixWithDisplayNamePrice.LicenseType | null;
10151
10920
  }
10152
10921
  namespace MatrixWithDisplayNamePrice {
10153
10922
  interface CompositePriceFilter {
@@ -10196,6 +10965,26 @@ export declare namespace Price {
10196
10965
  unit_amount: string;
10197
10966
  }
10198
10967
  }
10968
+ /**
10969
+ * The LicenseType resource represents a type of license that can be assigned to
10970
+ * users. License types are used during billing by grouping metrics on the
10971
+ * configured grouping key.
10972
+ */
10973
+ interface LicenseType {
10974
+ /**
10975
+ * The Orb-assigned unique identifier for the license type.
10976
+ */
10977
+ id: string;
10978
+ /**
10979
+ * The key used for grouping licenses of this type. This is typically a user
10980
+ * identifier field.
10981
+ */
10982
+ grouping_key: string;
10983
+ /**
10984
+ * The name of the license type.
10985
+ */
10986
+ name: string;
10987
+ }
10199
10988
  }
10200
10989
  interface GroupedTieredPackagePrice {
10201
10990
  id: string;
@@ -10263,6 +11052,12 @@ export declare namespace Price {
10263
11052
  */
10264
11053
  replaces_price_id: string | null;
10265
11054
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
11055
+ /**
11056
+ * The LicenseType resource represents a type of license that can be assigned to
11057
+ * users. License types are used during billing by grouping metrics on the
11058
+ * configured grouping key.
11059
+ */
11060
+ license_type?: GroupedTieredPackagePrice.LicenseType | null;
10266
11061
  }
10267
11062
  namespace GroupedTieredPackagePrice {
10268
11063
  interface CompositePriceFilter {
@@ -10306,6 +11101,26 @@ export declare namespace Price {
10306
11101
  tier_lower_bound: string;
10307
11102
  }
10308
11103
  }
11104
+ /**
11105
+ * The LicenseType resource represents a type of license that can be assigned to
11106
+ * users. License types are used during billing by grouping metrics on the
11107
+ * configured grouping key.
11108
+ */
11109
+ interface LicenseType {
11110
+ /**
11111
+ * The Orb-assigned unique identifier for the license type.
11112
+ */
11113
+ id: string;
11114
+ /**
11115
+ * The key used for grouping licenses of this type. This is typically a user
11116
+ * identifier field.
11117
+ */
11118
+ grouping_key: string;
11119
+ /**
11120
+ * The name of the license type.
11121
+ */
11122
+ name: string;
11123
+ }
10309
11124
  }
10310
11125
  interface MaxGroupTieredPackagePrice {
10311
11126
  id: string;
@@ -10373,6 +11188,12 @@ export declare namespace Price {
10373
11188
  */
10374
11189
  replaces_price_id: string | null;
10375
11190
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
11191
+ /**
11192
+ * The LicenseType resource represents a type of license that can be assigned to
11193
+ * users. License types are used during billing by grouping metrics on the
11194
+ * configured grouping key.
11195
+ */
11196
+ license_type?: MaxGroupTieredPackagePrice.LicenseType | null;
10376
11197
  }
10377
11198
  namespace MaxGroupTieredPackagePrice {
10378
11199
  interface CompositePriceFilter {
@@ -10415,6 +11236,26 @@ export declare namespace Price {
10415
11236
  unit_amount: string;
10416
11237
  }
10417
11238
  }
11239
+ /**
11240
+ * The LicenseType resource represents a type of license that can be assigned to
11241
+ * users. License types are used during billing by grouping metrics on the
11242
+ * configured grouping key.
11243
+ */
11244
+ interface LicenseType {
11245
+ /**
11246
+ * The Orb-assigned unique identifier for the license type.
11247
+ */
11248
+ id: string;
11249
+ /**
11250
+ * The key used for grouping licenses of this type. This is typically a user
11251
+ * identifier field.
11252
+ */
11253
+ grouping_key: string;
11254
+ /**
11255
+ * The name of the license type.
11256
+ */
11257
+ name: string;
11258
+ }
10418
11259
  }
10419
11260
  interface ScalableMatrixWithUnitPricingPrice {
10420
11261
  id: string;
@@ -10482,6 +11323,12 @@ export declare namespace Price {
10482
11323
  */
10483
11324
  scalable_matrix_with_unit_pricing_config: ScalableMatrixWithUnitPricingPrice.ScalableMatrixWithUnitPricingConfig;
10484
11325
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
11326
+ /**
11327
+ * The LicenseType resource represents a type of license that can be assigned to
11328
+ * users. License types are used during billing by grouping metrics on the
11329
+ * configured grouping key.
11330
+ */
11331
+ license_type?: ScalableMatrixWithUnitPricingPrice.LicenseType | null;
10485
11332
  }
10486
11333
  namespace ScalableMatrixWithUnitPricingPrice {
10487
11334
  interface CompositePriceFilter {
@@ -10514,6 +11361,10 @@ export declare namespace Price {
10514
11361
  * The final unit price to rate against the output of the matrix
10515
11362
  */
10516
11363
  unit_price: string;
11364
+ /**
11365
+ * The property used to group this price
11366
+ */
11367
+ grouping_key?: string | null;
10517
11368
  /**
10518
11369
  * If true, the unit price will be prorated to the billing period
10519
11370
  */
@@ -10533,6 +11384,26 @@ export declare namespace Price {
10533
11384
  second_dimension_value?: string | null;
10534
11385
  }
10535
11386
  }
11387
+ /**
11388
+ * The LicenseType resource represents a type of license that can be assigned to
11389
+ * users. License types are used during billing by grouping metrics on the
11390
+ * configured grouping key.
11391
+ */
11392
+ interface LicenseType {
11393
+ /**
11394
+ * The Orb-assigned unique identifier for the license type.
11395
+ */
11396
+ id: string;
11397
+ /**
11398
+ * The key used for grouping licenses of this type. This is typically a user
11399
+ * identifier field.
11400
+ */
11401
+ grouping_key: string;
11402
+ /**
11403
+ * The name of the license type.
11404
+ */
11405
+ name: string;
11406
+ }
10536
11407
  }
10537
11408
  interface ScalableMatrixWithTieredPricingPrice {
10538
11409
  id: string;
@@ -10600,6 +11471,12 @@ export declare namespace Price {
10600
11471
  */
10601
11472
  scalable_matrix_with_tiered_pricing_config: ScalableMatrixWithTieredPricingPrice.ScalableMatrixWithTieredPricingConfig;
10602
11473
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
11474
+ /**
11475
+ * The LicenseType resource represents a type of license that can be assigned to
11476
+ * users. License types are used during billing by grouping metrics on the
11477
+ * configured grouping key.
11478
+ */
11479
+ license_type?: ScalableMatrixWithTieredPricingPrice.LicenseType | null;
10603
11480
  }
10604
11481
  namespace ScalableMatrixWithTieredPricingPrice {
10605
11482
  interface CompositePriceFilter {
@@ -10651,6 +11528,26 @@ export declare namespace Price {
10651
11528
  unit_amount: string;
10652
11529
  }
10653
11530
  }
11531
+ /**
11532
+ * The LicenseType resource represents a type of license that can be assigned to
11533
+ * users. License types are used during billing by grouping metrics on the
11534
+ * configured grouping key.
11535
+ */
11536
+ interface LicenseType {
11537
+ /**
11538
+ * The Orb-assigned unique identifier for the license type.
11539
+ */
11540
+ id: string;
11541
+ /**
11542
+ * The key used for grouping licenses of this type. This is typically a user
11543
+ * identifier field.
11544
+ */
11545
+ grouping_key: string;
11546
+ /**
11547
+ * The name of the license type.
11548
+ */
11549
+ name: string;
11550
+ }
10654
11551
  }
10655
11552
  interface CumulativeGroupedBulkPrice {
10656
11553
  id: string;
@@ -10718,6 +11615,12 @@ export declare namespace Price {
10718
11615
  */
10719
11616
  replaces_price_id: string | null;
10720
11617
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
11618
+ /**
11619
+ * The LicenseType resource represents a type of license that can be assigned to
11620
+ * users. License types are used during billing by grouping metrics on the
11621
+ * configured grouping key.
11622
+ */
11623
+ license_type?: CumulativeGroupedBulkPrice.LicenseType | null;
10721
11624
  }
10722
11625
  namespace CumulativeGroupedBulkPrice {
10723
11626
  interface CompositePriceFilter {
@@ -10763,6 +11666,26 @@ export declare namespace Price {
10763
11666
  unit_amount: string;
10764
11667
  }
10765
11668
  }
11669
+ /**
11670
+ * The LicenseType resource represents a type of license that can be assigned to
11671
+ * users. License types are used during billing by grouping metrics on the
11672
+ * configured grouping key.
11673
+ */
11674
+ interface LicenseType {
11675
+ /**
11676
+ * The Orb-assigned unique identifier for the license type.
11677
+ */
11678
+ id: string;
11679
+ /**
11680
+ * The key used for grouping licenses of this type. This is typically a user
11681
+ * identifier field.
11682
+ */
11683
+ grouping_key: string;
11684
+ /**
11685
+ * The name of the license type.
11686
+ */
11687
+ name: string;
11688
+ }
10766
11689
  }
10767
11690
  interface CumulativeGroupedAllocationPrice {
10768
11691
  id: string;
@@ -10830,6 +11753,12 @@ export declare namespace Price {
10830
11753
  */
10831
11754
  replaces_price_id: string | null;
10832
11755
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
11756
+ /**
11757
+ * The LicenseType resource represents a type of license that can be assigned to
11758
+ * users. License types are used during billing by grouping metrics on the
11759
+ * configured grouping key.
11760
+ */
11761
+ license_type?: CumulativeGroupedAllocationPrice.LicenseType | null;
10833
11762
  }
10834
11763
  namespace CumulativeGroupedAllocationPrice {
10835
11764
  interface CompositePriceFilter {
@@ -10867,6 +11796,26 @@ export declare namespace Price {
10867
11796
  */
10868
11797
  unit_amount: string;
10869
11798
  }
11799
+ /**
11800
+ * The LicenseType resource represents a type of license that can be assigned to
11801
+ * users. License types are used during billing by grouping metrics on the
11802
+ * configured grouping key.
11803
+ */
11804
+ interface LicenseType {
11805
+ /**
11806
+ * The Orb-assigned unique identifier for the license type.
11807
+ */
11808
+ id: string;
11809
+ /**
11810
+ * The key used for grouping licenses of this type. This is typically a user
11811
+ * identifier field.
11812
+ */
11813
+ grouping_key: string;
11814
+ /**
11815
+ * The name of the license type.
11816
+ */
11817
+ name: string;
11818
+ }
10870
11819
  }
10871
11820
  interface MinimumCompositePrice {
10872
11821
  id: string;
@@ -10934,6 +11883,12 @@ export declare namespace Price {
10934
11883
  */
10935
11884
  replaces_price_id: string | null;
10936
11885
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
11886
+ /**
11887
+ * The LicenseType resource represents a type of license that can be assigned to
11888
+ * users. License types are used during billing by grouping metrics on the
11889
+ * configured grouping key.
11890
+ */
11891
+ license_type?: MinimumCompositePrice.LicenseType | null;
10937
11892
  }
10938
11893
  namespace MinimumCompositePrice {
10939
11894
  interface CompositePriceFilter {
@@ -10963,6 +11918,26 @@ export declare namespace Price {
10963
11918
  */
10964
11919
  prorated?: boolean;
10965
11920
  }
11921
+ /**
11922
+ * The LicenseType resource represents a type of license that can be assigned to
11923
+ * users. License types are used during billing by grouping metrics on the
11924
+ * configured grouping key.
11925
+ */
11926
+ interface LicenseType {
11927
+ /**
11928
+ * The Orb-assigned unique identifier for the license type.
11929
+ */
11930
+ id: string;
11931
+ /**
11932
+ * The key used for grouping licenses of this type. This is typically a user
11933
+ * identifier field.
11934
+ */
11935
+ grouping_key: string;
11936
+ /**
11937
+ * The name of the license type.
11938
+ */
11939
+ name: string;
11940
+ }
10966
11941
  }
10967
11942
  interface PercentCompositePrice {
10968
11943
  id: string;
@@ -11030,6 +12005,12 @@ export declare namespace Price {
11030
12005
  */
11031
12006
  replaces_price_id: string | null;
11032
12007
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
12008
+ /**
12009
+ * The LicenseType resource represents a type of license that can be assigned to
12010
+ * users. License types are used during billing by grouping metrics on the
12011
+ * configured grouping key.
12012
+ */
12013
+ license_type?: PercentCompositePrice.LicenseType | null;
11033
12014
  }
11034
12015
  namespace PercentCompositePrice {
11035
12016
  interface CompositePriceFilter {
@@ -11055,6 +12036,26 @@ export declare namespace Price {
11055
12036
  */
11056
12037
  percent: number;
11057
12038
  }
12039
+ /**
12040
+ * The LicenseType resource represents a type of license that can be assigned to
12041
+ * users. License types are used during billing by grouping metrics on the
12042
+ * configured grouping key.
12043
+ */
12044
+ interface LicenseType {
12045
+ /**
12046
+ * The Orb-assigned unique identifier for the license type.
12047
+ */
12048
+ id: string;
12049
+ /**
12050
+ * The key used for grouping licenses of this type. This is typically a user
12051
+ * identifier field.
12052
+ */
12053
+ grouping_key: string;
12054
+ /**
12055
+ * The name of the license type.
12056
+ */
12057
+ name: string;
12058
+ }
11058
12059
  }
11059
12060
  interface EventOutputPrice {
11060
12061
  id: string;
@@ -11122,6 +12123,12 @@ export declare namespace Price {
11122
12123
  */
11123
12124
  replaces_price_id: string | null;
11124
12125
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
12126
+ /**
12127
+ * The LicenseType resource represents a type of license that can be assigned to
12128
+ * users. License types are used during billing by grouping metrics on the
12129
+ * configured grouping key.
12130
+ */
12131
+ license_type?: EventOutputPrice.LicenseType | null;
11125
12132
  }
11126
12133
  namespace EventOutputPrice {
11127
12134
  interface CompositePriceFilter {
@@ -11158,6 +12165,26 @@ export declare namespace Price {
11158
12165
  */
11159
12166
  grouping_key?: string | null;
11160
12167
  }
12168
+ /**
12169
+ * The LicenseType resource represents a type of license that can be assigned to
12170
+ * users. License types are used during billing by grouping metrics on the
12171
+ * configured grouping key.
12172
+ */
12173
+ interface LicenseType {
12174
+ /**
12175
+ * The Orb-assigned unique identifier for the license type.
12176
+ */
12177
+ id: string;
12178
+ /**
12179
+ * The key used for grouping licenses of this type. This is typically a user
12180
+ * identifier field.
12181
+ */
12182
+ grouping_key: string;
12183
+ /**
12184
+ * The name of the license type.
12185
+ */
12186
+ name: string;
12187
+ }
11161
12188
  }
11162
12189
  }
11163
12190
  /**
@@ -11226,6 +12253,13 @@ export interface PriceInterval {
11226
12253
  * this price interval.
11227
12254
  */
11228
12255
  usage_customer_ids: Array<string> | null;
12256
+ /**
12257
+ * Override values for parameterized billable metric variables. Keys are parameter
12258
+ * names, values are the override values.
12259
+ */
12260
+ metric_parameter_overrides?: {
12261
+ [key: string]: unknown;
12262
+ } | null;
11229
12263
  }
11230
12264
  export interface SubLineItemGrouping {
11231
12265
  key: string;