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.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +496 -6
  5. data/lib/orb/models/beta_create_plan_version_params.rb +496 -6
  6. data/lib/orb/models/changed_subscription_resources.rb +2 -2
  7. data/lib/orb/models/credit_block_accounting_sync_failed_webhook_event.rb +4 -4
  8. data/lib/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rb +4 -4
  9. data/lib/orb/models/credit_block_list_invoices_response.rb +4 -4
  10. data/lib/orb/models/credit_block_retrieve_response.rb +4 -4
  11. data/lib/orb/models/credit_block_update_response.rb +4 -4
  12. data/lib/orb/models/customer_credit_ledger_incremented_webhook_event.rb +4 -4
  13. data/lib/orb/models/dimensional_price_groups/price_create_response.rb +2 -2
  14. data/lib/orb/models/invoice.rb +2 -2
  15. data/lib/orb/models/invoice_edited_webhook_event.rb +2 -2
  16. data/lib/orb/models/invoice_fetch_upcoming_response.rb +2 -2
  17. data/lib/orb/models/invoice_line_item_create_response.rb +2 -2
  18. data/lib/orb/models/per_price_cost.rb +2 -2
  19. data/lib/orb/models/plan.rb +2 -2
  20. data/lib/orb/models/plan_create_params.rb +246 -3
  21. data/lib/orb/models/plan_version.rb +2 -2
  22. data/lib/orb/models/price.rb +416 -1
  23. data/lib/orb/models/price_create_params.rb +231 -3
  24. data/lib/orb/models/price_edited_webhook_event.rb +2 -2
  25. data/lib/orb/models/price_evaluate_multiple_params.rb +238 -3
  26. data/lib/orb/models/price_evaluate_preview_events_params.rb +238 -3
  27. data/lib/orb/models/price_interval.rb +2 -2
  28. data/lib/orb/models/subscription_create_params.rb +495 -6
  29. data/lib/orb/models/subscription_price_intervals_params.rb +238 -3
  30. data/lib/orb/models/subscription_schedule_plan_change_params.rb +496 -6
  31. data/lib/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rb +4 -4
  32. data/lib/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rb +4 -4
  33. data/lib/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rb +4 -4
  34. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +2 -2
  35. data/lib/orb/models/webhooks/price_edited_standard_webhook_event.rb +2 -2
  36. data/lib/orb/resources/credit_blocks.rb +1 -1
  37. data/lib/orb/resources/dimensional_price_groups/prices.rb +1 -1
  38. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  39. data/lib/orb/resources/prices.rb +5 -5
  40. data/lib/orb/version.rb +1 -1
  41. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +2939 -2129
  42. data/rbi/orb/models/beta_create_plan_version_params.rbi +2937 -2127
  43. data/rbi/orb/models/changed_subscription_resources.rbi +2 -1
  44. data/rbi/orb/models/credit_block_accounting_sync_failed_webhook_event.rbi +5 -5
  45. data/rbi/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbi +5 -5
  46. data/rbi/orb/models/credit_block_list_invoices_response.rbi +5 -5
  47. data/rbi/orb/models/credit_block_retrieve_response.rbi +5 -5
  48. data/rbi/orb/models/credit_block_update_response.rbi +5 -5
  49. data/rbi/orb/models/customer_credit_ledger_incremented_webhook_event.rbi +5 -5
  50. data/rbi/orb/models/dimensional_price_groups/price_create_response.rbi +2 -1
  51. data/rbi/orb/models/invoice.rbi +2 -1
  52. data/rbi/orb/models/invoice_edited_webhook_event.rbi +2 -1
  53. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2 -1
  54. data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -1
  55. data/rbi/orb/models/per_price_cost.rbi +2 -1
  56. data/rbi/orb/models/plan.rbi +2 -1
  57. data/rbi/orb/models/plan_create_params.rbi +409 -4
  58. data/rbi/orb/models/plan_version.rbi +2 -1
  59. data/rbi/orb/models/price.rbi +716 -1
  60. data/rbi/orb/models/price_create_params.rbi +397 -4
  61. data/rbi/orb/models/price_edited_webhook_event.rbi +2 -1
  62. data/rbi/orb/models/price_evaluate_multiple_params.rbi +397 -4
  63. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +397 -4
  64. data/rbi/orb/models/price_interval.rbi +2 -1
  65. data/rbi/orb/models/subscription_create_params.rbi +2676 -1866
  66. data/rbi/orb/models/subscription_price_intervals_params.rbi +397 -4
  67. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +2686 -1876
  68. data/rbi/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbi +5 -5
  69. data/rbi/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbi +5 -5
  70. data/rbi/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbi +5 -5
  71. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +2 -1
  72. data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi +2 -1
  73. data/rbi/orb/resources/credit_blocks.rbi +1 -1
  74. data/rbi/orb/resources/prices.rbi +2 -1
  75. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +322 -0
  76. data/sig/orb/models/beta_create_plan_version_params.rbs +322 -0
  77. data/sig/orb/models/credit_block_accounting_sync_failed_webhook_event.rbs +2 -2
  78. data/sig/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbs +2 -2
  79. data/sig/orb/models/credit_block_list_invoices_response.rbs +2 -2
  80. data/sig/orb/models/credit_block_retrieve_response.rbs +2 -2
  81. data/sig/orb/models/credit_block_update_response.rbs +2 -2
  82. data/sig/orb/models/customer_credit_ledger_incremented_webhook_event.rbs +2 -2
  83. data/sig/orb/models/plan_create_params.rbs +161 -0
  84. data/sig/orb/models/price.rbs +305 -0
  85. data/sig/orb/models/price_create_params.rbs +151 -0
  86. data/sig/orb/models/price_evaluate_multiple_params.rbs +156 -0
  87. data/sig/orb/models/price_evaluate_preview_events_params.rbs +156 -0
  88. data/sig/orb/models/subscription_create_params.rbs +322 -0
  89. data/sig/orb/models/subscription_price_intervals_params.rbs +156 -0
  90. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +322 -0
  91. data/sig/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbs +2 -2
  92. data/sig/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbs +2 -2
  93. data/sig/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbs +2 -2
  94. metadata +1 -1
