orb-billing 1.25.0 → 1.27.0

data/rbi/orb/models/subscription_schedule_plan_change_params.rbi

@@ -1468,7 +1468,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -1554,7 +1558,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1940,7 +1948,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -2026,7 +2038,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2379,7 +2395,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -2465,7 +2485,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2918,7 +2942,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -3004,7 +3032,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3331,7 +3363,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -3417,7 +3453,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3714,7 +3754,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -3800,7 +3844,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4097,7 +4145,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -4183,7 +4235,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4552,7 +4608,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -4638,7 +4698,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4967,7 +5031,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -5053,7 +5121,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -5357,7 +5429,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -5443,7 +5519,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -6677,7 +6757,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -6763,7 +6847,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -7149,7 +7237,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -7235,7 +7327,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -7588,7 +7684,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -7674,7 +7774,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -8127,7 +8231,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -8213,7 +8321,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -8540,7 +8652,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -8626,7 +8742,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -8923,7 +9043,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -9009,7 +9133,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -9306,7 +9434,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -9392,7 +9524,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -9761,7 +9897,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -9847,7 +9987,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -10176,7 +10320,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -10262,7 +10410,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -10566,7 +10718,11 @@ module Orb
             end
             attr_writer :invoicing_cycle_configuration
 
-            # 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.
             sig { returns(T.nilable(String)) }
             attr_accessor :license_type_id
 
@@ -10652,7 +10808,11 @@ module Orb
               # Within each billing cycle, specifies the cadence at which invoices are produced.
               # If unspecified, a single invoice is produced per billing cycle.
               invoicing_cycle_configuration: nil,
-              # 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.
               license_type_id: nil,
               # User-specified key/value pairs for the resource. Individual keys can be removed
               # by setting the value to `null`, and the entire metadata mapping can be cleared

data/rbi/orb/resources/subscriptions.rbi

@@ -1103,6 +1103,17 @@ module Orb
       # Note that one of `plan_id` or `external_plan_id` is required in the request body
       # for this operation.
       #
+      # ## Interaction with scheduled cancellations
+      #
+      # Scheduling a plan change also unschedules a pending cancellation, as long as the
+      # cancellation date is on or after the plan change date: Orb honors the plan
+      # change over the scheduled cancellation, and the subscription continues on the
+      # new plan. Scheduling a plan change after the subscription's end date returns a
+      # validation error instead.
+      #
+      # Any plan changes already scheduled at or after the new plan change's date are
+      # unscheduled and replaced by it.
+      #
       # ## Customize your customer's subscriptions
       #
       # Prices and adjustments in a plan can be added, removed, or replaced on the
@@ -1439,11 +1450,19 @@ module Orb
       # cancellation. This operation will turn on auto-renew, ensuring that the
       # subscription does not end at the currently scheduled cancellation time.
       #
-      # Note: uncancellation is a lossy operation. Price intervals that were cut short
-      # by the cancellation are extended to infinity (original end dates are lost), and
-      # future intervals or phases scheduled after the cancellation time are permanently
-      # deleted. For complex subscriptions with phases or scheduled plan changes,
-      # consider creating a new plan change instead of uncancelling.
+      # A cancellation that has already taken effect cannot be unscheduled. This
+      # includes backdated cancellations: once the subscription's end date is in the
+      # past, this endpoint returns a validation error.
+      #
+      # Note: uncancellation is a lossy operation. Price and adjustment intervals that
+      # were cut short by the cancellation are extended to infinity (original end dates
+      # are lost), and future intervals or phases scheduled after the cancellation time
+      # are permanently deleted. For complex subscriptions with phases or scheduled plan
+      # changes, consider creating a new plan change instead of uncancelling.
+      #
+      # If the scheduled cancellation already produced invoices or credit notes (for
+      # example, a proration refund credit note for an in-advance fee), uncancelling
+      # voids and reissues them as needed to match the subscription's new state.
       sig do
         params(
           subscription_id: String,
@@ -1474,7 +1493,21 @@ module Orb
       end
 
       # This endpoint can be used to unschedule any pending plan changes on an existing
-      # subscription. When called, all upcoming plan changes will be unscheduled.
+      # subscription. When called, all upcoming plan changes will be unscheduled; it is
+      # not possible to unschedule a single plan change if multiple are scheduled.
+      #
+      # Note: unscheduling a plan change is a lossy operation, with the same semantics
+      # as
+      # [unscheduling a cancellation](/api-reference/subscription/unschedule-subscription-cancellation).
+      # Prices and adjustments on the current plan that were scheduled to end at the
+      # plan change time are extended to infinity (original end dates are lost), and
+      # anything scheduled to start after the plan change time is permanently deleted.
+      # Coupons redeemed as part of an unscheduled plan change are released and can be
+      # redeemed again.
+      #
+      # A scheduled cancellation is not affected by this operation: if the subscription
+      # has both a pending plan change and a scheduled cancellation, unscheduling the
+      # plan change leaves the cancellation in place.
       sig do
         params(
           subscription_id: String,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orb-billing
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.27.0
 platform: ruby
 authors:
 - Orb
@@ -1407,7 +1407,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Ruby library to access the Orb API
 test_files: []