orb-billing 6.14.0 → 6.16.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 (88) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/package.json +1 -1
  3. package/resources/beta/beta.d.mts +276 -2
  4. package/resources/beta/beta.d.mts.map +1 -1
  5. package/resources/beta/beta.d.ts +276 -2
  6. package/resources/beta/beta.d.ts.map +1 -1
  7. package/resources/beta/beta.js.map +1 -1
  8. package/resources/beta/beta.mjs.map +1 -1
  9. package/resources/beta/external-plan-id.d.mts +276 -2
  10. package/resources/beta/external-plan-id.d.mts.map +1 -1
  11. package/resources/beta/external-plan-id.d.ts +276 -2
  12. package/resources/beta/external-plan-id.d.ts.map +1 -1
  13. package/resources/customers/credits/top-ups.d.mts +14 -2
  14. package/resources/customers/credits/top-ups.d.mts.map +1 -1
  15. package/resources/customers/credits/top-ups.d.ts +14 -2
  16. package/resources/customers/credits/top-ups.d.ts.map +1 -1
  17. package/resources/customers/credits/top-ups.js +14 -2
  18. package/resources/customers/credits/top-ups.js.map +1 -1
  19. package/resources/customers/credits/top-ups.mjs +14 -2
  20. package/resources/customers/credits/top-ups.mjs.map +1 -1
  21. package/resources/dimensional-price-groups/dimensional-price-groups.d.mts +11 -2
  22. package/resources/dimensional-price-groups/dimensional-price-groups.d.mts.map +1 -1
  23. package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +11 -2
  24. package/resources/dimensional-price-groups/dimensional-price-groups.d.ts.map +1 -1
  25. package/resources/dimensional-price-groups/dimensional-price-groups.js +11 -2
  26. package/resources/dimensional-price-groups/dimensional-price-groups.js.map +1 -1
  27. package/resources/dimensional-price-groups/dimensional-price-groups.mjs +11 -2
  28. package/resources/dimensional-price-groups/dimensional-price-groups.mjs.map +1 -1
  29. package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.mts +4 -1
  30. package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.mts.map +1 -1
  31. package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts +4 -1
  32. package/resources/dimensional-price-groups/external-dimensional-price-group-id.d.ts.map +1 -1
  33. package/resources/dimensional-price-groups/external-dimensional-price-group-id.js +4 -1
  34. package/resources/dimensional-price-groups/external-dimensional-price-group-id.js.map +1 -1
  35. package/resources/dimensional-price-groups/external-dimensional-price-group-id.mjs +4 -1
  36. package/resources/dimensional-price-groups/external-dimensional-price-group-id.mjs.map +1 -1
  37. package/resources/items.d.mts +3 -1
  38. package/resources/items.d.mts.map +1 -1
  39. package/resources/items.d.ts +3 -1
  40. package/resources/items.d.ts.map +1 -1
  41. package/resources/items.js +3 -1
  42. package/resources/items.js.map +1 -1
  43. package/resources/items.mjs +3 -1
  44. package/resources/items.mjs.map +1 -1
  45. package/resources/plans/migrations.d.mts +3 -1
  46. package/resources/plans/migrations.d.mts.map +1 -1
  47. package/resources/plans/migrations.d.ts +3 -1
  48. package/resources/plans/migrations.d.ts.map +1 -1
  49. package/resources/plans/migrations.js +3 -1
  50. package/resources/plans/migrations.js.map +1 -1
  51. package/resources/plans/migrations.mjs +3 -1
  52. package/resources/plans/migrations.mjs.map +1 -1
  53. package/resources/plans/plans.d.mts +138 -1
  54. package/resources/plans/plans.d.mts.map +1 -1
  55. package/resources/plans/plans.d.ts +138 -1
  56. package/resources/plans/plans.d.ts.map +1 -1
  57. package/resources/plans/plans.js.map +1 -1
  58. package/resources/plans/plans.mjs.map +1 -1
  59. package/resources/prices/prices.d.mts +396 -3
  60. package/resources/prices/prices.d.mts.map +1 -1
  61. package/resources/prices/prices.d.ts +396 -3
  62. package/resources/prices/prices.d.ts.map +1 -1
  63. package/resources/prices/prices.js.map +1 -1
  64. package/resources/prices/prices.mjs.map +1 -1
  65. package/resources/shared.d.mts +153 -1
  66. package/resources/shared.d.mts.map +1 -1
  67. package/resources/shared.d.ts +153 -1
  68. package/resources/shared.d.ts.map +1 -1
  69. package/resources/subscriptions.d.mts +702 -23
  70. package/resources/subscriptions.d.mts.map +1 -1
  71. package/resources/subscriptions.d.ts +702 -23
  72. package/resources/subscriptions.d.ts.map +1 -1
  73. package/src/resources/beta/beta.ts +324 -0
  74. package/src/resources/beta/external-plan-id.ts +324 -0
  75. package/src/resources/customers/credits/top-ups.ts +14 -2
  76. package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +11 -2
  77. package/src/resources/dimensional-price-groups/external-dimensional-price-group-id.ts +4 -1
  78. package/src/resources/items.ts +3 -1
  79. package/src/resources/plans/migrations.ts +3 -1
  80. package/src/resources/plans/plans.ts +162 -0
  81. package/src/resources/prices/prices.ts +465 -0
  82. package/src/resources/shared.ts +194 -0
  83. package/src/resources/subscriptions.ts +931 -128
  84. package/src/version.ts +1 -1
  85. package/version.d.mts +1 -1
  86. package/version.d.ts +1 -1
  87. package/version.js +1 -1
  88. package/version.mjs +1 -1