@@ -639,7 +639,7 @@ module Orb
639
639
  # @!attribute price
640
640
  # New subscription price request body params.
641
641
  #
642
- # @return [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::EventOutput, nil]
642
+ # @return [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::EventOutput, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier, nil]
643
643
  optional :price, union: -> { Orb::SubscriptionSchedulePlanChangeParams::AddPrice::Price }, nil?: true
644
644
 
645
645
  # @!attribute price_id
@@ -676,7 +676,7 @@ module Orb
676
676
  #
677
677
  # @param plan_phase_order [Integer, nil] The phase to add this price to.
678
678
  #
679
- # @param price [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::EventOutput, nil] New subscription price request body params.
679
+ # @param price [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::EventOutput, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier, nil] New subscription price request body params.
680
680
  #
681
681
  # @param price_id [String, nil] The id of the price to add to the subscription.
682
682
  #
@@ -772,6 +772,9 @@ module Orb
772
772
 
773
773
  variant :event_output, -> { Orb::SubscriptionSchedulePlanChangeParams::AddPrice::Price::EventOutput }
774
774
 
775
+ variant :unit_with_multiplier,
776
+ -> { Orb::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier }
777
+
775
778
  class BulkWithFilters < Orb::Internal::Type::BaseModel
776
779
  # @!attribute bulk_with_filters_config
777
780
  # Configuration for bulk_with_filters pricing
@@ -3608,8 +3611,250 @@ module Orb
3608
3611
  end
3609
3612
  end
3610
3613
 
