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
|
@@ -748,6 +748,7 @@ module Orb
|
|
|
748
748
|
OVERPAYMENT_REFUND = :overpayment_refund
|
|
749
749
|
EXTERNAL_PAYMENT = :external_payment
|
|
750
750
|
SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
|
|
751
|
+
PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
|
|
751
752
|
|
|
752
753
|
# @!method self.values
|
|
753
754
|
# @return [Array<Symbol>]
|
|
@@ -857,7 +858,7 @@ module Orb
|
|
|
857
858
|
# For more on the types of prices, see
|
|
858
859
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
859
860
|
#
|
|
860
|
-
# @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]
|
|
861
|
+
# @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]
|
|
861
862
|
required :price, union: -> { Orb::Price }
|
|
862
863
|
|
|
863
864
|
# @!attribute quantity
|
|
@@ -924,7 +925,7 @@ module Orb
|
|
|
924
925
|
#
|
|
925
926
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
|
926
927
|
#
|
|
927
|
-
# @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
|
|
928
|
+
# @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
|
|
928
929
|
#
|
|
929
930
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
|
930
931
|
#
|
|
@@ -101,6 +101,7 @@ module Orb
|
|
|
101
101
|
OVERPAYMENT_REFUND = :overpayment_refund
|
|
102
102
|
EXTERNAL_PAYMENT = :external_payment
|
|
103
103
|
SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
|
|
104
|
+
PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
|
|
104
105
|
|
|
105
106
|
# @!method self.values
|
|
106
107
|
# @return [Array<Symbol>]
|
|
@@ -101,6 +101,7 @@ module Orb
|
|
|
101
101
|
OVERPAYMENT_REFUND = :overpayment_refund
|
|
102
102
|
EXTERNAL_PAYMENT = :external_payment
|
|
103
103
|
SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
|
|
104
|
+
PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
|
|
104
105
|
|
|
105
106
|
# @!method self.values
|
|
106
107
|
# @return [Array<Symbol>]
|
data/lib/orb/models/invoice.rb
CHANGED
|
@@ -703,6 +703,7 @@ module Orb
|
|
|
703
703
|
OVERPAYMENT_REFUND = :overpayment_refund
|
|
704
704
|
EXTERNAL_PAYMENT = :external_payment
|
|
705
705
|
SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
|
|
706
|
+
PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
|
|
706
707
|
|
|
707
708
|
# @!method self.values
|
|
708
709
|
# @return [Array<Symbol>]
|
|
@@ -811,7 +812,7 @@ module Orb
|
|
|
811
812
|
# For more on the types of prices, see
|
|
812
813
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
813
814
|
#
|
|
814
|
-
# @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]
|
|
815
|
+
# @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]
|
|
815
816
|
required :price, union: -> { Orb::Price }
|
|
816
817
|
|
|
817
818
|
# @!attribute quantity
|
|
@@ -876,7 +877,7 @@ module Orb
|
|
|
876
877
|
#
|
|
877
878
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
|
878
879
|
#
|
|
879
|
-
# @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
|
|
880
|
+
# @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
|
|
880
881
|
#
|
|
881
882
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
|
882
883
|
#
|
|
@@ -703,6 +703,7 @@ module Orb
|
|
|
703
703
|
OVERPAYMENT_REFUND = :overpayment_refund
|
|
704
704
|
EXTERNAL_PAYMENT = :external_payment
|
|
705
705
|
SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
|
|
706
|
+
PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
|
|
706
707
|
|
|
707
708
|
# @!method self.values
|
|
708
709
|
# @return [Array<Symbol>]
|
|
@@ -812,7 +813,7 @@ module Orb
|
|
|
812
813
|
# For more on the types of prices, see
|
|
813
814
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
814
815
|
#
|
|
815
|
-
# @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]
|
|
816
|
+
# @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]
|
|
816
817
|
required :price, union: -> { Orb::Price }
|
|
817
818
|
|
|
818
819
|
# @!attribute quantity
|
|
@@ -878,7 +879,7 @@ module Orb
|
|
|
878
879
|
#
|
|
879
880
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
|
880
881
|
#
|
|
881
|
-
# @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
|
|
882
|
+
# @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
|
|
882
883
|
#
|
|
883
884
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
|
884
885
|
#
|
|
@@ -641,6 +641,7 @@ module Orb
|
|
|
641
641
|
OVERPAYMENT_REFUND = :overpayment_refund
|
|
642
642
|
EXTERNAL_PAYMENT = :external_payment
|
|
643
643
|
SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
|
|
644
|
+
PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
|
|
644
645
|
|
|
645
646
|
# @!method self.values
|
|
646
647
|
# @return [Array<Symbol>]
|
|
@@ -83,7 +83,7 @@ module Orb
|
|
|
83
83
|
# For more on the types of prices, see
|
|
84
84
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
85
85
|
#
|
|
86
|
-
# @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]
|
|
86
|
+
# @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]
|
|
87
87
|
required :price, union: -> { Orb::Price }
|
|
88
88
|
|
|
89
89
|
# @!attribute quantity
|
|
@@ -149,7 +149,7 @@ module Orb
|
|
|
149
149
|
#
|
|
150
150
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
|
151
151
|
#
|
|
152
|
-
# @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
|
|
152
|
+
# @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
|
|
153
153
|
#
|
|
154
154
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
|
155
155
|
#
|
|
@@ -640,6 +640,7 @@ module Orb
|
|
|
640
640
|
OVERPAYMENT_REFUND = :overpayment_refund
|
|
641
641
|
EXTERNAL_PAYMENT = :external_payment
|
|
642
642
|
SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
|
|
643
|
+
PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
|
|
643
644
|
|
|
644
645
|
# @!method self.values
|
|
645
646
|
# @return [Array<Symbol>]
|
|
@@ -6,7 +6,7 @@ module Orb
|
|
|
6
6
|
# @!attribute price
|
|
7
7
|
# The price object
|
|
8
8
|
#
|
|
9
|
-
# @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]
|
|
9
|
+
# @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]
|
|
10
10
|
required :price, union: -> { Orb::Price }
|
|
11
11
|
|
|
12
12
|
# @!attribute price_id
|
|
@@ -34,7 +34,7 @@ module Orb
|
|
|
34
34
|
optional :quantity, Float, nil?: true
|
|
35
35
|
|
|
36
36
|
# @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
|
|
37
|
-
# @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 object
|
|
37
|
+
# @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 object
|
|
38
38
|
#
|
|
39
39
|
# @param price_id [String] The price the cost is associated with
|
|
40
40
|
#
|
data/lib/orb/models/plan.rb
CHANGED
|
@@ -138,7 +138,7 @@ module Orb
|
|
|
138
138
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
|
139
139
|
# phases of the plan.
|
|
140
140
|
#
|
|
141
|
-
# @return [Array<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>]
|
|
141
|
+
# @return [Array<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>]
|
|
142
142
|
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }
|
|
143
143
|
|
|
144
144
|
# @!attribute product
|
|
@@ -208,7 +208,7 @@ module Orb
|
|
|
208
208
|
#
|
|
209
209
|
# @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
|
|
210
210
|
#
|
|
211
|
-
# @param prices [Array<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>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
|
211
|
+
# @param prices [Array<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>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
|
212
212
|
#
|
|
213
213
|
# @param product [Orb::Models::Plan::Product]
|
|
214
214
|
#
|
|
@@ -136,7 +136,7 @@ module Orb
|
|
|
136
136
|
# @!attribute price
|
|
137
137
|
# New plan price request body params.
|
|
138
138
|
#
|
|
139
|
-
# @return [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::PlanCreateParams::Price::Price::MatrixWithThresholdDiscounts, Orb::Models::PlanCreateParams::Price::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::PlanCreateParams::Price::Price::CumulativeGroupedAllocation, Orb::Models::PlanCreateParams::Price::Price::DailyCreditAllowance, Orb::Models::PlanCreateParams::Price::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::PlanCreateParams::Price::Price::Percent, Orb::Models::PlanCreateParams::Price::Price::EventOutput, nil]
|
|
139
|
+
# @return [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation, Orb::Models::PlanCreateParams::Price::Price::MatrixWithThresholdDiscounts, Orb::Models::PlanCreateParams::Price::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::PlanCreateParams::Price::Price::CumulativeGroupedAllocation, Orb::Models::PlanCreateParams::Price::Price::DailyCreditAllowance, Orb::Models::PlanCreateParams::Price::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::PlanCreateParams::Price::Price::Percent, Orb::Models::PlanCreateParams::Price::Price::EventOutput, nil]
|
|
140
140
|
optional :price, union: -> { Orb::PlanCreateParams::Price::Price }, nil?: true
|
|
141
141
|
|
|
142
142
|
# @!method initialize(allocation_price: nil, license_allocation_price: nil, plan_phase_order: nil, price: nil)
|
|
@@ -146,7 +146,7 @@ module Orb
|
|
|
146
146
|
#
|
|
147
147
|
# @param plan_phase_order [Integer, nil] The phase to add this price to.
|
|
148
148
|
#
|
|
149
|
-
# @param price [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::PlanCreateParams::Price::Price::MatrixWithThresholdDiscounts, Orb::Models::PlanCreateParams::Price::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::PlanCreateParams::Price::Price::CumulativeGroupedAllocation, Orb::Models::PlanCreateParams::Price::Price::DailyCreditAllowance, Orb::Models::PlanCreateParams::Price::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::PlanCreateParams::Price::Price::Percent, Orb::Models::PlanCreateParams::Price::Price::EventOutput, nil] New plan price request body params.
|
|
149
|
+
# @param price [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation, Orb::Models::PlanCreateParams::Price::Price::MatrixWithThresholdDiscounts, Orb::Models::PlanCreateParams::Price::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::PlanCreateParams::Price::Price::CumulativeGroupedAllocation, Orb::Models::PlanCreateParams::Price::Price::DailyCreditAllowance, Orb::Models::PlanCreateParams::Price::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::PlanCreateParams::Price::Price::Percent, Orb::Models::PlanCreateParams::Price::Price::EventOutput, nil] New plan price request body params.
|
|
150
150
|
|
|
151
151
|
# @see Orb::Models::PlanCreateParams::Price#license_allocation_price
|
|
152
152
|
class LicenseAllocationPrice < Orb::Internal::Type::BaseModel
|
|
@@ -428,6 +428,9 @@ module Orb
|
|
|
428
428
|
|
|
429
429
|
variant :matrix_with_allocation, -> { Orb::NewPlanMatrixWithAllocationPrice }
|
|
430
430
|
|
|
431
|
+
variant :tiered_matrix_with_allocation,
|
|
432
|
+
-> { Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation }
|
|
433
|
+
|
|
431
434
|
variant :matrix_with_threshold_discounts,
|
|
432
435
|
-> { Orb::PlanCreateParams::Price::Price::MatrixWithThresholdDiscounts }
|
|
433
436
|
|
|
@@ -988,6 +991,278 @@ module Orb
|
|
|
988
991
|
end
|
|
989
992
|
end
|
|
990
993
|
|
|
994
|
+
class TieredMatrixWithAllocation < Orb::Internal::Type::BaseModel
|
|
995
|
+
# @!attribute cadence
|
|
996
|
+
# The cadence to bill for this price on.
|
|
997
|
+
#
|
|
998
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::Cadence]
|
|
999
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::Cadence }
|
|
1000
|
+
|
|
1001
|
+
# @!attribute item_id
|
|
1002
|
+
# The id of the item the price will be associated with.
|
|
1003
|
+
#
|
|
1004
|
+
# @return [String]
|
|
1005
|
+
required :item_id, String
|
|
1006
|
+
|
|
1007
|
+
# @!attribute model_type
|
|
1008
|
+
# The pricing model type
|
|
1009
|
+
#
|
|
1010
|
+
# @return [Symbol, :tiered_matrix_with_allocation]
|
|
1011
|
+
required :model_type, const: :tiered_matrix_with_allocation
|
|
1012
|
+
|
|
1013
|
+
# @!attribute name
|
|
1014
|
+
# The name of the price.
|
|
1015
|
+
#
|
|
1016
|
+
# @return [String]
|
|
1017
|
+
required :name, String
|
|
1018
|
+
|
|
1019
|
+
# @!attribute tiered_matrix_with_allocation_config
|
|
1020
|
+
# Configuration for tiered_matrix_with_allocation pricing
|
|
1021
|
+
#
|
|
1022
|
+
# @return [Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig]
|
|
1023
|
+
required :tiered_matrix_with_allocation_config,
|
|
1024
|
+
-> { Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig }
|
|
1025
|
+
|
|
1026
|
+
# @!attribute billable_metric_id
|
|
1027
|
+
# The id of the billable metric for the price. Only needed if the price is
|
|
1028
|
+
# usage-based.
|
|
1029
|
+
#
|
|
1030
|
+
# @return [String, nil]
|
|
1031
|
+
optional :billable_metric_id, String, nil?: true
|
|
1032
|
+
|
|
1033
|
+
# @!attribute billed_in_advance
|
|
1034
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
|
1035
|
+
# this is true, and in-arrears if this is false.
|
|
1036
|
+
#
|
|
1037
|
+
# @return [Boolean, nil]
|
|
1038
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
|
1039
|
+
|
|
1040
|
+
# @!attribute billing_cycle_configuration
|
|
1041
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
|
1042
|
+
# months.
|
|
1043
|
+
#
|
|
1044
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
1045
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
1046
|
+
|
|
1047
|
+
# @!attribute conversion_rate
|
|
1048
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
|
1049
|
+
#
|
|
1050
|
+
# @return [Float, nil]
|
|
1051
|
+
optional :conversion_rate, Float, nil?: true
|
|
1052
|
+
|
|
1053
|
+
# @!attribute conversion_rate_config
|
|
1054
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
|
1055
|
+
#
|
|
1056
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
|
1057
|
+
optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
|
|
1058
|
+
|
|
1059
|
+
# @!attribute currency
|
|
1060
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
1061
|
+
# price is billed.
|
|
1062
|
+
#
|
|
1063
|
+
# @return [String, nil]
|
|
1064
|
+
optional :currency, String, nil?: true
|
|
1065
|
+
|
|
1066
|
+
# @!attribute dimensional_price_configuration
|
|
1067
|
+
# For dimensional price: specifies a price group and dimension values
|
|
1068
|
+
#
|
|
1069
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
|
1070
|
+
optional :dimensional_price_configuration,
|
|
1071
|
+
-> {
|
|
1072
|
+
Orb::NewDimensionalPriceConfiguration
|
|
1073
|
+
},
|
|
1074
|
+
nil?: true
|
|
1075
|
+
|
|
1076
|
+
# @!attribute external_price_id
|
|
1077
|
+
# An alias for the price.
|
|
1078
|
+
#
|
|
1079
|
+
# @return [String, nil]
|
|
1080
|
+
optional :external_price_id, String, nil?: true
|
|
1081
|
+
|
|
1082
|
+
# @!attribute fixed_price_quantity
|
|
1083
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
|
1084
|
+
# applied.
|
|
1085
|
+
#
|
|
1086
|
+
# @return [Float, nil]
|
|
1087
|
+
optional :fixed_price_quantity, Float, nil?: true
|
|
1088
|
+
|
|
1089
|
+
# @!attribute invoice_grouping_key
|
|
1090
|
+
# The property used to group this price on an invoice
|
|
1091
|
+
#
|
|
1092
|
+
# @return [String, nil]
|
|
1093
|
+
optional :invoice_grouping_key, String, nil?: true
|
|
1094
|
+
|
|
1095
|
+
# @!attribute invoicing_cycle_configuration
|
|
1096
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1097
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
|
1098
|
+
#
|
|
1099
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
1100
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
1101
|
+
|
|
1102
|
+
# @!attribute license_type_id
|
|
1103
|
+
# The ID of the license type to associate with this price. On a usage price this
|
|
1104
|
+
# also marks the price as eligible to draw down from that license type's
|
|
1105
|
+
# allocation; a usage price created without it is billed normally. Usage prices
|
|
1106
|
+
# with a license type must use the `unit` model, and only draw down when their
|
|
1107
|
+
# currency matches the allocation's.
|
|
1108
|
+
#
|
|
1109
|
+
# @return [String, nil]
|
|
1110
|
+
optional :license_type_id, String, nil?: true
|
|
1111
|
+
|
|
1112
|
+
# @!attribute metadata
|
|
1113
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1114
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
1115
|
+
# by setting `metadata` to `null`.
|
|
1116
|
+
#
|
|
1117
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
|
1118
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
1119
|
+
|
|
1120
|
+
# @!attribute reference_id
|
|
1121
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
|
1122
|
+
# in the same API call.
|
|
1123
|
+
#
|
|
1124
|
+
# @return [String, nil]
|
|
1125
|
+
optional :reference_id, String, nil?: true
|
|
1126
|
+
|
|
1127
|
+
# @!method initialize(cadence:, 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, currency: 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, reference_id: nil, model_type: :tiered_matrix_with_allocation)
|
|
1128
|
+
# Some parameter documentations has been truncated, see
|
|
1129
|
+
# {Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation} for
|
|
1130
|
+
# more details.
|
|
1131
|
+
#
|
|
1132
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::Cadence] The cadence to bill for this price on.
|
|
1133
|
+
#
|
|
1134
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
|
1135
|
+
#
|
|
1136
|
+
# @param name [String] The name of the price.
|
|
1137
|
+
#
|
|
1138
|
+
# @param tiered_matrix_with_allocation_config [Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig] Configuration for tiered_matrix_with_allocation pricing
|
|
1139
|
+
#
|
|
1140
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
|
1141
|
+
#
|
|
1142
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
|
1143
|
+
#
|
|
1144
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
|
1145
|
+
#
|
|
1146
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
|
1147
|
+
#
|
|
1148
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
|
1149
|
+
#
|
|
1150
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
|
1151
|
+
#
|
|
1152
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
|
1153
|
+
#
|
|
1154
|
+
# @param external_price_id [String, nil] An alias for the price.
|
|
1155
|
+
#
|
|
1156
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
|
1157
|
+
#
|
|
1158
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
|
1159
|
+
#
|
|
1160
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
1161
|
+
#
|
|
1162
|
+
# @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
|
|
1163
|
+
#
|
|
1164
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
1165
|
+
#
|
|
1166
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
|
1167
|
+
#
|
|
1168
|
+
# @param model_type [Symbol, :tiered_matrix_with_allocation] The pricing model type
|
|
1169
|
+
|
|
1170
|
+
# The cadence to bill for this price on.
|
|
1171
|
+
#
|
|
1172
|
+
# @see Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation#cadence
|
|
1173
|
+
module Cadence
|
|
1174
|
+
extend Orb::Internal::Type::Enum
|
|
1175
|
+
|
|
1176
|
+
ANNUAL = :annual
|
|
1177
|
+
SEMI_ANNUAL = :semi_annual
|
|
1178
|
+
MONTHLY = :monthly
|
|
1179
|
+
QUARTERLY = :quarterly
|
|
1180
|
+
ONE_TIME = :one_time
|
|
1181
|
+
CUSTOM = :custom
|
|
1182
|
+
|
|
1183
|
+
# @!method self.values
|
|
1184
|
+
# @return [Array<Symbol>]
|
|
1185
|
+
end
|
|
1186
|
+
|
|
1187
|
+
# @see Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation#tiered_matrix_with_allocation_config
|
|
1188
|
+
class TieredMatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
|
|
1189
|
+
# @!attribute allocation
|
|
1190
|
+
# Usage allocation, pooled across all matrix cells
|
|
1191
|
+
#
|
|
1192
|
+
# @return [String]
|
|
1193
|
+
required :allocation, String
|
|
1194
|
+
|
|
1195
|
+
# @!attribute default_unit_amount
|
|
1196
|
+
# Per unit rate for usage whose matrix cell has no configured tiers
|
|
1197
|
+
#
|
|
1198
|
+
# @return [String]
|
|
1199
|
+
required :default_unit_amount, String
|
|
1200
|
+
|
|
1201
|
+
# @!attribute dimensions
|
|
1202
|
+
# One or two event property values to evaluate matrix cells by
|
|
1203
|
+
#
|
|
1204
|
+
# @return [Array<String>]
|
|
1205
|
+
required :dimensions, Orb::Internal::Type::ArrayOf[String]
|
|
1206
|
+
|
|
1207
|
+
# @!attribute tiers
|
|
1208
|
+
# Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
|
|
1209
|
+
# own rows
|
|
1210
|
+
#
|
|
1211
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier>]
|
|
1212
|
+
required :tiers,
|
|
1213
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier] }
|
|
1214
|
+
|
|
1215
|
+
# @!method initialize(allocation:, default_unit_amount:, dimensions:, tiers:)
|
|
1216
|
+
# Some parameter documentations has been truncated, see
|
|
1217
|
+
# {Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig}
|
|
1218
|
+
# for more details.
|
|
1219
|
+
#
|
|
1220
|
+
# Configuration for tiered_matrix_with_allocation pricing
|
|
1221
|
+
#
|
|
1222
|
+
# @param allocation [String] Usage allocation, pooled across all matrix cells
|
|
1223
|
+
#
|
|
1224
|
+
# @param default_unit_amount [String] Per unit rate for usage whose matrix cell has no configured tiers
|
|
1225
|
+
#
|
|
1226
|
+
# @param dimensions [Array<String>] One or two event property values to evaluate matrix cells by
|
|
1227
|
+
#
|
|
1228
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier>] Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
|
|
1229
|
+
|
|
1230
|
+
class Tier < Orb::Internal::Type::BaseModel
|
|
1231
|
+
# @!attribute dimension_values
|
|
1232
|
+
# The matrix cell this tier applies to, as one or two dimension values
|
|
1233
|
+
#
|
|
1234
|
+
# @return [Array<String>]
|
|
1235
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
|
1236
|
+
|
|
1237
|
+
# @!attribute tier_lower_bound
|
|
1238
|
+
# Exclusive tier starting value. The tier runs up to and including the next bound
|
|
1239
|
+
# configured for the same matrix cell.
|
|
1240
|
+
#
|
|
1241
|
+
# @return [String]
|
|
1242
|
+
required :tier_lower_bound, String
|
|
1243
|
+
|
|
1244
|
+
# @!attribute unit_amount
|
|
1245
|
+
# Per unit amount
|
|
1246
|
+
#
|
|
1247
|
+
# @return [String]
|
|
1248
|
+
required :unit_amount, String
|
|
1249
|
+
|
|
1250
|
+
# @!method initialize(dimension_values:, tier_lower_bound:, unit_amount:)
|
|
1251
|
+
# Some parameter documentations has been truncated, see
|
|
1252
|
+
# {Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier}
|
|
1253
|
+
# for more details.
|
|
1254
|
+
#
|
|
1255
|
+
# Configuration for a single tier scoped to one matrix cell
|
|
1256
|
+
#
|
|
1257
|
+
# @param dimension_values [Array<String>] The matrix cell this tier applies to, as one or two dimension values
|
|
1258
|
+
#
|
|
1259
|
+
# @param tier_lower_bound [String] Exclusive tier starting value. The tier runs up to and including the next bound
|
|
1260
|
+
#
|
|
1261
|
+
# @param unit_amount [String] Per unit amount
|
|
1262
|
+
end
|
|
1263
|
+
end
|
|
1264
|
+
end
|
|
1265
|
+
|
|
991
1266
|
class MatrixWithThresholdDiscounts < Orb::Internal::Type::BaseModel
|
|
992
1267
|
# @!attribute cadence
|
|
993
1268
|
# The cadence to bill for this price on.
|
|
@@ -3004,7 +3279,7 @@ module Orb
|
|
|
3004
3279
|
end
|
|
3005
3280
|
|
|
3006
3281
|
# @!method self.variants
|
|
3007
|
-
# @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::PlanCreateParams::Price::Price::MatrixWithThresholdDiscounts, Orb::Models::PlanCreateParams::Price::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::PlanCreateParams::Price::Price::CumulativeGroupedAllocation, Orb::Models::PlanCreateParams::Price::Price::DailyCreditAllowance, Orb::Models::PlanCreateParams::Price::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::PlanCreateParams::Price::Price::Percent, Orb::Models::PlanCreateParams::Price::Price::EventOutput)]
|
|
3282
|
+
# @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::PlanCreateParams::Price::Price::TieredMatrixWithAllocation, Orb::Models::PlanCreateParams::Price::Price::MatrixWithThresholdDiscounts, Orb::Models::PlanCreateParams::Price::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::PlanCreateParams::Price::Price::CumulativeGroupedAllocation, Orb::Models::PlanCreateParams::Price::Price::DailyCreditAllowance, Orb::Models::PlanCreateParams::Price::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::PlanCreateParams::Price::Price::Percent, Orb::Models::PlanCreateParams::Price::Price::EventOutput)]
|
|
3008
3283
|
end
|
|
3009
3284
|
end
|
|
3010
3285
|
|
|
@@ -25,7 +25,7 @@ module Orb
|
|
|
25
25
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
|
26
26
|
# phases of the plan.
|
|
27
27
|
#
|
|
28
|
-
# @return [Array<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>]
|
|
28
|
+
# @return [Array<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>]
|
|
29
29
|
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }
|
|
30
30
|
|
|
31
31
|
# @!attribute version
|
|
@@ -46,7 +46,7 @@ module Orb
|
|
|
46
46
|
#
|
|
47
47
|
# @param plan_phases [Array<Orb::Models::PlanVersionPhase>, nil]
|
|
48
48
|
#
|
|
49
|
-
# @param prices [Array<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>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
|
49
|
+
# @param prices [Array<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>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
|
50
50
|
#
|
|
51
51
|
# @param version [Integer]
|
|
52
52
|
|