orb-billing 1.24.0 → 1.26.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/alert.rb +4 -2
- data/lib/orb/models/alert_update_params.rb +5 -3
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +530 -6
- data/lib/orb/models/beta_create_plan_version_params.rb +526 -6
- data/lib/orb/models/changed_subscription_resources.rb +5 -5
- data/lib/orb/models/invoice.rb +5 -5
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +5 -5
- data/lib/orb/models/invoice_issue_summary_response.rb +3 -3
- data/lib/orb/models/invoice_line_item_create_response.rb +2 -2
- data/lib/orb/models/invoice_list_summary_response.rb +3 -3
- 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 +259 -3
- data/lib/orb/models/plan_version.rb +2 -2
- data/lib/orb/models/price.rb +433 -1
- data/lib/orb/models/price_create_params.rb +244 -3
- data/lib/orb/models/price_evaluate_multiple_params.rb +255 -3
- data/lib/orb/models/price_evaluate_preview_events_params.rb +255 -3
- data/lib/orb/models/price_interval.rb +2 -2
- data/lib/orb/models/subscription_create_params.rb +521 -6
- data/lib/orb/models/subscription_price_intervals_params.rb +251 -3
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +530 -6
- data/lib/orb/resources/alerts.rb +5 -2
- data/lib/orb/resources/customers/costs.rb +20 -0
- data/lib/orb/resources/licenses/external_licenses.rb +7 -0
- data/lib/orb/resources/licenses/usage.rb +3 -0
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +5 -5
- data/lib/orb/resources/subscriptions.rb +39 -6
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/models/alert.rbi +6 -2
- data/rbi/orb/models/alert_update_params.rbi +8 -4
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +2789 -1903
- data/rbi/orb/models/beta_create_plan_version_params.rbi +2788 -1902
- data/rbi/orb/models/changed_subscription_resources.rbi +7 -6
- data/rbi/orb/models/invoice.rbi +7 -6
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +7 -6
- data/rbi/orb/models/invoice_issue_summary_response.rbi +6 -6
- data/rbi/orb/models/invoice_line_item_create_response.rbi +1 -0
- data/rbi/orb/models/invoice_list_summary_response.rbi +6 -6
- 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 +443 -0
- data/rbi/orb/models/plan_version.rbi +1 -0
- data/rbi/orb/models/price.rbi +766 -0
- data/rbi/orb/models/price_create_params.rbi +431 -0
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +431 -0
- data/rbi/orb/models/price_evaluate_preview_events_params.rbi +431 -0
- data/rbi/orb/models/price_interval.rbi +1 -0
- data/rbi/orb/models/subscription_create_params.rbi +2489 -1603
- data/rbi/orb/models/subscription_price_intervals_params.rbi +431 -0
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +2483 -1597
- data/rbi/orb/resources/alerts.rbi +8 -3
- data/rbi/orb/resources/customers/costs.rbi +20 -0
- data/rbi/orb/resources/licenses/external_licenses.rbi +7 -0
- data/rbi/orb/resources/licenses/usage.rbi +3 -0
- data/rbi/orb/resources/prices.rbi +1 -0
- data/rbi/orb/resources/subscriptions.rbi +39 -6
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +366 -0
- data/sig/orb/models/beta_create_plan_version_params.rbs +366 -0
- data/sig/orb/models/plan_create_params.rbs +183 -0
- data/sig/orb/models/price.rbs +327 -0
- data/sig/orb/models/price_create_params.rbs +173 -0
- data/sig/orb/models/price_evaluate_multiple_params.rbs +178 -0
- data/sig/orb/models/price_evaluate_preview_events_params.rbs +178 -0
- data/sig/orb/models/subscription_create_params.rbs +366 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +178 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +366 -0
- metadata +2 -2
|
@@ -568,9 +568,9 @@ module Orb
|
|
|
568
568
|
# If Orb has ever attempted payment auto-collection for this invoice, this field
|
|
569
569
|
# will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
|
|
570
570
|
# this can be used to tell whether the invoice is currently in dunning (that is,
|
|
571
|
-
# `previously_attempted_at` is non-null, and `
|
|
572
|
-
#
|
|
573
|
-
# `
|
|
571
|
+
# `previously_attempted_at` is non-null, and `next_attempt_at` is non-null), or if
|
|
572
|
+
# dunning has been exhausted (`previously_attempted_at` is non-null, but
|
|
573
|
+
# `next_attempt_at` is null).
|
|
574
574
|
#
|
|
575
575
|
# @return [Time, nil]
|
|
576
576
|
required :previously_attempted_at, Time, nil?: true
|
|
@@ -857,7 +857,7 @@ module Orb
|
|
|
857
857
|
# For more on the types of prices, see
|
|
858
858
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
859
859
|
#
|
|
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::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]
|
|
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
861
|
required :price, union: -> { Orb::Price }
|
|
862
862
|
|
|
863
863
|
# @!attribute quantity
|
|
@@ -924,7 +924,7 @@ module Orb
|
|
|
924
924
|
#
|
|
925
925
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
|
926
926
|
#
|
|
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::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
|
|
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
928
|
#
|
|
929
929
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
|
930
930
|
#
|
data/lib/orb/models/invoice.rb
CHANGED
|
@@ -528,9 +528,9 @@ module Orb
|
|
|
528
528
|
# If Orb has ever attempted payment auto-collection for this invoice, this field
|
|
529
529
|
# will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
|
|
530
530
|
# this can be used to tell whether the invoice is currently in dunning (that is,
|
|
531
|
-
# `previously_attempted_at` is non-null, and `
|
|
532
|
-
#
|
|
533
|
-
# `
|
|
531
|
+
# `previously_attempted_at` is non-null, and `next_attempt_at` is non-null), or if
|
|
532
|
+
# dunning has been exhausted (`previously_attempted_at` is non-null, but
|
|
533
|
+
# `next_attempt_at` is null).
|
|
534
534
|
#
|
|
535
535
|
# @return [Time, nil]
|
|
536
536
|
required :previously_attempted_at, Time, nil?: true
|
|
@@ -811,7 +811,7 @@ module Orb
|
|
|
811
811
|
# For more on the types of prices, see
|
|
812
812
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
813
813
|
#
|
|
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::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]
|
|
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
815
|
required :price, union: -> { Orb::Price }
|
|
816
816
|
|
|
817
817
|
# @!attribute quantity
|
|
@@ -876,7 +876,7 @@ module Orb
|
|
|
876
876
|
#
|
|
877
877
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
|
878
878
|
#
|
|
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::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
|
|
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
880
|
#
|
|
881
881
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
|
882
882
|
#
|
|
@@ -526,9 +526,9 @@ module Orb
|
|
|
526
526
|
# If Orb has ever attempted payment auto-collection for this invoice, this field
|
|
527
527
|
# will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
|
|
528
528
|
# this can be used to tell whether the invoice is currently in dunning (that is,
|
|
529
|
-
# `previously_attempted_at` is non-null, and `
|
|
530
|
-
#
|
|
531
|
-
# `
|
|
529
|
+
# `previously_attempted_at` is non-null, and `next_attempt_at` is non-null), or if
|
|
530
|
+
# dunning has been exhausted (`previously_attempted_at` is non-null, but
|
|
531
|
+
# `next_attempt_at` is null).
|
|
532
532
|
#
|
|
533
533
|
# @return [Time, nil]
|
|
534
534
|
required :previously_attempted_at, Time, nil?: true
|
|
@@ -812,7 +812,7 @@ module Orb
|
|
|
812
812
|
# For more on the types of prices, see
|
|
813
813
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
814
814
|
#
|
|
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::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::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
816
|
required :price, union: -> { Orb::Price }
|
|
817
817
|
|
|
818
818
|
# @!attribute quantity
|
|
@@ -878,7 +878,7 @@ module Orb
|
|
|
878
878
|
#
|
|
879
879
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
|
880
880
|
#
|
|
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::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
|
|
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
882
|
#
|
|
883
883
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
|
884
884
|
#
|
|
@@ -464,9 +464,9 @@ module Orb
|
|
|
464
464
|
# If Orb has ever attempted payment auto-collection for this invoice, this field
|
|
465
465
|
# will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
|
|
466
466
|
# this can be used to tell whether the invoice is currently in dunning (that is,
|
|
467
|
-
# `previously_attempted_at` is non-null, and `
|
|
468
|
-
#
|
|
469
|
-
# `
|
|
467
|
+
# `previously_attempted_at` is non-null, and `next_attempt_at` is non-null), or if
|
|
468
|
+
# dunning has been exhausted (`previously_attempted_at` is non-null, but
|
|
469
|
+
# `next_attempt_at` is null).
|
|
470
470
|
#
|
|
471
471
|
# @return [Time, nil]
|
|
472
472
|
required :previously_attempted_at, Time, nil?: true
|
|
@@ -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::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::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::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::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
|
#
|
|
@@ -464,9 +464,9 @@ module Orb
|
|
|
464
464
|
# If Orb has ever attempted payment auto-collection for this invoice, this field
|
|
465
465
|
# will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
|
|
466
466
|
# this can be used to tell whether the invoice is currently in dunning (that is,
|
|
467
|
-
# `previously_attempted_at` is non-null, and `
|
|
468
|
-
#
|
|
469
|
-
# `
|
|
467
|
+
# `previously_attempted_at` is non-null, and `next_attempt_at` is non-null), or if
|
|
468
|
+
# dunning has been exhausted (`previously_attempted_at` is non-null, but
|
|
469
|
+
# `next_attempt_at` is null).
|
|
470
470
|
#
|
|
471
471
|
# @return [Time, nil]
|
|
472
472
|
required :previously_attempted_at, Time, nil?: true
|
|
@@ -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::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::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::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::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::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::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::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::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::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::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::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::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
|
|
@@ -413,6 +413,8 @@ module Orb
|
|
|
413
413
|
|
|
414
414
|
variant :grouped_tiered, -> { Orb::NewPlanGroupedTieredPrice }
|
|
415
415
|
|
|
416
|
+
variant :grouped_tiered_matrix, -> { Orb::PlanCreateParams::Price::Price::GroupedTieredMatrix }
|
|
417
|
+
|
|
416
418
|
variant :tiered_package_with_minimum, -> { Orb::NewPlanTieredPackageWithMinimumPrice }
|
|
417
419
|
|
|
418
420
|
variant :package_with_allocation, -> { Orb::NewPlanPackageWithAllocationPrice }
|
|
@@ -719,6 +721,260 @@ module Orb
|
|
|
719
721
|
end
|
|
720
722
|
end
|
|
721
723
|
|
|
724
|
+
class GroupedTieredMatrix < Orb::Internal::Type::BaseModel
|
|
725
|
+
# @!attribute cadence
|
|
726
|
+
# The cadence to bill for this price on.
|
|
727
|
+
#
|
|
728
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix::Cadence]
|
|
729
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::Price::GroupedTieredMatrix::Cadence }
|
|
730
|
+
|
|
731
|
+
# @!attribute grouped_tiered_matrix_config
|
|
732
|
+
# Configuration for grouped_tiered_matrix pricing
|
|
733
|
+
#
|
|
734
|
+
# @return [Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig]
|
|
735
|
+
required :grouped_tiered_matrix_config,
|
|
736
|
+
-> { Orb::PlanCreateParams::Price::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig }
|
|
737
|
+
|
|
738
|
+
# @!attribute item_id
|
|
739
|
+
# The id of the item the price will be associated with.
|
|
740
|
+
#
|
|
741
|
+
# @return [String]
|
|
742
|
+
required :item_id, String
|
|
743
|
+
|
|
744
|
+
# @!attribute model_type
|
|
745
|
+
# The pricing model type
|
|
746
|
+
#
|
|
747
|
+
# @return [Symbol, :grouped_tiered_matrix]
|
|
748
|
+
required :model_type, const: :grouped_tiered_matrix
|
|
749
|
+
|
|
750
|
+
# @!attribute name
|
|
751
|
+
# The name of the price.
|
|
752
|
+
#
|
|
753
|
+
# @return [String]
|
|
754
|
+
required :name, String
|
|
755
|
+
|
|
756
|
+
# @!attribute billable_metric_id
|
|
757
|
+
# The id of the billable metric for the price. Only needed if the price is
|
|
758
|
+
# usage-based.
|
|
759
|
+
#
|
|
760
|
+
# @return [String, nil]
|
|
761
|
+
optional :billable_metric_id, String, nil?: true
|
|
762
|
+
|
|
763
|
+
# @!attribute billed_in_advance
|
|
764
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
|
765
|
+
# this is true, and in-arrears if this is false.
|
|
766
|
+
#
|
|
767
|
+
# @return [Boolean, nil]
|
|
768
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
|
769
|
+
|
|
770
|
+
# @!attribute billing_cycle_configuration
|
|
771
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
|
772
|
+
# months.
|
|
773
|
+
#
|
|
774
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
775
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
776
|
+
|
|
777
|
+
# @!attribute conversion_rate
|
|
778
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
|
779
|
+
#
|
|
780
|
+
# @return [Float, nil]
|
|
781
|
+
optional :conversion_rate, Float, nil?: true
|
|
782
|
+
|
|
783
|
+
# @!attribute conversion_rate_config
|
|
784
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
|
785
|
+
#
|
|
786
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
|
787
|
+
optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
|
|
788
|
+
|
|
789
|
+
# @!attribute currency
|
|
790
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
791
|
+
# price is billed.
|
|
792
|
+
#
|
|
793
|
+
# @return [String, nil]
|
|
794
|
+
optional :currency, String, nil?: true
|
|
795
|
+
|
|
796
|
+
# @!attribute dimensional_price_configuration
|
|
797
|
+
# For dimensional price: specifies a price group and dimension values
|
|
798
|
+
#
|
|
799
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
|
800
|
+
optional :dimensional_price_configuration,
|
|
801
|
+
-> {
|
|
802
|
+
Orb::NewDimensionalPriceConfiguration
|
|
803
|
+
},
|
|
804
|
+
nil?: true
|
|
805
|
+
|
|
806
|
+
# @!attribute external_price_id
|
|
807
|
+
# An alias for the price.
|
|
808
|
+
#
|
|
809
|
+
# @return [String, nil]
|
|
810
|
+
optional :external_price_id, String, nil?: true
|
|
811
|
+
|
|
812
|
+
# @!attribute fixed_price_quantity
|
|
813
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
|
814
|
+
# applied.
|
|
815
|
+
#
|
|
816
|
+
# @return [Float, nil]
|
|
817
|
+
optional :fixed_price_quantity, Float, nil?: true
|
|
818
|
+
|
|
819
|
+
# @!attribute invoice_grouping_key
|
|
820
|
+
# The property used to group this price on an invoice
|
|
821
|
+
#
|
|
822
|
+
# @return [String, nil]
|
|
823
|
+
optional :invoice_grouping_key, String, nil?: true
|
|
824
|
+
|
|
825
|
+
# @!attribute invoicing_cycle_configuration
|
|
826
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
827
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
|
828
|
+
#
|
|
829
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
830
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
831
|
+
|
|
832
|
+
# @!attribute license_type_id
|
|
833
|
+
# The ID of the license type to associate with this price.
|
|
834
|
+
#
|
|
835
|
+
# @return [String, nil]
|
|
836
|
+
optional :license_type_id, String, nil?: true
|
|
837
|
+
|
|
838
|
+
# @!attribute metadata
|
|
839
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
840
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
841
|
+
# by setting `metadata` to `null`.
|
|
842
|
+
#
|
|
843
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
|
844
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
845
|
+
|
|
846
|
+
# @!attribute reference_id
|
|
847
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
|
848
|
+
# in the same API call.
|
|
849
|
+
#
|
|
850
|
+
# @return [String, nil]
|
|
851
|
+
optional :reference_id, String, nil?: true
|
|
852
|
+
|
|
853
|
+
# @!method initialize(cadence:, grouped_tiered_matrix_config:, item_id:, name:, 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: :grouped_tiered_matrix)
|
|
854
|
+
# Some parameter documentations has been truncated, see
|
|
855
|
+
# {Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix} for more
|
|
856
|
+
# details.
|
|
857
|
+
#
|
|
858
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix::Cadence] The cadence to bill for this price on.
|
|
859
|
+
#
|
|
860
|
+
# @param grouped_tiered_matrix_config [Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig] Configuration for grouped_tiered_matrix pricing
|
|
861
|
+
#
|
|
862
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
|
863
|
+
#
|
|
864
|
+
# @param name [String] The name of the price.
|
|
865
|
+
#
|
|
866
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
|
867
|
+
#
|
|
868
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
|
869
|
+
#
|
|
870
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
|
871
|
+
#
|
|
872
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
|
873
|
+
#
|
|
874
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
|
875
|
+
#
|
|
876
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
|
877
|
+
#
|
|
878
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
|
879
|
+
#
|
|
880
|
+
# @param external_price_id [String, nil] An alias for the price.
|
|
881
|
+
#
|
|
882
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
|
883
|
+
#
|
|
884
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
|
885
|
+
#
|
|
886
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
887
|
+
#
|
|
888
|
+
# @param license_type_id [String, nil] The ID of the license type to associate with this price.
|
|
889
|
+
#
|
|
890
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
891
|
+
#
|
|
892
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
|
893
|
+
#
|
|
894
|
+
# @param model_type [Symbol, :grouped_tiered_matrix] The pricing model type
|
|
895
|
+
|
|
896
|
+
# The cadence to bill for this price on.
|
|
897
|
+
#
|
|
898
|
+
# @see Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix#cadence
|
|
899
|
+
module Cadence
|
|
900
|
+
extend Orb::Internal::Type::Enum
|
|
901
|
+
|
|
902
|
+
ANNUAL = :annual
|
|
903
|
+
SEMI_ANNUAL = :semi_annual
|
|
904
|
+
MONTHLY = :monthly
|
|
905
|
+
QUARTERLY = :quarterly
|
|
906
|
+
ONE_TIME = :one_time
|
|
907
|
+
CUSTOM = :custom
|
|
908
|
+
|
|
909
|
+
# @!method self.values
|
|
910
|
+
# @return [Array<Symbol>]
|
|
911
|
+
end
|
|
912
|
+
|
|
913
|
+
# @see Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix#grouped_tiered_matrix_config
|
|
914
|
+
class GroupedTieredMatrixConfig < Orb::Internal::Type::BaseModel
|
|
915
|
+
# @!attribute default_unit_amount
|
|
916
|
+
# Per unit rate for usage whose dimension value has no configured tiers
|
|
917
|
+
#
|
|
918
|
+
# @return [String]
|
|
919
|
+
required :default_unit_amount, String
|
|
920
|
+
|
|
921
|
+
# @!attribute dimension
|
|
922
|
+
# The billable metric property used to group usage before tiering
|
|
923
|
+
#
|
|
924
|
+
# @return [String]
|
|
925
|
+
required :dimension, String
|
|
926
|
+
|
|
927
|
+
# @!attribute tiers
|
|
928
|
+
# Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
929
|
+
# against its own rows
|
|
930
|
+
#
|
|
931
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier>]
|
|
932
|
+
required :tiers,
|
|
933
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier] }
|
|
934
|
+
|
|
935
|
+
# @!method initialize(default_unit_amount:, dimension:, tiers:)
|
|
936
|
+
# Some parameter documentations has been truncated, see
|
|
937
|
+
# {Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig}
|
|
938
|
+
# for more details.
|
|
939
|
+
#
|
|
940
|
+
# Configuration for grouped_tiered_matrix pricing
|
|
941
|
+
#
|
|
942
|
+
# @param default_unit_amount [String] Per unit rate for usage whose dimension value has no configured tiers
|
|
943
|
+
#
|
|
944
|
+
# @param dimension [String] The billable metric property used to group usage before tiering
|
|
945
|
+
#
|
|
946
|
+
# @param tiers [Array<Orb::Models::PlanCreateParams::Price::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier>] Graduated tiers keyed by dimension value; usage for a value is tiered only again
|
|
947
|
+
|
|
948
|
+
class Tier < Orb::Internal::Type::BaseModel
|
|
949
|
+
# @!attribute dimension_value
|
|
950
|
+
# The dimension value this tier applies to
|
|
951
|
+
#
|
|
952
|
+
# @return [String]
|
|
953
|
+
required :dimension_value, String
|
|
954
|
+
|
|
955
|
+
# @!attribute tier_lower_bound
|
|
956
|
+
#
|
|
957
|
+
# @return [String]
|
|
958
|
+
required :tier_lower_bound, String
|
|
959
|
+
|
|
960
|
+
# @!attribute unit_amount
|
|
961
|
+
# Per unit amount
|
|
962
|
+
#
|
|
963
|
+
# @return [String]
|
|
964
|
+
required :unit_amount, String
|
|
965
|
+
|
|
966
|
+
# @!method initialize(dimension_value:, tier_lower_bound:, unit_amount:)
|
|
967
|
+
# Configuration for a single tier scoped to a dimension value
|
|
968
|
+
#
|
|
969
|
+
# @param dimension_value [String] The dimension value this tier applies to
|
|
970
|
+
#
|
|
971
|
+
# @param tier_lower_bound [String]
|
|
972
|
+
#
|
|
973
|
+
# @param unit_amount [String] Per unit amount
|
|
974
|
+
end
|
|
975
|
+
end
|
|
976
|
+
end
|
|
977
|
+
|
|
722
978
|
class MatrixWithThresholdDiscounts < Orb::Internal::Type::BaseModel
|
|
723
979
|
# @!attribute cadence
|
|
724
980
|
# The cadence to bill for this price on.
|
|
@@ -2703,7 +2959,7 @@ module Orb
|
|
|
2703
2959
|
end
|
|
2704
2960
|
|
|
2705
2961
|
# @!method self.variants
|
|
2706
|
-
# @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::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)]
|
|
2962
|
+
# @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)]
|
|
2707
2963
|
end
|
|
2708
2964
|
end
|
|
2709
2965
|
|
|
@@ -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::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::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::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::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
|
|