orb-billing 1.25.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de79fbf4ed1620c9277e1f1f6f6524fde44c37222433ce73b9d8f444a20d2d8b
-  data.tar.gz: 8eb3055db1a1b6083058dc5923d03d29fc5fe80e89e4da030e25bd4fe3647a18
+  metadata.gz: 2c12cf6290d59fdfbe36363756a6faa1e1b1edaafc01c4f4fbc6ab3dc898de7a
+  data.tar.gz: ffeb5a57b526735247d9256f825b1998b3fb5cc4f4e5017995ea0d4175917df5
 SHA512:
-  metadata.gz: 85db5e245ab4a94df59236e3d6a534b45a4a34b1fcf7d0c79e0aafa9ea7549c6f2dd759259467cd1a5836f72d6e4c9582bbd371cb57c773ee0d2dad269e14726
-  data.tar.gz: 1e3fef52f706f3c3fad0c3a1c08aac382d25b9bc2b101e151cb8281f95e218f689c689b16145ca555d22eb9adb987c629b370f467fc315719232688da0a56834
+  metadata.gz: 9b63ed1f28b0e9935bf91cde9c2e4685f984aec88f424d61673cc6609f7b3716a1c7b597818aabd4f7b28b4329ce1658604d01c88e7c41fb2dd17f0504ef4b1b
+  data.tar.gz: e87a204410f241783b196af74f0af0642d27bcc84aa68e99213b810622bc1a17a4b2ba4797373805a40026a2b3c3c8f1a02509cb4777b02200fb51a1e7beae9b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.26.0](https://github.com/orbcorp/orb-ruby/compare/v1.25.0...v1.26.0) (2026-08-07)
+
+
+### Features
+
+* **api:** api update ([4235146](https://github.com/orbcorp/orb-ruby/commit/4235146bb3f1dbc5993956b47bab93ad70c967a6))
+
 ## [1.25.0](https://github.com/orbcorp/orb-ruby/compare/v1.24.0...v1.25.0) (2026-08-05)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 1.25.0"
+gem "orb-billing", "~> 1.26.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/resources/subscriptions.rb

@@ -1081,6 +1081,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
@@ -1338,11 +1349,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.
       #
       # @overload unschedule_cancellation(subscription_id, request_options: {})
       #
@@ -1390,7 +1409,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.
       #
       # @overload unschedule_pending_plan_changes(subscription_id, request_options: {})
       #

data/lib/orb/version.rb

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

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.26.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: []