RubyGems - orb-billing - Versions diffs - 1.26.0 → 1.27.0 - Mend

orb-billing 1.26.0 → 1.27.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 (175) hide show

data/lib/orb/models/subscription_schedule_plan_change_params.rb CHANGED Viewed

@@ -879,7 +879,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -934,7 +938,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -1136,7 +1140,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -1191,7 +1199,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -1395,7 +1403,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -1450,7 +1462,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -1711,7 +1723,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -1766,7 +1782,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -1947,7 +1963,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -2002,7 +2022,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -2176,7 +2196,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -2231,7 +2255,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -2405,7 +2429,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -2460,7 +2488,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -2681,7 +2709,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -2736,7 +2768,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -2935,7 +2967,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -2990,7 +3026,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -3170,7 +3206,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -3225,7 +3265,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -3885,7 +3925,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -3940,7 +3984,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -4150,7 +4194,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -4205,7 +4253,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -4409,7 +4457,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -4464,7 +4516,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -4725,7 +4777,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -4780,7 +4836,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -4961,7 +5017,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -5016,7 +5076,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -5190,7 +5250,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -5245,7 +5309,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -5419,7 +5483,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -5474,7 +5542,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -5695,7 +5763,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -5750,7 +5822,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -5949,7 +6021,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -6004,7 +6080,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #
@@ -6184,7 +6260,11 @@ module Orb
             optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
             # @!attribute license_type_id
-            #   The ID of the license type to associate with this price.
+            #   The ID of the license type to associate with this price. On a usage price this
+            #   also marks the price as eligible to draw down from that license type's
+            #   allocation; a usage price created without it is billed normally. Usage prices
+            #   with a license type must use the `unit` model, and only draw down when their
+            #   currency matches the allocation's.
             #
             #   @return [String, nil]
             optional :license_type_id, String, nil?: true
@@ -6239,7 +6319,7 @@ module Orb
             #
             #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
             #
-            #   @param license_type_id [String, nil] The ID of the license type to associate with this price.
+            #   @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
             #
             #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
             #

data/lib/orb/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Orb
-  VERSION = "1.26.0"
+  VERSION = "1.27.0"
 end