orb-billing 1.54.0 → 1.55.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 +8 -0
- data/README.md +1 -1
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +496 -6
- data/lib/orb/models/beta_create_plan_version_params.rb +496 -6
- data/lib/orb/models/changed_subscription_resources.rb +2 -2
- data/lib/orb/models/credit_block_accounting_sync_failed_webhook_event.rb +4 -4
- data/lib/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rb +4 -4
- data/lib/orb/models/credit_block_list_invoices_response.rb +4 -4
- data/lib/orb/models/credit_block_retrieve_response.rb +4 -4
- data/lib/orb/models/credit_block_update_response.rb +4 -4
- data/lib/orb/models/customer_credit_ledger_incremented_webhook_event.rb +4 -4
- data/lib/orb/models/dimensional_price_groups/price_create_response.rb +2 -2
- data/lib/orb/models/invoice.rb +2 -2
- data/lib/orb/models/invoice_edited_webhook_event.rb +2 -2
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +2 -2
- data/lib/orb/models/invoice_line_item_create_response.rb +2 -2
- 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 +246 -3
- data/lib/orb/models/plan_version.rb +2 -2
- data/lib/orb/models/price.rb +416 -1
- data/lib/orb/models/price_create_params.rb +231 -3
- data/lib/orb/models/price_edited_webhook_event.rb +2 -2
- data/lib/orb/models/price_evaluate_multiple_params.rb +238 -3
- data/lib/orb/models/price_evaluate_preview_events_params.rb +238 -3
- data/lib/orb/models/price_interval.rb +2 -2
- data/lib/orb/models/subscription_create_params.rb +495 -6
- data/lib/orb/models/subscription_price_intervals_params.rb +238 -3
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +496 -6
- data/lib/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rb +4 -4
- data/lib/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rb +4 -4
- data/lib/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rb +4 -4
- data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +2 -2
- data/lib/orb/models/webhooks/price_edited_standard_webhook_event.rb +2 -2
- data/lib/orb/resources/credit_blocks.rb +1 -1
- data/lib/orb/resources/dimensional_price_groups/prices.rb +1 -1
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +5 -5
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +2939 -2129
- data/rbi/orb/models/beta_create_plan_version_params.rbi +2937 -2127
- data/rbi/orb/models/changed_subscription_resources.rbi +2 -1
- data/rbi/orb/models/credit_block_accounting_sync_failed_webhook_event.rbi +5 -5
- data/rbi/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbi +5 -5
- data/rbi/orb/models/credit_block_list_invoices_response.rbi +5 -5
- data/rbi/orb/models/credit_block_retrieve_response.rbi +5 -5
- data/rbi/orb/models/credit_block_update_response.rbi +5 -5
- data/rbi/orb/models/customer_credit_ledger_incremented_webhook_event.rbi +5 -5
- data/rbi/orb/models/dimensional_price_groups/price_create_response.rbi +2 -1
- data/rbi/orb/models/invoice.rbi +2 -1
- data/rbi/orb/models/invoice_edited_webhook_event.rbi +2 -1
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2 -1
- data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -1
- data/rbi/orb/models/per_price_cost.rbi +2 -1
- data/rbi/orb/models/plan.rbi +2 -1
- data/rbi/orb/models/plan_create_params.rbi +409 -4
- data/rbi/orb/models/plan_version.rbi +2 -1
- data/rbi/orb/models/price.rbi +716 -1
- data/rbi/orb/models/price_create_params.rbi +397 -4
- data/rbi/orb/models/price_edited_webhook_event.rbi +2 -1
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +397 -4
- data/rbi/orb/models/price_evaluate_preview_events_params.rbi +397 -4
- data/rbi/orb/models/price_interval.rbi +2 -1
- data/rbi/orb/models/subscription_create_params.rbi +2676 -1866
- data/rbi/orb/models/subscription_price_intervals_params.rbi +397 -4
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +2686 -1876
- data/rbi/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbi +5 -5
- data/rbi/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbi +5 -5
- data/rbi/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbi +5 -5
- data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +2 -1
- data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi +2 -1
- data/rbi/orb/resources/credit_blocks.rbi +1 -1
- data/rbi/orb/resources/prices.rbi +2 -1
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +322 -0
- data/sig/orb/models/beta_create_plan_version_params.rbs +322 -0
- data/sig/orb/models/credit_block_accounting_sync_failed_webhook_event.rbs +2 -2
- data/sig/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbs +2 -2
- data/sig/orb/models/credit_block_list_invoices_response.rbs +2 -2
- data/sig/orb/models/credit_block_retrieve_response.rbs +2 -2
- data/sig/orb/models/credit_block_update_response.rbs +2 -2
- data/sig/orb/models/customer_credit_ledger_incremented_webhook_event.rbs +2 -2
- data/sig/orb/models/plan_create_params.rbs +161 -0
- data/sig/orb/models/price.rbs +305 -0
- data/sig/orb/models/price_create_params.rbs +151 -0
- data/sig/orb/models/price_evaluate_multiple_params.rbs +156 -0
- data/sig/orb/models/price_evaluate_preview_events_params.rbs +156 -0
- data/sig/orb/models/subscription_create_params.rbs +322 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +156 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +322 -0
- data/sig/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbs +2 -2
- data/sig/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbs +2 -2
- data/sig/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbs +2 -2
- metadata +1 -1
|
@@ -365,7 +365,7 @@ module Orb
|
|
|
365
365
|
# @!attribute price
|
|
366
366
|
# New plan price request body params.
|
|
367
367
|
#
|
|
368
|
-
# @return [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::EventOutput, nil]
|
|
368
|
+
# @return [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::EventOutput, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier, nil]
|
|
369
369
|
optional :price, union: -> { Orb::BetaCreatePlanVersionParams::AddPrice::Price }, nil?: true
|
|
370
370
|
|
|
371
371
|
# @!method initialize(allocation_price: nil, license_allocation_price: nil, plan_phase_order: nil, price: nil)
|
|
@@ -375,7 +375,7 @@ module Orb
|
|
|
375
375
|
#
|
|
376
376
|
# @param plan_phase_order [Integer, nil] The phase to add this price to.
|
|
377
377
|
#
|
|
378
|
-
# @param price [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::EventOutput, nil] New plan price request body params.
|
|
378
|
+
# @param price [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::EventOutput, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier, nil] New plan price request body params.
|
|
379
379
|
|
|
380
380
|
# @see Orb::Models::BetaCreatePlanVersionParams::AddPrice#license_allocation_price
|
|
381
381
|
class LicenseAllocationPrice < Orb::Internal::Type::BaseModel
|
|
@@ -709,6 +709,9 @@ module Orb
|
|
|
709
709
|
|
|
710
710
|
variant :event_output, -> { Orb::BetaCreatePlanVersionParams::AddPrice::Price::EventOutput }
|
|
711
711
|
|
|
712
|
+
variant :unit_with_multiplier,
|
|
713
|
+
-> { Orb::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier }
|
|
714
|
+
|
|
712
715
|
class BulkWithFilters < Orb::Internal::Type::BaseModel
|
|
713
716
|
# @!attribute bulk_with_filters_config
|
|
714
717
|
# Configuration for bulk_with_filters pricing
|
|
@@ -3534,8 +3537,250 @@ module Orb
|
|
|
3534
3537
|
end
|
|
3535
3538
|
end
|
|
3536
3539
|
|
|
3540
|
+
class UnitWithMultiplier < Orb::Internal::Type::BaseModel
|
|
3541
|
+
# @!attribute cadence
|
|
3542
|
+
# The cadence to bill for this price on.
|
|
3543
|
+
#
|
|
3544
|
+
# @return [Symbol, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier::Cadence]
|
|
3545
|
+
required :cadence,
|
|
3546
|
+
enum: -> { Orb::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier::Cadence }
|
|
3547
|
+
|
|
3548
|
+
# @!attribute item_id
|
|
3549
|
+
# The id of the item the price will be associated with.
|
|
3550
|
+
#
|
|
3551
|
+
# @return [String]
|
|
3552
|
+
required :item_id, String
|
|
3553
|
+
|
|
3554
|
+
# @!attribute model_type
|
|
3555
|
+
# The pricing model type
|
|
3556
|
+
#
|
|
3557
|
+
# @return [Symbol, :unit_with_multiplier]
|
|
3558
|
+
required :model_type, const: :unit_with_multiplier
|
|
3559
|
+
|
|
3560
|
+
# @!attribute name
|
|
3561
|
+
# The name of the price.
|
|
3562
|
+
#
|
|
3563
|
+
# @return [String]
|
|
3564
|
+
required :name, String
|
|
3565
|
+
|
|
3566
|
+
# @!attribute unit_with_multiplier_config
|
|
3567
|
+
# Configuration for unit_with_multiplier pricing
|
|
3568
|
+
#
|
|
3569
|
+
# @return [Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig]
|
|
3570
|
+
required :unit_with_multiplier_config,
|
|
3571
|
+
-> { Orb::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig }
|
|
3572
|
+
|
|
3573
|
+
# @!attribute billable_metric_id
|
|
3574
|
+
# The id of the billable metric for the price. Only needed if the price is
|
|
3575
|
+
# usage-based.
|
|
3576
|
+
#
|
|
3577
|
+
# @return [String, nil]
|
|
3578
|
+
optional :billable_metric_id, String, nil?: true
|
|
3579
|
+
|
|
3580
|
+
# @!attribute billed_in_advance
|
|
3581
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
|
3582
|
+
# this is true, and in-arrears if this is false.
|
|
3583
|
+
#
|
|
3584
|
+
# @return [Boolean, nil]
|
|
3585
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
|
3586
|
+
|
|
3587
|
+
# @!attribute billing_cycle_configuration
|
|
3588
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
|
3589
|
+
# months.
|
|
3590
|
+
#
|
|
3591
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
3592
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
3593
|
+
|
|
3594
|
+
# @!attribute conversion_rate
|
|
3595
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
|
3596
|
+
#
|
|
3597
|
+
# @return [Float, nil]
|
|
3598
|
+
optional :conversion_rate, Float, nil?: true
|
|
3599
|
+
|
|
3600
|
+
# @!attribute conversion_rate_config
|
|
3601
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
|
3602
|
+
#
|
|
3603
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
|
3604
|
+
optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
|
|
3605
|
+
|
|
3606
|
+
# @!attribute currency
|
|
3607
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
3608
|
+
# price is billed.
|
|
3609
|
+
#
|
|
3610
|
+
# @return [String, nil]
|
|
3611
|
+
optional :currency, String, nil?: true
|
|
3612
|
+
|
|
3613
|
+
# @!attribute dimensional_price_configuration
|
|
3614
|
+
# For dimensional price: specifies a price group and dimension values
|
|
3615
|
+
#
|
|
3616
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
|
3617
|
+
optional :dimensional_price_configuration,
|
|
3618
|
+
-> {
|
|
3619
|
+
Orb::NewDimensionalPriceConfiguration
|
|
3620
|
+
},
|
|
3621
|
+
nil?: true
|
|
3622
|
+
|
|
3623
|
+
# @!attribute external_price_id
|
|
3624
|
+
# An alias for the price.
|
|
3625
|
+
#
|
|
3626
|
+
# @return [String, nil]
|
|
3627
|
+
optional :external_price_id, String, nil?: true
|
|
3628
|
+
|
|
3629
|
+
# @!attribute fixed_price_quantity
|
|
3630
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
|
3631
|
+
# applied.
|
|
3632
|
+
#
|
|
3633
|
+
# @return [Float, nil]
|
|
3634
|
+
optional :fixed_price_quantity, Float, nil?: true
|
|
3635
|
+
|
|
3636
|
+
# @!attribute invoice_grouping_key
|
|
3637
|
+
# The property used to group this price on an invoice
|
|
3638
|
+
#
|
|
3639
|
+
# @return [String, nil]
|
|
3640
|
+
optional :invoice_grouping_key, String, nil?: true
|
|
3641
|
+
|
|
3642
|
+
# @!attribute invoicing_cycle_configuration
|
|
3643
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3644
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
|
3645
|
+
#
|
|
3646
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
3647
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
3648
|
+
|
|
3649
|
+
# @!attribute license_type_id
|
|
3650
|
+
# The ID of the license type to associate with this price. On a usage price this
|
|
3651
|
+
# also marks the price as eligible to draw down from that license type's
|
|
3652
|
+
# allocation; a usage price created without it is billed normally. Usage prices
|
|
3653
|
+
# with a license type must use the `unit` model, and only draw down when their
|
|
3654
|
+
# currency matches the allocation's.
|
|
3655
|
+
#
|
|
3656
|
+
# @return [String, nil]
|
|
3657
|
+
optional :license_type_id, String, nil?: true
|
|
3658
|
+
|
|
3659
|
+
# @!attribute metadata
|
|
3660
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3661
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
3662
|
+
# by setting `metadata` to `null`.
|
|
3663
|
+
#
|
|
3664
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
|
3665
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
3666
|
+
|
|
3667
|
+
# @!attribute reference_id
|
|
3668
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
|
3669
|
+
# in the same API call.
|
|
3670
|
+
#
|
|
3671
|
+
# @return [String, nil]
|
|
3672
|
+
optional :reference_id, String, nil?: true
|
|
3673
|
+
|
|
3674
|
+
# @!method initialize(cadence:, item_id:, name:, unit_with_multiplier_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, reference_id: nil, model_type: :unit_with_multiplier)
|
|
3675
|
+
# Some parameter documentations has been truncated, see
|
|
3676
|
+
# {Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier}
|
|
3677
|
+
# for more details.
|
|
3678
|
+
#
|
|
3679
|
+
# @param cadence [Symbol, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier::Cadence] The cadence to bill for this price on.
|
|
3680
|
+
#
|
|
3681
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
|
3682
|
+
#
|
|
3683
|
+
# @param name [String] The name of the price.
|
|
3684
|
+
#
|
|
3685
|
+
# @param unit_with_multiplier_config [Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig] Configuration for unit_with_multiplier pricing
|
|
3686
|
+
#
|
|
3687
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
|
3688
|
+
#
|
|
3689
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
|
3690
|
+
#
|
|
3691
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
|
3692
|
+
#
|
|
3693
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
|
3694
|
+
#
|
|
3695
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
|
3696
|
+
#
|
|
3697
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
|
3698
|
+
#
|
|
3699
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
|
3700
|
+
#
|
|
3701
|
+
# @param external_price_id [String, nil] An alias for the price.
|
|
3702
|
+
#
|
|
3703
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
|
3704
|
+
#
|
|
3705
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
|
3706
|
+
#
|
|
3707
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
3708
|
+
#
|
|
3709
|
+
# @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
|
|
3710
|
+
#
|
|
3711
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
3712
|
+
#
|
|
3713
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
|
3714
|
+
#
|
|
3715
|
+
# @param model_type [Symbol, :unit_with_multiplier] The pricing model type
|
|
3716
|
+
|
|
3717
|
+
# The cadence to bill for this price on.
|
|
3718
|
+
#
|
|
3719
|
+
# @see Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier#cadence
|
|
3720
|
+
module Cadence
|
|
3721
|
+
extend Orb::Internal::Type::Enum
|
|
3722
|
+
|
|
3723
|
+
ONE_TIME = :one_time
|
|
3724
|
+
MONTHLY = :monthly
|
|
3725
|
+
QUARTERLY = :quarterly
|
|
3726
|
+
SEMI_ANNUAL = :semi_annual
|
|
3727
|
+
ANNUAL = :annual
|
|
3728
|
+
CUSTOM = :custom
|
|
3729
|
+
|
|
3730
|
+
# @!method self.values
|
|
3731
|
+
# @return [Array<Symbol>]
|
|
3732
|
+
end
|
|
3733
|
+
|
|
3734
|
+
# @see Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier#unit_with_multiplier_config
|
|
3735
|
+
class UnitWithMultiplierConfig < Orb::Internal::Type::BaseModel
|
|
3736
|
+
# @!attribute default_display_name
|
|
3737
|
+
# Sub-line label for list-price events that don't set display_name_key. Unlabeled
|
|
3738
|
+
# events with another multiplier are labeled by their multiplier (e.g. '0.8×
|
|
3739
|
+
# rate').
|
|
3740
|
+
#
|
|
3741
|
+
# @return [String]
|
|
3742
|
+
required :default_display_name, String
|
|
3743
|
+
|
|
3744
|
+
# @!attribute display_name_key
|
|
3745
|
+
# Event property holding the sub-line label for the event's rate (e.g.
|
|
3746
|
+
# 'Off-peak').
|
|
3747
|
+
#
|
|
3748
|
+
# @return [String]
|
|
3749
|
+
required :display_name_key, String
|
|
3750
|
+
|
|
3751
|
+
# @!attribute multiplier_key
|
|
3752
|
+
# Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
|
|
3753
|
+
# discount). Events without a number between 0 and 1000 with at most 12 decimal
|
|
3754
|
+
# places are charged at unit_amount.
|
|
3755
|
+
#
|
|
3756
|
+
# @return [String]
|
|
3757
|
+
required :multiplier_key, String
|
|
3758
|
+
|
|
3759
|
+
# @!attribute unit_amount
|
|
3760
|
+
# List price per unit, before the event's multiplier is applied.
|
|
3761
|
+
#
|
|
3762
|
+
# @return [String]
|
|
3763
|
+
required :unit_amount, String
|
|
3764
|
+
|
|
3765
|
+
# @!method initialize(default_display_name:, display_name_key:, multiplier_key:, unit_amount:)
|
|
3766
|
+
# Some parameter documentations has been truncated, see
|
|
3767
|
+
# {Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig}
|
|
3768
|
+
# for more details.
|
|
3769
|
+
#
|
|
3770
|
+
# Configuration for unit_with_multiplier pricing
|
|
3771
|
+
#
|
|
3772
|
+
# @param default_display_name [String] Sub-line label for list-price events that don't set display_name_key. Unlabeled
|
|
3773
|
+
#
|
|
3774
|
+
# @param display_name_key [String] Event property holding the sub-line label for the event's rate (e.g. 'Off-peak')
|
|
3775
|
+
#
|
|
3776
|
+
# @param multiplier_key [String] Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
|
|
3777
|
+
#
|
|
3778
|
+
# @param unit_amount [String] List price per unit, before the event's multiplier is applied.
|
|
3779
|
+
end
|
|
3780
|
+
end
|
|
3781
|
+
|
|
3537
3782
|
# @!method self.variants
|
|
3538
|
-
# @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::EventOutput)]
|
|
3783
|
+
# @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::EventOutput, Orb::Models::BetaCreatePlanVersionParams::AddPrice::Price::UnitWithMultiplier)]
|
|
3539
3784
|
end
|
|
3540
3785
|
end
|
|
3541
3786
|
|
|
@@ -3863,7 +4108,7 @@ module Orb
|
|
|
3863
4108
|
# @!attribute price
|
|
3864
4109
|
# New plan price request body params.
|
|
3865
4110
|
#
|
|
3866
|
-
# @return [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::EventOutput, nil]
|
|
4111
|
+
# @return [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::EventOutput, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier, nil]
|
|
3867
4112
|
optional :price, union: -> { Orb::BetaCreatePlanVersionParams::ReplacePrice::Price }, nil?: true
|
|
3868
4113
|
|
|
3869
4114
|
# @!method initialize(replaces_price_id:, allocation_price: nil, license_allocation_price: nil, plan_phase_order: nil, price: nil)
|
|
@@ -3875,7 +4120,7 @@ module Orb
|
|
|
3875
4120
|
#
|
|
3876
4121
|
# @param plan_phase_order [Integer, nil] The phase to replace this price from.
|
|
3877
4122
|
#
|
|
3878
|
-
# @param price [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::EventOutput, nil] New plan price request body params.
|
|
4123
|
+
# @param price [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::EventOutput, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier, nil] New plan price request body params.
|
|
3879
4124
|
|
|
3880
4125
|
# @see Orb::Models::BetaCreatePlanVersionParams::ReplacePrice#license_allocation_price
|
|
3881
4126
|
class LicenseAllocationPrice < Orb::Internal::Type::BaseModel
|
|
@@ -4209,6 +4454,9 @@ module Orb
|
|
|
4209
4454
|
|
|
4210
4455
|
variant :event_output, -> { Orb::BetaCreatePlanVersionParams::ReplacePrice::Price::EventOutput }
|
|
4211
4456
|
|
|
4457
|
+
variant :unit_with_multiplier,
|
|
4458
|
+
-> { Orb::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier }
|
|
4459
|
+
|
|
4212
4460
|
class BulkWithFilters < Orb::Internal::Type::BaseModel
|
|
4213
4461
|
# @!attribute bulk_with_filters_config
|
|
4214
4462
|
# Configuration for bulk_with_filters pricing
|
|
@@ -7044,8 +7292,250 @@ module Orb
|
|
|
7044
7292
|
end
|
|
7045
7293
|
end
|
|
7046
7294
|
|
|
7295
|
+
class UnitWithMultiplier < Orb::Internal::Type::BaseModel
|
|
7296
|
+
# @!attribute cadence
|
|
7297
|
+
# The cadence to bill for this price on.
|
|
7298
|
+
#
|
|
7299
|
+
# @return [Symbol, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier::Cadence]
|
|
7300
|
+
required :cadence,
|
|
7301
|
+
enum: -> { Orb::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier::Cadence }
|
|
7302
|
+
|
|
7303
|
+
# @!attribute item_id
|
|
7304
|
+
# The id of the item the price will be associated with.
|
|
7305
|
+
#
|
|
7306
|
+
# @return [String]
|
|
7307
|
+
required :item_id, String
|
|
7308
|
+
|
|
7309
|
+
# @!attribute model_type
|
|
7310
|
+
# The pricing model type
|
|
7311
|
+
#
|
|
7312
|
+
# @return [Symbol, :unit_with_multiplier]
|
|
7313
|
+
required :model_type, const: :unit_with_multiplier
|
|
7314
|
+
|
|
7315
|
+
# @!attribute name
|
|
7316
|
+
# The name of the price.
|
|
7317
|
+
#
|
|
7318
|
+
# @return [String]
|
|
7319
|
+
required :name, String
|
|
7320
|
+
|
|
7321
|
+
# @!attribute unit_with_multiplier_config
|
|
7322
|
+
# Configuration for unit_with_multiplier pricing
|
|
7323
|
+
#
|
|
7324
|
+
# @return [Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig]
|
|
7325
|
+
required :unit_with_multiplier_config,
|
|
7326
|
+
-> { Orb::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig }
|
|
7327
|
+
|
|
7328
|
+
# @!attribute billable_metric_id
|
|
7329
|
+
# The id of the billable metric for the price. Only needed if the price is
|
|
7330
|
+
# usage-based.
|
|
7331
|
+
#
|
|
7332
|
+
# @return [String, nil]
|
|
7333
|
+
optional :billable_metric_id, String, nil?: true
|
|
7334
|
+
|
|
7335
|
+
# @!attribute billed_in_advance
|
|
7336
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
|
7337
|
+
# this is true, and in-arrears if this is false.
|
|
7338
|
+
#
|
|
7339
|
+
# @return [Boolean, nil]
|
|
7340
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
|
7341
|
+
|
|
7342
|
+
# @!attribute billing_cycle_configuration
|
|
7343
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
|
7344
|
+
# months.
|
|
7345
|
+
#
|
|
7346
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
7347
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
7348
|
+
|
|
7349
|
+
# @!attribute conversion_rate
|
|
7350
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
|
7351
|
+
#
|
|
7352
|
+
# @return [Float, nil]
|
|
7353
|
+
optional :conversion_rate, Float, nil?: true
|
|
7354
|
+
|
|
7355
|
+
# @!attribute conversion_rate_config
|
|
7356
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
|
7357
|
+
#
|
|
7358
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
|
7359
|
+
optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
|
|
7360
|
+
|
|
7361
|
+
# @!attribute currency
|
|
7362
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
|
7363
|
+
# price is billed.
|
|
7364
|
+
#
|
|
7365
|
+
# @return [String, nil]
|
|
7366
|
+
optional :currency, String, nil?: true
|
|
7367
|
+
|
|
7368
|
+
# @!attribute dimensional_price_configuration
|
|
7369
|
+
# For dimensional price: specifies a price group and dimension values
|
|
7370
|
+
#
|
|
7371
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
|
7372
|
+
optional :dimensional_price_configuration,
|
|
7373
|
+
-> {
|
|
7374
|
+
Orb::NewDimensionalPriceConfiguration
|
|
7375
|
+
},
|
|
7376
|
+
nil?: true
|
|
7377
|
+
|
|
7378
|
+
# @!attribute external_price_id
|
|
7379
|
+
# An alias for the price.
|
|
7380
|
+
#
|
|
7381
|
+
# @return [String, nil]
|
|
7382
|
+
optional :external_price_id, String, nil?: true
|
|
7383
|
+
|
|
7384
|
+
# @!attribute fixed_price_quantity
|
|
7385
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
|
7386
|
+
# applied.
|
|
7387
|
+
#
|
|
7388
|
+
# @return [Float, nil]
|
|
7389
|
+
optional :fixed_price_quantity, Float, nil?: true
|
|
7390
|
+
|
|
7391
|
+
# @!attribute invoice_grouping_key
|
|
7392
|
+
# The property used to group this price on an invoice
|
|
7393
|
+
#
|
|
7394
|
+
# @return [String, nil]
|
|
7395
|
+
optional :invoice_grouping_key, String, nil?: true
|
|
7396
|
+
|
|
7397
|
+
# @!attribute invoicing_cycle_configuration
|
|
7398
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
7399
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
|
7400
|
+
#
|
|
7401
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
|
7402
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
|
7403
|
+
|
|
7404
|
+
# @!attribute license_type_id
|
|
7405
|
+
# The ID of the license type to associate with this price. On a usage price this
|
|
7406
|
+
# also marks the price as eligible to draw down from that license type's
|
|
7407
|
+
# allocation; a usage price created without it is billed normally. Usage prices
|
|
7408
|
+
# with a license type must use the `unit` model, and only draw down when their
|
|
7409
|
+
# currency matches the allocation's.
|
|
7410
|
+
#
|
|
7411
|
+
# @return [String, nil]
|
|
7412
|
+
optional :license_type_id, String, nil?: true
|
|
7413
|
+
|
|
7414
|
+
# @!attribute metadata
|
|
7415
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
|
7416
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
|
7417
|
+
# by setting `metadata` to `null`.
|
|
7418
|
+
#
|
|
7419
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
|
7420
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
|
7421
|
+
|
|
7422
|
+
# @!attribute reference_id
|
|
7423
|
+
# A transient ID that can be used to reference this price when adding adjustments
|
|
7424
|
+
# in the same API call.
|
|
7425
|
+
#
|
|
7426
|
+
# @return [String, nil]
|
|
7427
|
+
optional :reference_id, String, nil?: true
|
|
7428
|
+
|
|
7429
|
+
# @!method initialize(cadence:, item_id:, name:, unit_with_multiplier_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, reference_id: nil, model_type: :unit_with_multiplier)
|
|
7430
|
+
# Some parameter documentations has been truncated, see
|
|
7431
|
+
# {Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier}
|
|
7432
|
+
# for more details.
|
|
7433
|
+
#
|
|
7434
|
+
# @param cadence [Symbol, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier::Cadence] The cadence to bill for this price on.
|
|
7435
|
+
#
|
|
7436
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
|
7437
|
+
#
|
|
7438
|
+
# @param name [String] The name of the price.
|
|
7439
|
+
#
|
|
7440
|
+
# @param unit_with_multiplier_config [Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig] Configuration for unit_with_multiplier pricing
|
|
7441
|
+
#
|
|
7442
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
|
7443
|
+
#
|
|
7444
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
|
7445
|
+
#
|
|
7446
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
|
7447
|
+
#
|
|
7448
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
|
7449
|
+
#
|
|
7450
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
|
7451
|
+
#
|
|
7452
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
|
7453
|
+
#
|
|
7454
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
|
7455
|
+
#
|
|
7456
|
+
# @param external_price_id [String, nil] An alias for the price.
|
|
7457
|
+
#
|
|
7458
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
|
7459
|
+
#
|
|
7460
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
|
7461
|
+
#
|
|
7462
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
|
7463
|
+
#
|
|
7464
|
+
# @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
|
|
7465
|
+
#
|
|
7466
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
7467
|
+
#
|
|
7468
|
+
# @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
|
|
7469
|
+
#
|
|
7470
|
+
# @param model_type [Symbol, :unit_with_multiplier] The pricing model type
|
|
7471
|
+
|
|
7472
|
+
# The cadence to bill for this price on.
|
|
7473
|
+
#
|
|
7474
|
+
# @see Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier#cadence
|
|
7475
|
+
module Cadence
|
|
7476
|
+
extend Orb::Internal::Type::Enum
|
|
7477
|
+
|
|
7478
|
+
ONE_TIME = :one_time
|
|
7479
|
+
MONTHLY = :monthly
|
|
7480
|
+
QUARTERLY = :quarterly
|
|
7481
|
+
SEMI_ANNUAL = :semi_annual
|
|
7482
|
+
ANNUAL = :annual
|
|
7483
|
+
CUSTOM = :custom
|
|
7484
|
+
|
|
7485
|
+
# @!method self.values
|
|
7486
|
+
# @return [Array<Symbol>]
|
|
7487
|
+
end
|
|
7488
|
+
|
|
7489
|
+
# @see Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier#unit_with_multiplier_config
|
|
7490
|
+
class UnitWithMultiplierConfig < Orb::Internal::Type::BaseModel
|
|
7491
|
+
# @!attribute default_display_name
|
|
7492
|
+
# Sub-line label for list-price events that don't set display_name_key. Unlabeled
|
|
7493
|
+
# events with another multiplier are labeled by their multiplier (e.g. '0.8×
|
|
7494
|
+
# rate').
|
|
7495
|
+
#
|
|
7496
|
+
# @return [String]
|
|
7497
|
+
required :default_display_name, String
|
|
7498
|
+
|
|
7499
|
+
# @!attribute display_name_key
|
|
7500
|
+
# Event property holding the sub-line label for the event's rate (e.g.
|
|
7501
|
+
# 'Off-peak').
|
|
7502
|
+
#
|
|
7503
|
+
# @return [String]
|
|
7504
|
+
required :display_name_key, String
|
|
7505
|
+
|
|
7506
|
+
# @!attribute multiplier_key
|
|
7507
|
+
# Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
|
|
7508
|
+
# discount). Events without a number between 0 and 1000 with at most 12 decimal
|
|
7509
|
+
# places are charged at unit_amount.
|
|
7510
|
+
#
|
|
7511
|
+
# @return [String]
|
|
7512
|
+
required :multiplier_key, String
|
|
7513
|
+
|
|
7514
|
+
# @!attribute unit_amount
|
|
7515
|
+
# List price per unit, before the event's multiplier is applied.
|
|
7516
|
+
#
|
|
7517
|
+
# @return [String]
|
|
7518
|
+
required :unit_amount, String
|
|
7519
|
+
|
|
7520
|
+
# @!method initialize(default_display_name:, display_name_key:, multiplier_key:, unit_amount:)
|
|
7521
|
+
# Some parameter documentations has been truncated, see
|
|
7522
|
+
# {Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig}
|
|
7523
|
+
# for more details.
|
|
7524
|
+
#
|
|
7525
|
+
# Configuration for unit_with_multiplier pricing
|
|
7526
|
+
#
|
|
7527
|
+
# @param default_display_name [String] Sub-line label for list-price events that don't set display_name_key. Unlabeled
|
|
7528
|
+
#
|
|
7529
|
+
# @param display_name_key [String] Event property holding the sub-line label for the event's rate (e.g. 'Off-peak')
|
|
7530
|
+
#
|
|
7531
|
+
# @param multiplier_key [String] Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
|
|
7532
|
+
#
|
|
7533
|
+
# @param unit_amount [String] List price per unit, before the event's multiplier is applied.
|
|
7534
|
+
end
|
|
7535
|
+
end
|
|
7536
|
+
|
|
7047
7537
|
# @!method self.variants
|
|
7048
|
-
# @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::EventOutput)]
|
|
7538
|
+
# @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanGroupedTieredPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewPlanMinimumCompositePrice, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::Percent, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::EventOutput, Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::Price::UnitWithMultiplier)]
|
|
7049
7539
|
end
|
|
7050
7540
|
end
|
|
7051
7541
|
end
|
|
@@ -902,7 +902,7 @@ module Orb
|
|
|
902
902
|
# For more on the types of prices, see
|
|
903
903
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
904
904
|
#
|
|
905
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
905
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput, Orb::Models::Price::UnitWithMultiplier]
|
|
906
906
|
required :price, union: -> { Orb::Price }
|
|
907
907
|
|
|
908
908
|
# @!attribute quantity
|
|
@@ -969,7 +969,7 @@ module Orb
|
|
|
969
969
|
#
|
|
970
970
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
|
971
971
|
#
|
|
972
|
-
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
|
|
972
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput, Orb::Models::Price::UnitWithMultiplier] The Price resource represents a price that can be billed on a subscription, resu
|
|
973
973
|
#
|
|
974
974
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
|
975
975
|
#
|