@@ -253,7 +253,7 @@ export declare namespace PriceEvaluatePreviewEventsResponse {
253
253
  price_id?: string | null;
254
254
  }
255
255
  }
256
- export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingBulkWithFiltersPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingGroupedTieredMatrixPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingMatrixWithThresholdDiscountsPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice | PriceCreateParams.NewFloatingCumulativeGroupedAllocationPrice | PriceCreateParams.NewFloatingDailyCreditAllowancePrice | PriceCreateParams.NewFloatingMeteredAllowancePrice | PriceCreateParams.NewFloatingMinimumCompositePrice | PriceCreateParams.NewFloatingPercentCompositePrice | PriceCreateParams.NewFloatingEventOutputPrice;
256
+ export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingBulkWithFiltersPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingGroupedTieredMatrixPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredMatrixWithAllocationPrice | PriceCreateParams.NewFloatingMatrixWithThresholdDiscountsPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice | PriceCreateParams.NewFloatingCumulativeGroupedAllocationPrice | PriceCreateParams.NewFloatingDailyCreditAllowancePrice | PriceCreateParams.NewFloatingMeteredAllowancePrice | PriceCreateParams.NewFloatingMinimumCompositePrice | PriceCreateParams.NewFloatingPercentCompositePrice | PriceCreateParams.NewFloatingEventOutputPrice;
257
257
  export declare namespace PriceCreateParams {
258
258
  interface NewFloatingUnitPrice {
259
259
  /**
@@ -1803,6 +1803,137 @@ export declare namespace PriceCreateParams {
1803
1803
  [key: string]: string | null;
1804
1804
  } | null;
1805
1805
  }
1806
+ interface NewFloatingTieredMatrixWithAllocationPrice {
1807
+ /**
1808
+ * The cadence to bill for this price on.
1809
+ */
1810
+ cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
1811
+ /**
1812
+ * An ISO 4217 currency string for which this price is billed in.
1813
+ */
1814
+ currency: string;
1815
+ /**
1816
+ * The id of the item the price will be associated with.
1817
+ */
1818
+ item_id: string;
1819
+ /**
1820
+ * The pricing model type
1821
+ */
1822
+ model_type: 'tiered_matrix_with_allocation';
1823
+ /**
1824
+ * The name of the price.
1825
+ */
1826
+ name: string;
1827
+ /**
1828
+ * Configuration for tiered_matrix_with_allocation pricing
1829
+ */
1830
+ tiered_matrix_with_allocation_config: NewFloatingTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
1831
+ /**
1832
+ * The id of the billable metric for the price. Only needed if the price is
1833
+ * usage-based.
1834
+ */
1835
+ billable_metric_id?: string | null;
1836
+ /**
1837
+ * If the Price represents a fixed cost, the price will be billed in-advance if
1838
+ * this is true, and in-arrears if this is false.
1839
+ */
1840
+ billed_in_advance?: boolean | null;
1841
+ /**
1842
+ * For custom cadence: specifies the duration of the billing period in days or
1843
+ * months.
1844
+ */
1845
+ billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1846
+ /**
1847
+ * The per unit conversion rate of the price currency to the invoicing currency.
1848
+ */
1849
+ conversion_rate?: number | null;
1850
+ /**
1851
+ * The configuration for the rate of the price currency to the invoicing currency.
1852
+ */
1853
+ conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
1854
+ /**
1855
+ * For dimensional price: specifies a price group and dimension values
1856
+ */
1857
+ dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
1858
+ /**
1859
+ * An alias for the price.
1860
+ */
1861
+ external_price_id?: string | null;
1862
+ /**
1863
+ * If the Price represents a fixed cost, this represents the quantity of units
1864
+ * applied.
1865
+ */
1866
+ fixed_price_quantity?: number | null;
1867
+ /**
1868
+ * The property used to group this price on an invoice
1869
+ */
1870
+ invoice_grouping_key?: string | null;
1871
+ /**
1872
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
1873
+ * If unspecified, a single invoice is produced per billing cycle.
1874
+ */
1875
+ invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1876
+ /**
1877
+ * The ID of the license type to associate with this price. On a usage price this
1878
+ * also marks the price as eligible to draw down from that license type's
1879
+ * allocation; a usage price created without it is billed normally. Usage prices
1880
+ * with a license type must use the `unit` model, and only draw down when their
1881
+ * currency matches the allocation's.
1882
+ */
1883
+ license_type_id?: string | null;
1884
+ /**
1885
+ * User-specified key/value pairs for the resource. Individual keys can be removed
1886
+ * by setting the value to `null`, and the entire metadata mapping can be cleared
1887
+ * by setting `metadata` to `null`.
1888
+ */
1889
+ metadata?: {
1890
+ [key: string]: string | null;
1891
+ } | null;
1892
+ }
1893
+ namespace NewFloatingTieredMatrixWithAllocationPrice {
1894
+ /**
1895
+ * Configuration for tiered_matrix_with_allocation pricing
1896
+ */
1897
+ interface TieredMatrixWithAllocationConfig {
1898
+ /**
1899
+ * Usage allocation, pooled across all matrix cells
1900
+ */
1901
+ allocation: string;
1902
+ /**
1903
+ * Per unit rate for usage whose matrix cell has no configured tiers
1904
+ */
1905
+ default_unit_amount: string;
1906
+ /**
1907
+ * One or two event property values to evaluate matrix cells by
1908
+ */
1909
+ dimensions: Array<string>;
1910
+ /**
1911
+ * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
1912
+ * own rows
1913
+ */
1914
+ tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
1915
+ }
1916
+ namespace TieredMatrixWithAllocationConfig {
1917
+ /**
1918
+ * Configuration for a single tier scoped to one matrix cell
1919
+ */
1920
+ interface Tier {
1921
+ /**
1922
+ * The matrix cell this tier applies to, as one or two dimension values
1923
+ */
1924
+ dimension_values: Array<string>;
1925
+ /**
1926
+ * Exclusive tier starting value. The tier runs up to and including the next bound
1927
+ * configured for the same matrix cell.
1928
+ */
1929
+ tier_lower_bound: string;
1930
+ /**
1931
+ * Per unit amount
1932
+ */
1933
+ unit_amount: string;
1934
+ }
1935
+ }
1936
+ }
1806
1937
  interface NewFloatingMatrixWithThresholdDiscountsPrice {
1807
1938
  /**
1808
1939
  * The cadence to bill for this price on.
@@ -4237,7 +4368,7 @@ export declare namespace PriceEvaluateMultipleParams {
4237
4368
  /**
4238
4369
  * New floating price request body params.
4239
4370
  */
4240
- price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | PriceEvaluation.NewFloatingGroupedTieredMatrixPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice | PriceEvaluation.NewFloatingDailyCreditAllowancePrice | PriceEvaluation.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
4371
+ price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | PriceEvaluation.NewFloatingGroupedTieredMatrixPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | PriceEvaluation.NewFloatingTieredMatrixWithAllocationPrice | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice | PriceEvaluation.NewFloatingDailyCreditAllowancePrice | PriceEvaluation.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
4241
4372
  /**
4242
4373
  * The ID of a price to evaluate that exists in your Orb account.
4243
4374
  */
@@ -4497,6 +4628,137 @@ export declare namespace PriceEvaluateMultipleParams {
4497
4628
  }
4498
4629
  }
4499
4630
  }
