orb-billing 1.30.0 → 1.32.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +1 -1
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +566 -6
- data/lib/orb/models/beta_create_plan_version_params.rb +566 -6
- data/lib/orb/models/changed_subscription_resources.rb +3 -2
- data/lib/orb/models/customers/balance_transaction_create_response.rb +1 -0
- data/lib/orb/models/customers/balance_transaction_list_response.rb +1 -0
- data/lib/orb/models/invoice.rb +3 -2
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +3 -2
- data/lib/orb/models/invoice_issue_summary_response.rb +1 -0
- data/lib/orb/models/invoice_line_item_create_response.rb +2 -2
- data/lib/orb/models/invoice_list_summary_response.rb +1 -0
- data/lib/orb/models/per_price_cost.rb +2 -2
- data/lib/orb/models/plan.rb +2 -2
- data/lib/orb/models/plan_create_params.rb +278 -3
- data/lib/orb/models/plan_version.rb +2 -2
- data/lib/orb/models/price.rb +450 -1
- data/lib/orb/models/price_create_params.rb +263 -3
- data/lib/orb/models/price_evaluate_multiple_params.rb +273 -3
- data/lib/orb/models/price_evaluate_preview_events_params.rb +273 -3
- data/lib/orb/models/price_interval.rb +2 -2
- data/lib/orb/models/subscription_create_params.rb +566 -6
- data/lib/orb/models/subscription_price_intervals_params.rb +273 -3
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +566 -6
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +5 -5
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +2737 -1811
- data/rbi/orb/models/beta_create_plan_version_params.rbi +2745 -1819
- data/rbi/orb/models/changed_subscription_resources.rbi +6 -0
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +5 -0
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +5 -0
- data/rbi/orb/models/invoice.rbi +6 -0
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +6 -0
- data/rbi/orb/models/invoice_issue_summary_response.rbi +5 -0
- data/rbi/orb/models/invoice_line_item_create_response.rbi +1 -0
- data/rbi/orb/models/invoice_list_summary_response.rbi +5 -0
- data/rbi/orb/models/per_price_cost.rbi +1 -0
- data/rbi/orb/models/plan.rbi +1 -0
- data/rbi/orb/models/plan_create_params.rbi +463 -0
- data/rbi/orb/models/plan_version.rbi +1 -0
- data/rbi/orb/models/price.rbi +805 -0
- data/rbi/orb/models/price_create_params.rbi +451 -0
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +451 -0
- data/rbi/orb/models/price_evaluate_preview_events_params.rbi +451 -0
- data/rbi/orb/models/price_interval.rbi +1 -0
- data/rbi/orb/models/subscription_create_params.rbi +2660 -1734
- data/rbi/orb/models/subscription_price_intervals_params.rbi +451 -0
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +2660 -1734
- data/rbi/orb/resources/prices.rbi +1 -0
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +376 -0
- data/sig/orb/models/beta_create_plan_version_params.rbs +376 -0
- data/sig/orb/models/changed_subscription_resources.rbs +2 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +2 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +2 -0
- data/sig/orb/models/invoice.rbs +2 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -0
- data/sig/orb/models/invoice_issue_summary_response.rbs +2 -0
- data/sig/orb/models/invoice_list_summary_response.rbs +2 -0
- data/sig/orb/models/plan_create_params.rbs +188 -0
- data/sig/orb/models/price.rbs +332 -0
- data/sig/orb/models/price_create_params.rbs +178 -0
- data/sig/orb/models/price_evaluate_multiple_params.rbs +183 -0
- data/sig/orb/models/price_evaluate_preview_events_params.rbs +183 -0
- data/sig/orb/models/subscription_create_params.rbs +376 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +183 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +376 -0
- metadata +1 -1
|
@@ -144,7 +144,7 @@ module Orb
|
|
|
144
144
|
# @!attribute price
|
|
145
145
|
# New floating price request body params.
|
|
146
146
|
#
|
|
147
|
-
# @return [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput, nil]
|
|
147
|
+
# @return [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput, nil]
|
|
148
148
|
optional :price,
|
|
149
149
|
union: -> {
|
|
150
150
|
Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price
|
|
@@ -170,7 +170,7 @@ module Orb
|
|
|
170
170
|
#
|
|
171
171
|
# @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Optional overrides for parameterized billable metric parameters. If the metric h
|
|
172
172
|
#
|
|
173
|
-
# @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput, nil] New floating price request body params.
|
|
173
|
+
# @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput, nil] New floating price request body params.
|
|
174
174
|
#
|
|
175
175
|
# @param price_id [String, nil] The ID of a price to evaluate that exists in your Orb account.
|
|
176
176
|
|
|
@@ -214,6 +214,9 @@ module Orb
|
|
|
214
214
|
|
|
215
215
|
variant :matrix_with_allocation, -> { Orb::NewFloatingMatrixWithAllocationPrice }
|
|
216
216
|
|
|
217
|
+
variant :tiered_matrix_with_allocation,
|
|
218
|
+
-> { Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation }
|
|
219
|
+
|
|
217
220
|
variant :matrix_with_threshold_discounts,
|
|
218
221
|
-> { Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts }
|
|
219
222
|
|
|
@@ -771,6 +774,273 @@ module Orb
|
|
|
771
774
|
end
|
|
772
775
|
end
|
|
773
776
|
|
|
777
|
+
class TieredMatrixWithAllocation < Orb::Internal::Type::BaseModel
|
|
778
|
+
# @!attribute cadence
|
|
779
|
+
# The cadence to bill for this price on.
|
|
780
|
+
#
|
|
781
|
+
# @return [Symbol, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::Cadence]
|
|
782
|
+
required :cadence,
|
|
783
|
+
enum: -> { Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::Cadence }
|
|
784
|
+
|
|
785
|
+
# @!attribute currency
|
|
786
|
+
# An ISO 4217 currency string for which this price is billed in.
|
|
787
|
+
#
|
|
788
|
+
# @return [String]
|
|
789
|
+
required :currency, String
|
|
790
|
+
|
|
791
|
+
# @!attribute item_id
|
|
792
|
+
# The id of the item the price will be associated with.
|
|
793
|
+
#
|
|
794
|
+
# @return [String]
|
|
795
|
+
required :item_id, String
|
|
796
|
+
|
|
797
|
+
# @!attribute model_type
|
|
798
|
+
# The pricing model type
|
|
799
|
+
#
|
|
800
|
+
# @return [Symbol, :tiered_matrix_with_allocation]
|
|
801
|
+
required :model_type, const: :tiered_matrix_with_allocation
|
|
802
|
+
|
|
803
|
+
# @!attribute name
|
|
804
|
+
# The name of the price.
|
|
805
|
+
#
|
|
806
|
+
# @return [String]
|
|
807
|
+
required :name, String
|
|
808
|
+
|
|
809
|
+
# @!attribute tiered_matrix_with_allocation_config
|
|
810
|
+
# Configuration for tiered_matrix_with_allocation pricing
|
|
811
|
+
#
|
|
812
|
+
# @return [Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig]
|
|
813
|
+
required :tiered_matrix_with_allocation_config,
|
|
814
|
+
-> { Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig }
|
|
815
|
+
|
|
816
|
+
# @!attribute billable_metric_id
|
|
817
|
+
# The id of the billable metric for the price. Only needed if the price is
|
|
818
|
+
# usage-based.
|
|
819
|
+
#
|
|
820
|
+
# @return [String, nil]
|
|
821
|
+
optional :billable_metric_id, String, nil?: true
|
|
822
|
+
|
|
823
|
+
# @!attribute billed_in_advance
|
|
824
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
|
825
|
+
# this is true, and in-arrears if this is false.
|
|
826
|
+
#
|
|
827
|
+
# @return [Boolean, nil]
|
|
828
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
|
829
|
+
|
|
830
|
+
# @!attribute billing_cycle_configuration
|
|
831
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
|
832
|
+
# months.
|
|
833
|
+
#
|
|
834
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
835
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
836
|
+
|
|
837
|
+
# @!attribute conversion_rate
|
|
838
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
|
839
|
+
#
|
|
840
|
+
# @return [Float, nil]
|
|
841
|
+
optional :conversion_rate, Float, nil?: true
|
|
842
|
+
|
|
843
|
+
# @!attribute conversion_rate_config
|
|
844
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
|
845
|
+
#
|
|
846
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
|
847
|
+
optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
|
|
848
|
+
|
|
849
|
+
# @!attribute dimensional_price_configuration
|
|
850
|
+
# For dimensional price: specifies a price group and dimension values
|
|
851
|
+
#
|
|
852
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
|
853
|
+
optional :dimensional_price_configuration,
|
|
854
|
+
-> {
|
|
855
|
+
Orb::NewDimensionalPriceConfiguration
|
|
856
|
+
},
|
|
857
|
+
nil?: true
|
|
858
|
+
|
|
859
|
+
# @!attribute external_price_id
|
|
860
|
+
# An alias for the price.
|
|
861
|
+
#
|
|
862
|
+
# @return [String, nil]
|
|
863
|
+
optional :external_price_id, String, nil?: true
|
|
864
|
+
|
|
865
|
+
# @!attribute fixed_price_quantity
|
|
866
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
|
867
|
+
# applied.
|
|
868
|
+
#
|
|
869
|
+
# @return [Float, nil]
|
|
870
|
+
optional :fixed_price_quantity, Float, nil?: true
|
|
871
|
+
|
|
872
|
+
# @!attribute invoice_grouping_key
|
|
873
|
+
# The property used to group this price on an invoice
|
|
874
|
+
#
|
|
875
|
+
# @return [String, nil]
|
|
876
|
+
optional :invoice_grouping_key, String, nil?: true
|
|
877
|
+
|
|
878
|
+
# @!attribute invoicing_cycle_configuration
|
|
879
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
880
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
|
881
|
+
#
|
|
882
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
883
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
884
|
+
|
|
885
|
+
# @!attribute license_type_id
|
|
886
|
+
# The ID of the license type to associate with this price. On a usage price this
|
|
887
|
+
# also marks the price as eligible to draw down from that license type's
|
|
888
|
+
# allocation; a usage price created without it is billed normally. Usage prices
|
|
889
|
+
# with a license type must use the `unit` model, and only draw down when their
|
|
890
|
+
# currency matches the allocation's.
|
|
891
|
+
#
|
|
892
|
+
# @return [String, nil]
|
|
893
|
+
optional :license_type_id, String, nil?: true
|
|
894
|
+
|
|
895
|
+
# @!attribute metadata
|
|
896
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
897
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
898
|
+
# by setting `metadata` to `null`.
|
|
899
|
+
#
|
|
900
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
|
901
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
902
|
+
|
|
903
|
+
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_matrix_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, model_type: :tiered_matrix_with_allocation)
|
|
904
|
+
# Some parameter documentations has been truncated, see
|
|
905
|
+
# {Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation}
|
|
906
|
+
# for more details.
|
|
907
|
+
#
|
|
908
|
+
# @param cadence [Symbol, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::Cadence] The cadence to bill for this price on.
|
|
909
|
+
#
|
|
910
|
+
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
|
911
|
+
#
|
|
912
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
|
913
|
+
#
|
|
914
|
+
# @param name [String] The name of the price.
|
|
915
|
+
#
|
|
916
|
+
# @param tiered_matrix_with_allocation_config [Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig] Configuration for tiered_matrix_with_allocation pricing
|
|
917
|
+
#
|
|
918
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
|
919
|
+
#
|
|
920
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
|
921
|
+
#
|
|
922
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
|
923
|
+
#
|
|
924
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
|
925
|
+
#
|
|
926
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
|
927
|
+
#
|
|
928
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
|
929
|
+
#
|
|
930
|
+
# @param external_price_id [String, nil] An alias for the price.
|
|
931
|
+
#
|
|
932
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
|
933
|
+
#
|
|
934
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
|
935
|
+
#
|
|
936
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
937
|
+
#
|
|
938
|
+
# @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
|
|
939
|
+
#
|
|
940
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
941
|
+
#
|
|
942
|
+
# @param model_type [Symbol, :tiered_matrix_with_allocation] The pricing model type
|
|
943
|
+
|
|
944
|
+
# The cadence to bill for this price on.
|
|
945
|
+
#
|
|
946
|
+
# @see Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation#cadence
|
|
947
|
+
module Cadence
|
|
948
|
+
extend Orb::Internal::Type::Enum
|
|
949
|
+
|
|
950
|
+
ANNUAL = :annual
|
|
951
|
+
SEMI_ANNUAL = :semi_annual
|
|
952
|
+
MONTHLY = :monthly
|
|
953
|
+
QUARTERLY = :quarterly
|
|
954
|
+
ONE_TIME = :one_time
|
|
955
|
+
CUSTOM = :custom
|
|
956
|
+
|
|
957
|
+
# @!method self.values
|
|
958
|
+
# @return [Array<Symbol>]
|
|
959
|
+
end
|
|
960
|
+
|
|
961
|
+
# @see Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation#tiered_matrix_with_allocation_config
|
|
962
|
+
class TieredMatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
|
|
963
|
+
# @!attribute allocation
|
|
964
|
+
# Usage allocation, pooled across all matrix cells
|
|
965
|
+
#
|
|
966
|
+
# @return [String]
|
|
967
|
+
required :allocation, String
|
|
968
|
+
|
|
969
|
+
# @!attribute default_unit_amount
|
|
970
|
+
# Per unit rate for usage whose matrix cell has no configured tiers
|
|
971
|
+
#
|
|
972
|
+
# @return [String]
|
|
973
|
+
required :default_unit_amount, String
|
|
974
|
+
|
|
975
|
+
# @!attribute dimensions
|
|
976
|
+
# One or two event property values to evaluate matrix cells by
|
|
977
|
+
#
|
|
978
|
+
# @return [Array<String>]
|
|
979
|
+
required :dimensions, Orb::Internal::Type::ArrayOf[String]
|
|
980
|
+
|
|
981
|
+
# @!attribute tiers
|
|
982
|
+
# Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
|
|
983
|
+
# own rows
|
|
984
|
+
#
|
|
985
|
+
# @return [Array<Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier>]
|
|
986
|
+
required :tiers,
|
|
987
|
+
-> do
|
|
988
|
+
Orb::Internal::Type::ArrayOf[
|
|
989
|
+
Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier
|
|
990
|
+
]
|
|
991
|
+
end
|
|
992
|
+
|
|
993
|
+
# @!method initialize(allocation:, default_unit_amount:, dimensions:, tiers:)
|
|
994
|
+
# Some parameter documentations has been truncated, see
|
|
995
|
+
# {Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig}
|
|
996
|
+
# for more details.
|
|
997
|
+
#
|
|
998
|
+
# Configuration for tiered_matrix_with_allocation pricing
|
|
999
|
+
#
|
|
1000
|
+
# @param allocation [String] Usage allocation, pooled across all matrix cells
|
|
1001
|
+
#
|
|
1002
|
+
# @param default_unit_amount [String] Per unit rate for usage whose matrix cell has no configured tiers
|
|
1003
|
+
#
|
|
1004
|
+
# @param dimensions [Array<String>] One or two event property values to evaluate matrix cells by
|
|
1005
|
+
#
|
|
1006
|
+
# @param tiers [Array<Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier>] Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
|
|
1007
|
+
|
|
1008
|
+
class Tier < Orb::Internal::Type::BaseModel
|
|
1009
|
+
# @!attribute dimension_values
|
|
1010
|
+
# The matrix cell this tier applies to, as one or two dimension values
|
|
1011
|
+
#
|
|
1012
|
+
# @return [Array<String>]
|
|
1013
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
|
1014
|
+
|
|
1015
|
+
# @!attribute tier_lower_bound
|
|
1016
|
+
# Exclusive tier starting value. The tier runs up to and including the next bound
|
|
1017
|
+
# configured for the same matrix cell.
|
|
1018
|
+
#
|
|
1019
|
+
# @return [String]
|
|
1020
|
+
required :tier_lower_bound, String
|
|
1021
|
+
|
|
1022
|
+
# @!attribute unit_amount
|
|
1023
|
+
# Per unit amount
|
|
1024
|
+
#
|
|
1025
|
+
# @return [String]
|
|
1026
|
+
required :unit_amount, String
|
|
1027
|
+
|
|
1028
|
+
# @!method initialize(dimension_values:, tier_lower_bound:, unit_amount:)
|
|
1029
|
+
# Some parameter documentations has been truncated, see
|
|
1030
|
+
# {Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier}
|
|
1031
|
+
# for more details.
|
|
1032
|
+
#
|
|
1033
|
+
# Configuration for a single tier scoped to one matrix cell
|
|
1034
|
+
#
|
|
1035
|
+
# @param dimension_values [Array<String>] The matrix cell this tier applies to, as one or two dimension values
|
|
1036
|
+
#
|
|
1037
|
+
# @param tier_lower_bound [String] Exclusive tier starting value. The tier runs up to and including the next bound
|
|
1038
|
+
#
|
|
1039
|
+
# @param unit_amount [String] Per unit amount
|
|
1040
|
+
end
|
|
1041
|
+
end
|
|
1042
|
+
end
|
|
1043
|
+
|
|
774
1044
|
class MatrixWithThresholdDiscounts < Orb::Internal::Type::BaseModel
|
|
775
1045
|
# @!attribute cadence
|
|
776
1046
|
# The cadence to bill for this price on.
|
|
@@ -2497,7 +2767,7 @@ module Orb
|
|
|
2497
2767
|
end
|
|
2498
2768
|
|
|
2499
2769
|
# @!method self.variants
|
|
2500
|
-
# @return [Array(Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput)]
|
|
2770
|
+
# @return [Array(Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::TieredMatrixWithAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput)]
|
|
2501
2771
|
end
|
|
2502
2772
|
end
|
|
2503
2773
|
end
|
|
@@ -72,7 +72,7 @@ module Orb
|
|
|
72
72
|
# For more on the types of prices, see
|
|
73
73
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
74
74
|
#
|
|
75
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
75
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
76
76
|
required :price, union: -> { Orb::Price }
|
|
77
77
|
|
|
78
78
|
# @!attribute start_date
|
|
@@ -122,7 +122,7 @@ module Orb
|
|
|
122
122
|
#
|
|
123
123
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
|
124
124
|
#
|
|
125
|
-
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
|
|
125
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
|
|
126
126
|
#
|
|
127
127
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
|
128
128
|
#
|