orb-billing 6.10.0 → 6.11.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [6.11.0](https://github.com/orbcorp/orb-typescript/compare/v6.10.0...v6.11.0) (2026-08-07)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** api update ([f88fce4](https://github.com/orbcorp/orb-typescript/commit/f88fce46301202d14e5d7414a62812ffecbb337a))
9
+
3
10
  ## [6.10.0](https://github.com/orbcorp/orb-typescript/compare/v6.9.0...v6.10.0) (2026-08-05)
4
11
 
5
12
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "orb-billing",
3
- "version": "6.10.0",
3
+ "version": "6.11.0",
4
4
  "description": "The official TypeScript library for the Orb API",
5
5
  "author": "Orb <team@withorb.com>",
6
6
  "types": "./index.d.ts",
@@ -774,6 +774,17 @@ export declare class Subscriptions extends APIResource {
774
774
  * Note that one of `plan_id` or `external_plan_id` is required in the request body
775
775
  * for this operation.
776
776
  *
777
+ * ## Interaction with scheduled cancellations
778
+ *
779
+ * Scheduling a plan change also unschedules a pending cancellation, as long as the
780
+ * cancellation date is on or after the plan change date: Orb honors the plan
781
+ * change over the scheduled cancellation, and the subscription continues on the
782
+ * new plan. Scheduling a plan change after the subscription's end date returns a
783
+ * validation error instead.
784
+ *
785
+ * Any plan changes already scheduled at or after the new plan change's date are
786
+ * unscheduled and replaced by it.
787
+ *
777
788
  * ## Customize your customer's subscriptions
778
789
  *
779
790
  * Prices and adjustments in a plan can be added, removed, or replaced on the
@@ -951,11 +962,19 @@ export declare class Subscriptions extends APIResource {
951
962
  * cancellation. This operation will turn on auto-renew, ensuring that the
952
963
  * subscription does not end at the currently scheduled cancellation time.
953
964
  *
954
- * Note: uncancellation is a lossy operation. Price intervals that were cut short
955
- * by the cancellation are extended to infinity (original end dates are lost), and
956
- * future intervals or phases scheduled after the cancellation time are permanently
957
- * deleted. For complex subscriptions with phases or scheduled plan changes,
958
- * consider creating a new plan change instead of uncancelling.
965
+ * A cancellation that has already taken effect cannot be unscheduled. This
966
+ * includes backdated cancellations: once the subscription's end date is in the
967
+ * past, this endpoint returns a validation error.
968
+ *
969
+ * Note: uncancellation is a lossy operation. Price and adjustment intervals that
970
+ * were cut short by the cancellation are extended to infinity (original end dates
971
+ * are lost), and future intervals or phases scheduled after the cancellation time
972
+ * are permanently deleted. For complex subscriptions with phases or scheduled plan
973
+ * changes, consider creating a new plan change instead of uncancelling.
974
+ *
975
+ * If the scheduled cancellation already produced invoices or credit notes (for
976
+ * example, a proration refund credit note for an in-advance fee), uncancelling
977
+ * voids and reissues them as needed to match the subscription's new state.
959
978
  *
960
979
  * @example
961
980
  * ```ts
@@ -985,7 +1004,21 @@ export declare class Subscriptions extends APIResource {
985
1004
  unscheduleFixedFeeQuantityUpdates(subscriptionID: string, body: SubscriptionUnscheduleFixedFeeQuantityUpdatesParams, options?: RequestOptions): APIPromise<SubscriptionChangesAPI.MutatedSubscription>;
986
1005
  /**
987
1006
  * This endpoint can be used to unschedule any pending plan changes on an existing
988
- * subscription. When called, all upcoming plan changes will be unscheduled.
1007
+ * subscription. When called, all upcoming plan changes will be unscheduled; it is
1008
+ * not possible to unschedule a single plan change if multiple are scheduled.
1009
+ *
1010
+ * Note: unscheduling a plan change is a lossy operation, with the same semantics
1011
+ * as
1012
+ * [unscheduling a cancellation](/api-reference/subscription/unschedule-subscription-cancellation).
1013
+ * Prices and adjustments on the current plan that were scheduled to end at the
1014
+ * plan change time are extended to infinity (original end dates are lost), and
1015
+ * anything scheduled to start after the plan change time is permanently deleted.
1016
+ * Coupons redeemed as part of an unscheduled plan change are released and can be
1017
+ * redeemed again.
1018
+ *
1019
+ * A scheduled cancellation is not affected by this operation: if the subscription
1020
+ * has both a pending plan change and a scheduled cancellation, unscheduling the
1021
+ * plan change leaves the cancellation in place.
989
1022
  *
990
1023
  * @example
991
1024
  * ```ts