orb-billing 5.38.0 → 5.41.0

package/src/resources/subscription-changes.ts

@@ -6,6 +6,7 @@ import * as Core from '../core';
 import * as Shared from './shared';
 import * as CustomersAPI from './customers/customers';
 import * as PlansAPI from './plans/plans';
+import { Page, type PageParams } from '../pagination';
 
 export class SubscriptionChanges extends APIResource {
   /**
@@ -26,6 +27,31 @@ export class SubscriptionChanges extends APIResource {
     return this._client.get(`/subscription_changes/${subscriptionChangeId}`, options);
   }
 
+  /**
+   * This endpoint returns a list of pending subscription changes for a customer. Use
+   * the [Fetch Subscription Change](fetch-subscription-change) endpoint to retrieve
+   * the expected subscription state after the pending change is applied.
+   */
+  list(
+    query?: SubscriptionChangeListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SubscriptionChangeListResponsesPage, SubscriptionChangeListResponse>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SubscriptionChangeListResponsesPage, SubscriptionChangeListResponse>;
+  list(
+    query: SubscriptionChangeListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SubscriptionChangeListResponsesPage, SubscriptionChangeListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/subscription_changes', SubscriptionChangeListResponsesPage, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Apply a subscription change to perform the intended action. If a positive amount
    * is passed with a request to this endpoint, any eligible invoices that were
@@ -64,6 +90,8 @@ export class SubscriptionChanges extends APIResource {
   }
 }
 
+export class SubscriptionChangeListResponsesPage extends Page<SubscriptionChangeListResponse> {}
+
 export interface MutatedSubscription {
   id: string;
 
@@ -282,6 +310,29 @@ export interface SubscriptionChangeRetrieveResponse {
   plan_id?: string | null;
 }
 
+export interface SubscriptionChangeListResponse {
+  id: string;
+
+  /**
+   * Subscription change will be cancelled at this time and can no longer be applied.
+   */
+  expiration_time: string;
+
+  status: 'pending' | 'applied' | 'cancelled';
+
+  subscription_id: string | null;
+
+  /**
+   * When this change was applied.
+   */
+  applied_at?: string | null;
+
+  /**
+   * When this change was cancelled.
+   */
+  cancelled_at?: string | null;
+}
+
 /**
  * A subscription change represents a desired new subscription / pending change to
  * an existing subscription. It is a way to first preview the effects on the
@@ -392,6 +443,14 @@ export interface SubscriptionChangeCancelResponse {
   plan_id?: string | null;
 }
 
+export interface SubscriptionChangeListParams extends PageParams {
+  customer_id?: string | null;
+
+  external_customer_id?: string | null;
+
+  status?: 'pending' | 'applied' | 'cancelled' | null;
+}
+
 export interface SubscriptionChangeApplyParams {
   /**
    * Description to apply to the balance transaction representing this credit.
@@ -428,12 +487,17 @@ export interface SubscriptionChangeApplyParams {
   previously_collected_amount?: string | null;
 }
 
+SubscriptionChanges.SubscriptionChangeListResponsesPage = SubscriptionChangeListResponsesPage;
+
 export declare namespace SubscriptionChanges {
   export {
     type MutatedSubscription as MutatedSubscription,
     type SubscriptionChangeRetrieveResponse as SubscriptionChangeRetrieveResponse,
+    type SubscriptionChangeListResponse as SubscriptionChangeListResponse,
     type SubscriptionChangeApplyResponse as SubscriptionChangeApplyResponse,
     type SubscriptionChangeCancelResponse as SubscriptionChangeCancelResponse,
+    SubscriptionChangeListResponsesPage as SubscriptionChangeListResponsesPage,
+    type SubscriptionChangeListParams as SubscriptionChangeListParams,
     type SubscriptionChangeApplyParams as SubscriptionChangeApplyParams,
   };
 }

package/src/resources/subscriptions.ts

@@ -1438,9 +1438,6 @@ export namespace NewSubscriptionCumulativeGroupedBulkPrice {
      */
     dimension_values: Array<CumulativeGroupedBulkConfig.DimensionValue>;
 
-    /**
-     * Grouping key name
-     */
     group: string;
   }
 
@@ -1701,9 +1698,6 @@ export namespace NewSubscriptionGroupedTieredPackagePrice {
      */
     grouping_key: string;
 
-    /**
-     * Package size
-     */
     package_size: string;
 
     /**
@@ -1719,13 +1713,10 @@ export namespace NewSubscriptionGroupedTieredPackagePrice {
      */
     export interface Tier {
       /**
-       * Price per package
+       * Per package
        */
       per_unit: string;
 
-      /**
-       * Tier lower bound
-       */
       tier_lower_bound: string;
     }
   }
@@ -1854,9 +1845,6 @@ export namespace NewSubscriptionGroupedTieredPrice {
      * Configuration for a single tier
      */
     export interface Tier {
-      /**
-       * Tier lower bound
-       */
       tier_lower_bound: string;
 
       /**
@@ -2011,14 +1999,8 @@ export namespace NewSubscriptionGroupedWithMeteredMinimumPrice {
      * Configuration for a scaling factor
      */
     export interface ScalingFactor {
-      /**
-       * Scaling factor
-       */
       scaling_factor: string;
 
-      /**
-       * Scaling value
-       */
       scaling_value: string;
     }
 
@@ -2026,9 +2008,6 @@ export namespace NewSubscriptionGroupedWithMeteredMinimumPrice {
      * Configuration for a unit amount
      */
     export interface UnitAmount {
-      /**
-       * Pricing value
-       */
       pricing_value: string;
 
       /**
@@ -2615,9 +2594,6 @@ export namespace NewSubscriptionMaxGroupTieredPackagePrice {
      */
     grouping_key: string;
 
-    /**
-     * Package size
-     */
     package_size: string;
 
     /**
@@ -2631,9 +2607,6 @@ export namespace NewSubscriptionMaxGroupTieredPackagePrice {
      * Configuration for a single tier
      */
     export interface Tier {
-      /**
-       * Tier lower bound
-       */
       tier_lower_bound: string;
 
       /**
@@ -2656,14 +2629,14 @@ export interface NewSubscriptionMinimumCompositePrice {
   item_id: string;
 
   /**
-   * Configuration for minimum pricing
+   * Configuration for minimum_composite pricing
    */
-  minimum_config: NewSubscriptionMinimumCompositePrice.MinimumConfig;
+  minimum_composite_config: NewSubscriptionMinimumCompositePrice.MinimumCompositeConfig;
 
   /**
    * The pricing model type
    */
-  model_type: 'minimum';
+  model_type: 'minimum_composite';
 
   /**
    * The name of the price.
@@ -2747,9 +2720,9 @@ export interface NewSubscriptionMinimumCompositePrice {
 
 export namespace NewSubscriptionMinimumCompositePrice {
   /**
-   * Configuration for minimum pricing
+   * Configuration for minimum_composite pricing
    */
-  export interface MinimumConfig {
+  export interface MinimumCompositeConfig {
     /**
      * The minimum amount to apply
      */
@@ -2969,19 +2942,10 @@ export namespace NewSubscriptionPackageWithAllocationPrice {
    * Configuration for package_with_allocation pricing
    */
   export interface PackageWithAllocationConfig {
-    /**
-     * Usage allocation
-     */
     allocation: string;
 
-    /**
-     * Price per package
-     */
     package_amount: string;
 
-    /**
-     * Package size
-     */
     package_size: string;
   }
 }
@@ -3102,9 +3066,6 @@ export namespace NewSubscriptionScalableMatrixWithTieredPricingPrice {
      */
     matrix_scaling_factors: Array<ScalableMatrixWithTieredPricingConfig.MatrixScalingFactor>;
 
-    /**
-     * Tier pricing structure
-     */
     tiers: Array<ScalableMatrixWithTieredPricingConfig.Tier>;
 
     /**
@@ -3118,19 +3079,10 @@ export namespace NewSubscriptionScalableMatrixWithTieredPricingPrice {
      * Configuration for a single matrix scaling factor
      */
     export interface MatrixScalingFactor {
-      /**
-       * First dimension value
-       */
       first_dimension_value: string;
 
-      /**
-       * Scaling factor
-       */
       scaling_factor: string;
 
-      /**
-       * Second dimension value (optional)
-       */
       second_dimension_value?: string | null;
     }
 
@@ -3138,14 +3090,8 @@ export namespace NewSubscriptionScalableMatrixWithTieredPricingPrice {
      * Configuration for a single tier entry with business logic
      */
     export interface Tier {
-      /**
-       * Tier lower bound
-       */
       tier_lower_bound: string;
 
-      /**
-       * Per unit amount
-       */
       unit_amount: string;
     }
   }
@@ -3288,19 +3234,10 @@ export namespace NewSubscriptionScalableMatrixWithUnitPricingPrice {
      * Configuration for a single matrix scaling factor
      */
     export interface MatrixScalingFactor {
-      /**
-       * First dimension value
-       */
       first_dimension_value: string;
 
-      /**
-       * Scaling factor
-       */
       scaling_factor: string;
 
-      /**
-       * Second dimension value (optional)
-       */
       second_dimension_value?: string | null;
     }
   }
@@ -3429,9 +3366,6 @@ export namespace NewSubscriptionThresholdTotalAmountPrice {
      * Configuration for a single threshold
      */
     export interface ConsumptionTable {
-      /**
-       * Quantity threshold
-       */
       threshold: string;
 
       /**
@@ -3548,9 +3482,6 @@ export namespace NewSubscriptionTieredPackagePrice {
    * Configuration for tiered_package pricing
    */
   export interface TieredPackageConfig {
-    /**
-     * Package size
-     */
     package_size: string;
 
     /**
@@ -3572,9 +3503,6 @@ export namespace NewSubscriptionTieredPackagePrice {
        */
       per_unit: string;
 
-      /**
-       * Tier lower bound
-       */
       tier_lower_bound: string;
     }
   }
@@ -3686,9 +3614,6 @@ export namespace NewSubscriptionTieredPackageWithMinimumPrice {
    * Configuration for tiered_package_with_minimum pricing
    */
   export interface TieredPackageWithMinimumConfig {
-    /**
-     * Package size
-     */
     package_size: number;
 
     /**
@@ -3703,19 +3628,10 @@ export namespace NewSubscriptionTieredPackageWithMinimumPrice {
      * Configuration for a single tier
      */
     export interface Tier {
-      /**
-       * Minimum amount
-       */
       minimum_amount: string;
 
-      /**
-       * Price per package
-       */
       per_unit: string;
 
-      /**
-       * Tier lower bound
-       */
       tier_lower_bound: string;
     }
   }
@@ -3950,14 +3866,8 @@ export namespace NewSubscriptionTieredWithMinimumPrice {
      * Configuration for a single tier
      */
     export interface Tier {
-      /**
-       * Minimum amount
-       */
       minimum_amount: string;
 
-      /**
-       * Tier lower bound
-       */
       tier_lower_bound: string;
 
       /**

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.38.0'; // x-release-please-version
+export const VERSION = '5.41.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.38.0";
+export declare const VERSION = "5.41.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '5.38.0'; // x-release-please-version
+exports.VERSION = '5.41.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '5.38.0'; // x-release-please-version
+export const VERSION = '5.41.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map