4631
+ interface NewFloatingTieredMatrixWithAllocationPrice {
4632
+ /**
4633
+ * The cadence to bill for this price on.
4634
+ */
4635
+ cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
4636
+ /**
4637
+ * An ISO 4217 currency string for which this price is billed in.
4638
+ */
4639
+ currency: string;
4640
+ /**
4641
+ * The id of the item the price will be associated with.
4642
+ */
4643
+ item_id: string;
4644
+ /**
4645
+ * The pricing model type
4646
+ */
4647
+ model_type: 'tiered_matrix_with_allocation';
4648
+ /**
4649
+ * The name of the price.
4650
+ */
4651
+ name: string;
4652
+ /**
4653
+ * Configuration for tiered_matrix_with_allocation pricing
4654
+ */
4655
+ tiered_matrix_with_allocation_config: NewFloatingTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
4656
+ /**
4657
+ * The id of the billable metric for the price. Only needed if the price is
4658
+ * usage-based.
4659
+ */
4660
+ billable_metric_id?: string | null;
4661
+ /**
4662
+ * If the Price represents a fixed cost, the price will be billed in-advance if
4663
+ * this is true, and in-arrears if this is false.
4664
+ */
4665
+ billed_in_advance?: boolean | null;
4666
+ /**
4667
+ * For custom cadence: specifies the duration of the billing period in days or
4668
+ * months.
4669
+ */
4670
+ billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
4671
+ /**
4672
+ * The per unit conversion rate of the price currency to the invoicing currency.
4673
+ */
4674
+ conversion_rate?: number | null;
4675
+ /**
4676
+ * The configuration for the rate of the price currency to the invoicing currency.
4677
+ */
4678
+ conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
4679
+ /**
4680
+ * For dimensional price: specifies a price group and dimension values
4681
+ */
4682
+ dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
4683
+ /**
4684
+ * An alias for the price.
4685
+ */
4686
+ external_price_id?: string | null;
4687
+ /**
4688
+ * If the Price represents a fixed cost, this represents the quantity of units
4689
+ * applied.
4690
+ */
4691
+ fixed_price_quantity?: number | null;
4692
+ /**
4693
+ * The property used to group this price on an invoice
4694
+ */
4695
+ invoice_grouping_key?: string | null;
4696
+ /**
4697
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
4698
+ * If unspecified, a single invoice is produced per billing cycle.
4699
+ */
4700
+ invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
4701
+ /**
4702
+ * The ID of the license type to associate with this price. On a usage price this
4703
+ * also marks the price as eligible to draw down from that license type's
4704
+ * allocation; a usage price created without it is billed normally. Usage prices
4705
+ * with a license type must use the `unit` model, and only draw down when their
4706
+ * currency matches the allocation's.
4707
+ */
4708
+ license_type_id?: string | null;
4709
+ /**
4710
+ * User-specified key/value pairs for the resource. Individual keys can be removed
4711
+ * by setting the value to `null`, and the entire metadata mapping can be cleared
4712
+ * by setting `metadata` to `null`.
4713
+ */
4714
+ metadata?: {
4715
+ [key: string]: string | null;
4716
+ } | null;
4717
+ }
4718
+ namespace NewFloatingTieredMatrixWithAllocationPrice {
4719
+ /**
4720
+ * Configuration for tiered_matrix_with_allocation pricing
4721
+ */
4722
+ interface TieredMatrixWithAllocationConfig {
4723
+ /**
4724
+ * Usage allocation, pooled across all matrix cells
4725
+ */
4726
+ allocation: string;
4727
+ /**
4728
+ * Per unit rate for usage whose matrix cell has no configured tiers
4729
+ */
4730
+ default_unit_amount: string;
4731
+ /**
4732
+ * One or two event property values to evaluate matrix cells by
4733
+ */
4734
+ dimensions: Array<string>;
4735
+ /**
4736
+ * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
4737
+ * own rows
4738
+ */
4739
+ tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
4740
+ }
4741
+ namespace TieredMatrixWithAllocationConfig {
4742
+ /**
4743
+ * Configuration for a single tier scoped to one matrix cell
4744
+ */
4745
+ interface Tier {
4746
+ /**
4747
+ * The matrix cell this tier applies to, as one or two dimension values
4748
+ */
4749
+ dimension_values: Array<string>;
4750
+ /**
4751
+ * Exclusive tier starting value. The tier runs up to and including the next bound
4752
+ * configured for the same matrix cell.
4753
+ */
4754
+ tier_lower_bound: string;
4755
+ /**
4756
+ * Per unit amount
4757
+ */
4758
+ unit_amount: string;
4759
+ }
4760
+ }
4761
+ }
4500
4762
  interface NewFloatingMatrixWithThresholdDiscountsPrice {
4501
4763
  /**
4502
4764
  * The cadence to bill for this price on.
@@ -5415,7 +5677,7 @@ export declare namespace PriceEvaluatePreviewEventsParams {
5415
5677
  /**
5416
5678
  * New floating price request body params.
5417
5679
  */
5418
- price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | PriceEvaluation.NewFloatingGroupedTieredMatrixPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice | PriceEvaluation.NewFloatingDailyCreditAllowancePrice | PriceEvaluation.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
5680
+ price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | PriceEvaluation.NewFloatingGroupedTieredMatrixPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | PriceEvaluation.NewFloatingTieredMatrixWithAllocationPrice | PriceEvaluation.NewFloatingMatrixWithThresholdDiscountsPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice | PriceEvaluation.NewFloatingDailyCreditAllowancePrice | PriceEvaluation.NewFloatingMeteredAllowancePrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
5419
5681
  /**
5420
5682
  * The ID of a price to evaluate that exists in your Orb account.
5421
5683
  */
@@ -5675,6 +5937,137 @@ export declare namespace PriceEvaluatePreviewEventsParams {
5675
5937
  }
5676
5938
  }