3614
+ class UnitWithMultiplier < Orb::Internal::Type::BaseModel
3615
+ # @!attribute cadence
3616
+ # The cadence to bill for this price on.
3617
+ #
3618
+ # @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier::Cadence]
3619
+ required :cadence,
3620
+ enum: -> { Orb::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier::Cadence }
3621
+
3622
+ # @!attribute item_id
3623
+ # The id of the item the price will be associated with.
3624
+ #
3625
+ # @return [String]
3626
+ required :item_id, String
3627
+
3628
+ # @!attribute model_type
3629
+ # The pricing model type
3630
+ #
3631
+ # @return [Symbol, :unit_with_multiplier]
3632
+ required :model_type, const: :unit_with_multiplier
3633
+
3634
+ # @!attribute name
3635
+ # The name of the price.
3636
+ #
3637
+ # @return [String]
3638
+ required :name, String
3639
+
3640
+ # @!attribute unit_with_multiplier_config
3641
+ # Configuration for unit_with_multiplier pricing
3642
+ #
3643
+ # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig]
3644
+ required :unit_with_multiplier_config,
3645
+ -> { Orb::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig }
3646
+
3647
+ # @!attribute billable_metric_id
3648
+ # The id of the billable metric for the price. Only needed if the price is
3649
+ # usage-based.
3650
+ #
3651
+ # @return [String, nil]
3652
+ optional :billable_metric_id, String, nil?: true
3653
+
3654
+ # @!attribute billed_in_advance
3655
+ # If the Price represents a fixed cost, the price will be billed in-advance if
3656
+ # this is true, and in-arrears if this is false.
3657
+ #
3658
+ # @return [Boolean, nil]
3659
+ optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
3660
+
3661
+ # @!attribute billing_cycle_configuration
3662
+ # For custom cadence: specifies the duration of the billing period in days or
3663
+ # months.
3664
+ #
3665
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
3666
+ optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
3667
+
3668
+ # @!attribute conversion_rate
3669
+ # The per unit conversion rate of the price currency to the invoicing currency.
3670
+ #
3671
+ # @return [Float, nil]
3672
+ optional :conversion_rate, Float, nil?: true
3673
+
3674
+ # @!attribute conversion_rate_config
3675
+ # The configuration for the rate of the price currency to the invoicing currency.
3676
+ #
3677
+ # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
3678
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
3679
+
3680
+ # @!attribute currency
3681
+ # An ISO 4217 currency string, or custom pricing unit identifier, in which this
3682
+ # price is billed.
3683
+ #
3684
+ # @return [String, nil]
3685
+ optional :currency, String, nil?: true
3686
+
3687
+ # @!attribute dimensional_price_configuration
3688
+ # For dimensional price: specifies a price group and dimension values
3689
+ #
3690
+ # @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
3691
+ optional :dimensional_price_configuration,
3692
+ -> {
3693
+ Orb::NewDimensionalPriceConfiguration
3694
+ },
3695
+ nil?: true
3696
+
3697
+ # @!attribute external_price_id
3698
+ # An alias for the price.
3699
+ #
3700
+ # @return [String, nil]
3701
+ optional :external_price_id, String, nil?: true
3702
+
3703
+ # @!attribute fixed_price_quantity
3704
+ # If the Price represents a fixed cost, this represents the quantity of units
3705
+ # applied.
3706
+ #
3707
+ # @return [Float, nil]
3708
+ optional :fixed_price_quantity, Float, nil?: true
3709
+
3710
+ # @!attribute invoice_grouping_key
3711
+ # The property used to group this price on an invoice
3712
+ #
3713
+ # @return [String, nil]
3714
+ optional :invoice_grouping_key, String, nil?: true
3715
+
3716
+ # @!attribute invoicing_cycle_configuration
3717
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
3718
+ # If unspecified, a single invoice is produced per billing cycle.
3719
+ #
3720
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
3721
+ optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
3722
+
3723
+ # @!attribute license_type_id
3724
+ # The ID of the license type to associate with this price. On a usage price this
3725
+ # also marks the price as eligible to draw down from that license type's
3726
+ # allocation; a usage price created without it is billed normally. Usage prices
3727
+ # with a license type must use the `unit` model, and only draw down when their
3728
+ # currency matches the allocation's.
3729
+ #
3730
+ # @return [String, nil]
3731
+ optional :license_type_id, String, nil?: true
3732
+
3733
+ # @!attribute metadata
3734
+ # User-specified key/value pairs for the resource. Individual keys can be removed
3735
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
3736
+ # by setting `metadata` to `null`.
3737
+ #
3738
+ # @return [Hash{Symbol=>String, nil}, nil]
3739
+ optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
3740
+
3741
+ # @!attribute reference_id
3742
+ # A transient ID that can be used to reference this price when adding adjustments
3743
+ # in the same API call.
3744
+ #
3745
+ # @return [String, nil]
3746
+ optional :reference_id, String, nil?: true
3747
+
3748
+ # @!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)
3749
+ # Some parameter documentations has been truncated, see
3750
+ # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier}
3751
+ # for more details.
3752
+ #
3753
+ # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier::Cadence] The cadence to bill for this price on.
3754
+ #
3755
+ # @param item_id [String] The id of the item the price will be associated with.
3756
+ #
3757
+ # @param name [String] The name of the price.
3758
+ #
3759
+ # @param unit_with_multiplier_config [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig] Configuration for unit_with_multiplier pricing
3760
+ #
3761
+ # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
3762
+ #
3763
+ # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
3764
+ #
3765
+ # @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
3766
+ #
3767
+ # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
3768
+ #
3769
+ # @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
3770
+ #
3771
+ # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
3772
+ #
3773
+ # @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
3774
+ #
3775
+ # @param external_price_id [String, nil] An alias for the price.
3776
+ #
3777
+ # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
3778
+ #
3779
+ # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
3780
+ #
3781
+ # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
3782
+ #
3783
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
3784
+ #
3785
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
3786
+ #
3787
+ # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
3788
+ #
3789
+ # @param model_type [Symbol, :unit_with_multiplier] The pricing model type
3790
+
3791
+ # The cadence to bill for this price on.
3792
+ #
3793
+ # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier#cadence
3794
+ module Cadence
3795
+ extend Orb::Internal::Type::Enum
3796
+
3797
+ ONE_TIME = :one_time
3798
+ MONTHLY = :monthly
3799
+ QUARTERLY = :quarterly
3800
+ SEMI_ANNUAL = :semi_annual
3801
+ ANNUAL = :annual
3802
+ CUSTOM = :custom
3803
+
3804
+ # @!method self.values
3805
+ # @return [Array<Symbol>]
3806
+ end
3807
+
3808
+ # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier#unit_with_multiplier_config
3809
+ class UnitWithMultiplierConfig < Orb::Internal::Type::BaseModel
3810
+ # @!attribute default_display_name
3811
+ # Sub-line label for list-price events that don't set display_name_key. Unlabeled
3812
+ # events with another multiplier are labeled by their multiplier (e.g. '0.8×
3813
+ # rate').
3814
+ #
3815
+ # @return [String]
3816
+ required :default_display_name, String
3817
+
3818
+ # @!attribute display_name_key
3819
+ # Event property holding the sub-line label for the event's rate (e.g.
3820
+ # 'Off-peak').
3821
+ #
3822
+ # @return [String]
3823
+ required :display_name_key, String
3824
+
3825
+ # @!attribute multiplier_key
3826
+ # Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
3827
+ # discount). Events without a number between 0 and 1000 with at most 12 decimal
3828
+ # places are charged at unit_amount.
3829
+ #
3830
+ # @return [String]
3831
+ required :multiplier_key, String
3832
+
3833
+ # @!attribute unit_amount
3834
+ # List price per unit, before the event's multiplier is applied.
3835
+ #
3836
+ # @return [String]
3837
+ required :unit_amount, String
3838
+
3839
+ # @!method initialize(default_display_name:, display_name_key:, multiplier_key:, unit_amount:)
3840
+ # Some parameter documentations has been truncated, see
3841
+ # {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig}
3842
+ # for more details.
3843
+ #
3844
+ # Configuration for unit_with_multiplier pricing
3845
+ #
3846
+ # @param default_display_name [String] Sub-line label for list-price events that don't set display_name_key. Unlabeled
3847
+ #
3848
+ # @param display_name_key [String] Event property holding the sub-line label for the event's rate (e.g. 'Off-peak')
3849
+ #
3850
+ # @param multiplier_key [String] Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
3851
+ #
3852
+ # @param unit_amount [String] List price per unit, before the event's multiplier is applied.
3853
+ end
3854
+ end
3855
+
3611
3856
  # @!method self.variants
