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
|
@@ -144,7 +144,7 @@ module Orb
|
|
|
144
144
|
# @!attribute price
|
|
145
145
|
# New floating price request body params.
|
|
146
146
|
#
|
|
147
|
-
# @return [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput, nil]
|
|
147
|
+
# @return [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput, nil]
|
|
148
148
|
optional :price,
|
|
149
149
|
union: -> {
|
|
150
150
|
Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price
|
|
@@ -170,7 +170,7 @@ module Orb
|
|
|
170
170
|
#
|
|
171
171
|
# @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Optional overrides for parameterized billable metric parameters. If the metric h
|
|
172
172
|
#
|
|
173
|
-
# @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput, nil] New floating price request body params.
|
|
173
|
+
# @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput, nil] New floating price request body params.
|
|
174
174
|
#
|
|
175
175
|
# @param price_id [String, nil] The ID of a price to evaluate that exists in your Orb account.
|
|
176
176
|
|
|
@@ -203,6 +203,9 @@ module Orb
|
|
|
203
203
|
|
|
204
204
|
variant :grouped_tiered, -> { Orb::NewFloatingGroupedTieredPrice }
|
|
205
205
|
|
|
206
|
+
variant :grouped_tiered_matrix,
|
|
207
|
+
-> { Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix }
|
|
208
|
+
|
|
206
209
|
variant :tiered_package_with_minimum, -> { Orb::NewFloatingTieredPackageWithMinimumPrice }
|
|
207
210
|
|
|
208
211
|
variant :package_with_allocation, -> { Orb::NewFloatingPackageWithAllocationPrice }
|
|
@@ -511,6 +514,255 @@ module Orb
|
|
|
511
514
|
end
|
|
512
515
|
end
|
|
513
516
|
|
|
517
|
+
class GroupedTieredMatrix < Orb::Internal::Type::BaseModel
|
|
518
|
+
# @!attribute cadence
|
|
519
|
+
# The cadence to bill for this price on.
|
|
520
|
+
#
|
|
521
|
+
# @return [Symbol, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::Cadence]
|
|
522
|
+
required :cadence,
|
|
523
|
+
enum: -> { Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::Cadence }
|
|
524
|
+
|
|
525
|
+
# @!attribute currency
|
|
526
|
+
# An ISO 4217 currency string for which this price is billed in.
|
|
527
|
+
#
|
|
528
|
+
# @return [String]
|
|
529
|
+
required :currency, String
|
|
530
|
+
|
|
531
|
+
# @!attribute grouped_tiered_matrix_config
|
|
532
|
+
# Configuration for grouped_tiered_matrix pricing
|
|
533
|
+
#
|
|
534
|
+
# @return [Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig]
|
|
535
|
+
required :grouped_tiered_matrix_config,
|
|
536
|
+
-> { Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig }
|
|
537
|
+
|
|
538
|
+
# @!attribute item_id
|
|
539
|
+
# The id of the item the price will be associated with.
|
|
540
|
+
#
|
|
541
|
+
# @return [String]
|
|
542
|
+
required :item_id, String
|
|
543
|
+
|
|
544
|
+
# @!attribute model_type
|
|
545
|
+
# The pricing model type
|
|
546
|
+
#
|
|
547
|
+
# @return [Symbol, :grouped_tiered_matrix]
|
|
548
|
+
required :model_type, const: :grouped_tiered_matrix
|
|
549
|
+
|
|
550
|
+
# @!attribute name
|
|
551
|
+
# The name of the price.
|
|
552
|
+
#
|
|
553
|
+
# @return [String]
|
|
554
|
+
required :name, String
|
|
555
|
+
|
|
556
|
+
# @!attribute billable_metric_id
|
|
557
|
+
# The id of the billable metric for the price. Only needed if the price is
|
|
558
|
+
# usage-based.
|
|
559
|
+
#
|
|
560
|
+
# @return [String, nil]
|
|
561
|
+
optional :billable_metric_id, String, nil?: true
|
|
562
|
+
|
|
563
|
+
# @!attribute billed_in_advance
|
|
564
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
|
565
|
+
# this is true, and in-arrears if this is false.
|
|
566
|
+
#
|
|
567
|
+
# @return [Boolean, nil]
|
|
568
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
|
569
|
+
|
|
570
|
+
# @!attribute billing_cycle_configuration
|
|
571
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
|
572
|
+
# months.
|
|
573
|
+
#
|
|
574
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
575
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
576
|
+
|
|
577
|
+
# @!attribute conversion_rate
|
|
578
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
|
579
|
+
#
|
|
580
|
+
# @return [Float, nil]
|
|
581
|
+
optional :conversion_rate, Float, nil?: true
|
|
582
|
+
|
|
583
|
+
# @!attribute conversion_rate_config
|
|
584
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
|
585
|
+
#
|
|
586
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
|
587
|
+
optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
|
|
588
|
+
|
|
589
|
+
# @!attribute dimensional_price_configuration
|
|
590
|
+
# For dimensional price: specifies a price group and dimension values
|
|
591
|
+
#
|
|
592
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
|
593
|
+
optional :dimensional_price_configuration,
|
|
594
|
+
-> {
|
|
595
|
+
Orb::NewDimensionalPriceConfiguration
|
|
596
|
+
},
|
|
597
|
+
nil?: true
|
|
598
|
+
|
|
599
|
+
# @!attribute external_price_id
|
|
600
|
+
# An alias for the price.
|
|
601
|
+
#
|
|
602
|
+
# @return [String, nil]
|
|
603
|
+
optional :external_price_id, String, nil?: true
|
|
604
|
+
|
|
605
|
+
# @!attribute fixed_price_quantity
|
|
606
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
|
607
|
+
# applied.
|
|
608
|
+
#
|
|
609
|
+
# @return [Float, nil]
|
|
610
|
+
optional :fixed_price_quantity, Float, nil?: true
|
|
611
|
+
|
|
612
|
+
# @!attribute invoice_grouping_key
|
|
613
|
+
# The property used to group this price on an invoice
|
|
614
|
+
#
|
|
615
|
+
# @return [String, nil]
|
|
616
|
+
optional :invoice_grouping_key, String, nil?: true
|
|
617
|
+
|
|
618
|
+
# @!attribute invoicing_cycle_configuration
|
|
619
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
620
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
|
621
|
+
#
|
|
622
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
623
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
624
|
+
|
|
625
|
+
# @!attribute license_type_id
|
|
626
|
+
# The ID of the license type to associate with this price.
|
|
627
|
+
#
|
|
628
|
+
# @return [String, nil]
|
|
629
|
+
optional :license_type_id, String, nil?: true
|
|
630
|
+
|
|
631
|
+
# @!attribute metadata
|
|
632
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
633
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
634
|
+
# by setting `metadata` to `null`.
|
|
635
|
+
#
|
|
636
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
|
637
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
638
|
+
|
|
639
|
+
# @!method initialize(cadence:, currency:, 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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, model_type: :grouped_tiered_matrix)
|
|
640
|
+
# Some parameter documentations has been truncated, see
|
|
641
|
+
# {Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix}
|
|
642
|
+
# for more details.
|
|
643
|
+
#
|
|
644
|
+
# @param cadence [Symbol, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::Cadence] The cadence to bill for this price on.
|
|
645
|
+
#
|
|
646
|
+
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
|
647
|
+
#
|
|
648
|
+
# @param grouped_tiered_matrix_config [Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig] Configuration for grouped_tiered_matrix pricing
|
|
649
|
+
#
|
|
650
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
|
651
|
+
#
|
|
652
|
+
# @param name [String] The name of the price.
|
|
653
|
+
#
|
|
654
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
|
655
|
+
#
|
|
656
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
|
657
|
+
#
|
|
658
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
|
659
|
+
#
|
|
660
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
|
661
|
+
#
|
|
662
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
|
663
|
+
#
|
|
664
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
|
665
|
+
#
|
|
666
|
+
# @param external_price_id [String, nil] An alias for the price.
|
|
667
|
+
#
|
|
668
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
|
669
|
+
#
|
|
670
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
|
671
|
+
#
|
|
672
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
673
|
+
#
|
|
674
|
+
# @param license_type_id [String, nil] The ID of the license type to associate with this price.
|
|
675
|
+
#
|
|
676
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
677
|
+
#
|
|
678
|
+
# @param model_type [Symbol, :grouped_tiered_matrix] The pricing model type
|
|
679
|
+
|
|
680
|
+
# The cadence to bill for this price on.
|
|
681
|
+
#
|
|
682
|
+
# @see Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix#cadence
|
|
683
|
+
module Cadence
|
|
684
|
+
extend Orb::Internal::Type::Enum
|
|
685
|
+
|
|
686
|
+
ANNUAL = :annual
|
|
687
|
+
SEMI_ANNUAL = :semi_annual
|
|
688
|
+
MONTHLY = :monthly
|
|
689
|
+
QUARTERLY = :quarterly
|
|
690
|
+
ONE_TIME = :one_time
|
|
691
|
+
CUSTOM = :custom
|
|
692
|
+
|
|
693
|
+
# @!method self.values
|
|
694
|
+
# @return [Array<Symbol>]
|
|
695
|
+
end
|
|
696
|
+
|
|
697
|
+
# @see Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix#grouped_tiered_matrix_config
|
|
698
|
+
class GroupedTieredMatrixConfig < Orb::Internal::Type::BaseModel
|
|
699
|
+
# @!attribute default_unit_amount
|
|
700
|
+
# Per unit rate for usage whose dimension value has no configured tiers
|
|
701
|
+
#
|
|
702
|
+
# @return [String]
|
|
703
|
+
required :default_unit_amount, String
|
|
704
|
+
|
|
705
|
+
# @!attribute dimension
|
|
706
|
+
# The billable metric property used to group usage before tiering
|
|
707
|
+
#
|
|
708
|
+
# @return [String]
|
|
709
|
+
required :dimension, String
|
|
710
|
+
|
|
711
|
+
# @!attribute tiers
|
|
712
|
+
# Graduated tiers keyed by dimension value; usage for a value is tiered only
|
|
713
|
+
# against its own rows
|
|
714
|
+
#
|
|
715
|
+
# @return [Array<Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier>]
|
|
716
|
+
required :tiers,
|
|
717
|
+
-> do
|
|
718
|
+
Orb::Internal::Type::ArrayOf[
|
|
719
|
+
Orb::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier
|
|
720
|
+
]
|
|
721
|
+
end
|
|
722
|
+
|
|
723
|
+
# @!method initialize(default_unit_amount:, dimension:, tiers:)
|
|
724
|
+
# Some parameter documentations has been truncated, see
|
|
725
|
+
# {Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig}
|
|
726
|
+
# for more details.
|
|
727
|
+
#
|
|
728
|
+
# Configuration for grouped_tiered_matrix pricing
|
|
729
|
+
#
|
|
730
|
+
# @param default_unit_amount [String] Per unit rate for usage whose dimension value has no configured tiers
|
|
731
|
+
#
|
|
732
|
+
# @param dimension [String] The billable metric property used to group usage before tiering
|
|
733
|
+
#
|
|
734
|
+
# @param tiers [Array<Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix::GroupedTieredMatrixConfig::Tier>] Graduated tiers keyed by dimension value; usage for a value is tiered only again
|
|
735
|
+
|
|
736
|
+
class Tier < Orb::Internal::Type::BaseModel
|
|
737
|
+
# @!attribute dimension_value
|
|
738
|
+
# The dimension value this tier applies to
|
|
739
|
+
#
|
|
740
|
+
# @return [String]
|
|
741
|
+
required :dimension_value, String
|
|
742
|
+
|
|
743
|
+
# @!attribute tier_lower_bound
|
|
744
|
+
#
|
|
745
|
+
# @return [String]
|
|
746
|
+
required :tier_lower_bound, String
|
|
747
|
+
|
|
748
|
+
# @!attribute unit_amount
|
|
749
|
+
# Per unit amount
|
|
750
|
+
#
|
|
751
|
+
# @return [String]
|
|
752
|
+
required :unit_amount, String
|
|
753
|
+
|
|
754
|
+
# @!method initialize(dimension_value:, tier_lower_bound:, unit_amount:)
|
|
755
|
+
# Configuration for a single tier scoped to a dimension value
|
|
756
|
+
#
|
|
757
|
+
# @param dimension_value [String] The dimension value this tier applies to
|
|
758
|
+
#
|
|
759
|
+
# @param tier_lower_bound [String]
|
|
760
|
+
#
|
|
761
|
+
# @param unit_amount [String] Per unit amount
|
|
762
|
+
end
|
|
763
|
+
end
|
|
764
|
+
end
|
|
765
|
+
|
|
514
766
|
class MatrixWithThresholdDiscounts < Orb::Internal::Type::BaseModel
|
|
515
767
|
# @!attribute cadence
|
|
516
768
|
# The cadence to bill for this price on.
|
|
@@ -2209,7 +2461,7 @@ module Orb
|
|
|
2209
2461
|
end
|
|
2210
2462
|
|
|
2211
2463
|
# @!method self.variants
|
|
2212
|
-
# @return [Array(Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput)]
|
|
2464
|
+
# @return [Array(Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedTieredMatrix, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::EventOutput)]
|
|
2213
2465
|
end
|
|
2214
2466
|
end
|
|
2215
2467
|
end
|
|
@@ -72,7 +72,7 @@ module Orb
|
|
|
72
72
|
# For more on the types of prices, see
|
|
73
73
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
74
74
|
#
|
|
75
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
75
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
76
76
|
required :price, union: -> { Orb::Price }
|
|
77
77
|
|
|
78
78
|
# @!attribute start_date
|
|
@@ -122,7 +122,7 @@ module Orb
|
|
|
122
122
|
#
|
|
123
123
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
|
124
124
|
#
|
|
125
|
-
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
|
|
125
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
|
|
126
126
|
#
|
|
127
127
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
|
128
128
|
#
|