orb-billing 5.48.0 → 5.76.0

package/src/resources/subscription-changes.ts

@@ -114,6 +114,14 @@ export interface MutatedSubscription {
    */
   auto_collection: boolean | null;
 
+  /**
+   * Determines whether invoices for this subscription will be automatically issued.
+   * This resolves the effective setting for the subscription: a subscription-level
+   * override if set, otherwise the customer-level setting, otherwise the
+   * account-level default.
+   */
+  auto_issuance: boolean | null;
+
   billing_cycle_anchor_configuration: Shared.BillingCycleAnchorConfiguration;
 
   /**
@@ -173,7 +181,10 @@ export interface MutatedSubscription {
    * start_date. This field is deprecated in favor of `adjustment_intervals`.
    */
   discount_intervals: Array<
-    Shared.AmountDiscountInterval | Shared.PercentageDiscountInterval | Shared.UsageDiscountInterval
+    | Shared.AmountDiscountInterval
+    | Shared.PercentageDiscountInterval
+    | Shared.UsageDiscountInterval
+    | MutatedSubscription.TieredPercentageDiscountInterval
   >;
 
   /**
@@ -255,6 +266,82 @@ export interface MutatedSubscription {
   changed_resources?: Shared.ChangedSubscriptionResources | null;
 }
 
+export namespace MutatedSubscription {
+  export interface TieredPercentageDiscountInterval {
+    /**
+     * The price interval ids that this discount interval applies to.
+     */
+    applies_to_price_interval_ids: Array<string>;
+
+    discount_type: 'tiered_percentage';
+
+    /**
+     * The end date of the discount interval.
+     */
+    end_date: string | null;
+
+    /**
+     * The filters that determine which prices this discount interval applies to.
+     */
+    filters: Array<TieredPercentageDiscountInterval.Filter>;
+
+    /**
+     * The start date of the discount interval.
+     */
+    start_date: string;
+
+    /**
+     * Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+     * bands of cumulative eligible spend, each discounted at its own percentage.
+     */
+    tiers: Array<TieredPercentageDiscountInterval.Tier>;
+  }
+
+  export namespace TieredPercentageDiscountInterval {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+
+    /**
+     * One band of a tiered percentage discount. Bounds are denominated in the
+     * discount's currency. `lower_bound` is the exclusive start of the band and
+     * `upper_bound` is the inclusive end; `upper_bound` is null only for the
+     * open-ended final tier.
+     */
+    export interface Tier {
+      /**
+       * Exclusive lower bound of cumulative spend for this tier.
+       */
+      lower_bound: number;
+
+      /**
+       * The percentage (between 0 and 1) discounted from spend that falls within this
+       * tier.
+       */
+      percentage: number;
+
+      /**
+       * Inclusive upper bound of cumulative spend for this tier; null for the final
+       * open-ended tier.
+       */
+      upper_bound?: number | 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