3612
- # @return [Array(Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::EventOutput)]
3857
+ # @return [Array(Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::EventOutput, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::UnitWithMultiplier)]
3613
3858
  end
3614
3859
  end
3615
3860
 
@@ -3984,7 +4229,7 @@ module Orb
3984
4229
  # @!attribute price
3985
4230
  # New subscription price request body params.
3986
4231
  #
3987
- # @return [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::EventOutput, nil]
4232
+ # @return [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::EventOutput, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier, nil]
3988
4233
  optional :price,
3989
4234
  union: -> {
3990
4235
  Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price
@@ -4020,7 +4265,7 @@ module Orb
4020
4265
  #
4021
4266
  # @param plan_phase_order [Integer, nil] The phase to replace this price in.
4022
4267
  #
4023
- # @param price [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::EventOutput, nil] New subscription price request body params.
4268
+ # @param price [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::EventOutput, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier, nil] New subscription price request body params.
4024
4269
  #
4025
4270
  # @param price_id [String, nil] The id of the price to add to the subscription.
4026
4271
 
@@ -4114,6 +4359,9 @@ module Orb
4114
4359
 
4115
4360
  variant :event_output, -> { Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::EventOutput }
4116
4361
 
4362
+ variant :unit_with_multiplier,
4363
+ -> { Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier }
4364
+
4117
4365
  class BulkWithFilters < Orb::Internal::Type::BaseModel
4118
4366
  # @!attribute bulk_with_filters_config
4119
4367
  # Configuration for bulk_with_filters pricing
@@ -6958,8 +7206,250 @@ module Orb
6958
7206
  end
6959
7207
  end
6960
7208
 
7209
+ class UnitWithMultiplier < Orb::Internal::Type::BaseModel
7210
+ # @!attribute cadence
7211
+ # The cadence to bill for this price on.
7212
+ #
7213
+ # @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier::Cadence]
7214
+ required :cadence,
7215
+ enum: -> { Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier::Cadence }
7216
+
7217
+ # @!attribute item_id
7218
+ # The id of the item the price will be associated with.
7219
+ #
7220
+ # @return [String]
7221
+ required :item_id, String
7222
+
7223
+ # @!attribute model_type
7224
+ # The pricing model type
7225
+ #
7226
+ # @return [Symbol, :unit_with_multiplier]
7227
+ required :model_type, const: :unit_with_multiplier
7228
+
7229
+ # @!attribute name
7230
+ # The name of the price.
7231
+ #
7232
+ # @return [String]
7233
+ required :name, String
7234
+
7235
+ # @!attribute unit_with_multiplier_config
7236
+ # Configuration for unit_with_multiplier pricing
7237
+ #
7238
+ # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig]
7239
+ required :unit_with_multiplier_config,
7240
+ -> { Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig }
7241
+
7242
+ # @!attribute billable_metric_id
7243
+ # The id of the billable metric for the price. Only needed if the price is
7244
+ # usage-based.
7245
+ #
7246
+ # @return [String, nil]
7247
+ optional :billable_metric_id, String, nil?: true
7248
+
7249
+ # @!attribute billed_in_advance
7250
+ # If the Price represents a fixed cost, the price will be billed in-advance if
7251
+ # this is true, and in-arrears if this is false.
7252
+ #
7253
+ # @return [Boolean, nil]
7254
+ optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
7255
+
7256
+ # @!attribute billing_cycle_configuration
7257
+ # For custom cadence: specifies the duration of the billing period in days or
7258
+ # months.
7259
+ #
7260
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
7261
+ optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
7262
+
7263
+ # @!attribute conversion_rate
7264
+ # The per unit conversion rate of the price currency to the invoicing currency.
7265
+ #
7266
+ # @return [Float, nil]
7267
+ optional :conversion_rate, Float, nil?: true
7268
+
7269
+ # @!attribute conversion_rate_config
7270
+ # The configuration for the rate of the price currency to the invoicing currency.
7271
+ #
7272
+ # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
7273
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
7274
+
7275
+ # @!attribute currency
7276
+ # An ISO 4217 currency string, or custom pricing unit identifier, in which this
7277
+ # price is billed.
7278
+ #
7279
+ # @return [String, nil]
7280
+ optional :currency, String, nil?: true
7281
+
7282
+ # @!attribute dimensional_price_configuration
7283
+ # For dimensional price: specifies a price group and dimension values
7284
+ #
7285
+ # @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
7286
+ optional :dimensional_price_configuration,
7287
+ -> {
7288
+ Orb::NewDimensionalPriceConfiguration
7289
+ },
7290
+ nil?: true
7291
+
7292
+ # @!attribute external_price_id
7293
+ # An alias for the price.
7294
+ #
7295
+ # @return [String, nil]
7296
+ optional :external_price_id, String, nil?: true
7297
+
7298
+ # @!attribute fixed_price_quantity
7299
+ # If the Price represents a fixed cost, this represents the quantity of units
7300
+ # applied.
7301
+ #
7302
+ # @return [Float, nil]
7303
+ optional :fixed_price_quantity, Float, nil?: true
7304
+
7305
+ # @!attribute invoice_grouping_key
7306
+ # The property used to group this price on an invoice
7307
+ #
7308
+ # @return [String, nil]
7309
+ optional :invoice_grouping_key, String, nil?: true
7310
+
7311
+ # @!attribute invoicing_cycle_configuration
7312
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
7313
+ # If unspecified, a single invoice is produced per billing cycle.
7314
+ #
7315
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
7316
+ optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
7317
+
7318
+ # @!attribute license_type_id
7319
+ # The ID of the license type to associate with this price. On a usage price this
7320
+ # also marks the price as eligible to draw down from that license type's
7321
+ # allocation; a usage price created without it is billed normally. Usage prices
7322
+ # with a license type must use the `unit` model, and only draw down when their
7323
+ # currency matches the allocation's.
7324
+ #
7325
+ # @return [String, nil]
7326
+ optional :license_type_id, String, nil?: true
7327
+
7328
+ # @!attribute metadata
7329
+ # User-specified key/value pairs for the resource. Individual keys can be removed
7330
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
7331
+ # by setting `metadata` to `null`.
7332
+ #
7333
+ # @return [Hash{Symbol=>String, nil}, nil]
7334
+ optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
7335
+
7336
+ # @!attribute reference_id
7337
+ # A transient ID that can be used to reference this price when adding adjustments
7338
+ # in the same API call.
7339
+ #
7340
+ # @return [String, nil]
7341
+ optional :reference_id, String, nil?: true
7342
+
7343
+ # @!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)
7344
+ # Some parameter documentations has been truncated, see
7345
+ # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier}
7346
+ # for more details.
7347
+ #
7348
+ # @param cadence [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier::Cadence] The cadence to bill for this price on.
7349
+ #
7350
+ # @param item_id [String] The id of the item the price will be associated with.
7351
+ #
7352
+ # @param name [String] The name of the price.
7353
+ #
7354
+ # @param unit_with_multiplier_config [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig] Configuration for unit_with_multiplier pricing
7355
+ #
7356
+ # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
7357
+ #
7358
+ # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
7359
+ #
7360
+ # @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
7361
+ #
7362
+ # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
7363
+ #
7364
+ # @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
7365
+ #
7366
+ # @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
7367
+ #
7368
+ # @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
7369
+ #
7370
+ # @param external_price_id [String, nil] An alias for the price.
7371
+ #
7372
+ # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
7373
+ #
7374
+ # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
7375
+ #
7376
+ # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
7377
+ #
7378
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
7379
+ #
7380
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
7381
+ #
7382
+ # @param reference_id [String, nil] A transient ID that can be used to reference this price when adding adjustments
7383
+ #
7384
+ # @param model_type [Symbol, :unit_with_multiplier] The pricing model type
7385
+
7386
+ # The cadence to bill for this price on.
7387
+ #
7388
+ # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier#cadence
7389
+ module Cadence
7390
+ extend Orb::Internal::Type::Enum
7391
+
7392
+ ONE_TIME = :one_time
7393
+ MONTHLY = :monthly
7394
+ QUARTERLY = :quarterly
7395
+ SEMI_ANNUAL = :semi_annual
7396
+ ANNUAL = :annual
7397
+ CUSTOM = :custom
7398
+
7399
+ # @!method self.values
7400
+ # @return [Array<Symbol>]
7401
+ end
7402
+
7403
+ # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier#unit_with_multiplier_config
7404
+ class UnitWithMultiplierConfig < Orb::Internal::Type::BaseModel
7405
+ # @!attribute default_display_name
7406
+ # Sub-line label for list-price events that don't set display_name_key. Unlabeled
7407
+ # events with another multiplier are labeled by their multiplier (e.g. '0.8×
7408
+ # rate').
7409
+ #
7410
+ # @return [String]
7411
+ required :default_display_name, String
7412
+
7413
+ # @!attribute display_name_key
7414
+ # Event property holding the sub-line label for the event's rate (e.g.
7415
+ # 'Off-peak').
7416
+ #
7417
+ # @return [String]
7418
+ required :display_name_key, String
7419
+
7420
+ # @!attribute multiplier_key
7421
+ # Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
7422
+ # discount). Events without a number between 0 and 1000 with at most 12 decimal
7423
+ # places are charged at unit_amount.
7424
+ #
7425
+ # @return [String]
7426
+ required :multiplier_key, String
7427
+
7428
+ # @!attribute unit_amount
7429
+ # List price per unit, before the event's multiplier is applied.
7430
+ #
7431
+ # @return [String]
7432
+ required :unit_amount, String
7433
+
7434
+ # @!method initialize(default_display_name:, display_name_key:, multiplier_key:, unit_amount:)
7435
+ # Some parameter documentations has been truncated, see
7436
+ # {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier::UnitWithMultiplierConfig}
7437
+ # for more details.
7438
+ #
7439
+ # Configuration for unit_with_multiplier pricing
7440
+ #
7441
+ # @param default_display_name [String] Sub-line label for list-price events that don't set display_name_key. Unlabeled
7442
+ #
7443
+ # @param display_name_key [String] Event property holding the sub-line label for the event's rate (e.g. 'Off-peak')
7444
+ #
7445
+ # @param multiplier_key [String] Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
7446
+ #
7447
+ # @param unit_amount [String] List price per unit, before the event's multiplier is applied.
7448
+ end
7449
+ end
7450
+
6961
7451
  # @!method self.variants
6962
- # @return [Array(Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::EventOutput)]
7452
+ # @return [Array(Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedTieredMatrix, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredMatrixWithAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::EventOutput, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::UnitWithMultiplier)]
6963
7453
  end
6964
7454
  end
6965
7455
  end
@@ -205,7 +205,7 @@ module Orb
205
205
  required :per_unit_cost_basis, String, nil?: true
206
206
 
207
207
  # @!attribute status
208
- # `void` means the credit block was deleted. A voided block's `balance` is
208
+ # A deleted credit block keeps its historical fields, and its `balance` is
209
209
  # always 0.
210
210
  #
211
211
  # @return [Symbol, Orb::Models::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent::Block::Status]
@@ -259,7 +259,7 @@ module Orb
259
259
  #
260
260
  # @param per_unit_cost_basis [String, nil]
261
261
  #
262
- # @param status [Symbol, Orb::Models::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent::Block::Status] `void` means the credit block was deleted. A voided block's `balance` is always
262
+ # @param status [Symbol, Orb::Models::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent::Block::Status] A deleted credit block keeps its historical fields, and its `balance` is always
263
263
  #
264
264
  # @param credit_allocation [Orb::Models::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent::Block::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
265
265
  #
@@ -342,7 +342,7 @@ module Orb
342
342
  end
343
343
  end
344
344
 
345
- # `void` means the credit block was deleted. A voided block's `balance` is
345
+ # A deleted credit block keeps its historical fields, and its `balance` is
346
346
  # always 0.
347
347
  #
348
348
  # @see Orb::Models::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent::Block#status
@@ -351,7 +351,7 @@ module Orb
351
351
 
352
352
  ACTIVE = :active
353
353
  PENDING_PAYMENT = :pending_payment
354
- VOID = :void
354
+ DELETED = :deleted
355
355
 
356
356
  # @!method self.values
357
357
  # @return [Array<Symbol>]