5677
5939
  }
5940
+ interface NewFloatingTieredMatrixWithAllocationPrice {
5941
+ /**
5942
+ * The cadence to bill for this price on.
5943
+ */
5944
+ cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
5945
+ /**
5946
+ * An ISO 4217 currency string for which this price is billed in.
5947
+ */
5948
+ currency: string;
5949
+ /**
5950
+ * The id of the item the price will be associated with.
5951
+ */
5952
+ item_id: string;
5953
+ /**
5954
+ * The pricing model type
5955
+ */
5956
+ model_type: 'tiered_matrix_with_allocation';
5957
+ /**
5958
+ * The name of the price.
5959
+ */
5960
+ name: string;
5961
+ /**
5962
+ * Configuration for tiered_matrix_with_allocation pricing
5963
+ */
5964
+ tiered_matrix_with_allocation_config: NewFloatingTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
5965
+ /**
5966
+ * The id of the billable metric for the price. Only needed if the price is
5967
+ * usage-based.
5968
+ */
5969
+ billable_metric_id?: string | null;
5970
+ /**
5971
+ * If the Price represents a fixed cost, the price will be billed in-advance if
5972
+ * this is true, and in-arrears if this is false.
5973
+ */
5974
+ billed_in_advance?: boolean | null;
5975
+ /**
5976
+ * For custom cadence: specifies the duration of the billing period in days or
5977
+ * months.
5978
+ */
5979
+ billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
5980
+ /**
5981
+ * The per unit conversion rate of the price currency to the invoicing currency.
5982
+ */
5983
+ conversion_rate?: number | null;
5984
+ /**
5985
+ * The configuration for the rate of the price currency to the invoicing currency.
5986
+ */
5987
+ conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
5988
+ /**
5989
+ * For dimensional price: specifies a price group and dimension values
5990
+ */
5991
+ dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
5992
+ /**
5993
+ * An alias for the price.
5994
+ */
5995
+ external_price_id?: string | null;
5996
+ /**
5997
+ * If the Price represents a fixed cost, this represents the quantity of units
5998
+ * applied.
5999
+ */
6000
+ fixed_price_quantity?: number | null;
6001
+ /**
6002
+ * The property used to group this price on an invoice
6003
+ */
6004
+ invoice_grouping_key?: string | null;
6005
+ /**
6006
+ * Within each billing cycle, specifies the cadence at which invoices are produced.
6007
+ * If unspecified, a single invoice is produced per billing cycle.
6008
+ */
6009
+ invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
6010
+ /**
6011
+ * The ID of the license type to associate with this price. On a usage price this
6012
+ * also marks the price as eligible to draw down from that license type's
6013
+ * allocation; a usage price created without it is billed normally. Usage prices
6014
+ * with a license type must use the `unit` model, and only draw down when their
6015
+ * currency matches the allocation's.
6016
+ */
6017
+ license_type_id?: string | null;
6018
+ /**
6019
+ * User-specified key/value pairs for the resource. Individual keys can be removed
6020
+ * by setting the value to `null`, and the entire metadata mapping can be cleared
6021
+ * by setting `metadata` to `null`.
6022
+ */
6023
+ metadata?: {
6024
+ [key: string]: string | null;
6025
+ } | null;
6026
+ }
6027
+ namespace NewFloatingTieredMatrixWithAllocationPrice {
6028
+ /**
6029
+ * Configuration for tiered_matrix_with_allocation pricing
6030
+ */
6031
+ interface TieredMatrixWithAllocationConfig {
6032
+ /**
6033
+ * Usage allocation, pooled across all matrix cells
6034
+ */
6035
+ allocation: string;
6036
+ /**
6037
+ * Per unit rate for usage whose matrix cell has no configured tiers
6038
+ */
6039
+ default_unit_amount: string;
6040
+ /**
6041
+ * One or two event property values to evaluate matrix cells by
6042
+ */
6043
+ dimensions: Array<string>;
6044
+ /**
6045
+ * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
6046
+ * own rows
6047
+ */
6048
+ tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
6049
+ }
6050
+ namespace TieredMatrixWithAllocationConfig {
6051
+ /**
6052
+ * Configuration for a single tier scoped to one matrix cell
6053
+ */
6054
+ interface Tier {
6055
+ /**
6056
+ * The matrix cell this tier applies to, as one or two dimension values
6057
+ */
6058
+ dimension_values: Array<string>;
6059
+ /**
6060
+ * Exclusive tier starting value. The tier runs up to and including the next bound
6061
+ * configured for the same matrix cell.
6062
+ */
6063
+ tier_lower_bound: string;
6064
+ /**
6065
+ * Per unit amount
6066
+ */
6067
+ unit_amount: string;
6068
+ }
6069
+ }
6070
+ }
5678
6071
  interface NewFloatingMatrixWithThresholdDiscountsPrice {
5679
6072
  /**
5680
6073
  * The cadence to bill for this price on.