orb-billing 4.53.0 → 4.55.0

package/src/resources/invoices.ts

@@ -847,10 +847,33 @@ export namespace Invoice {
     id: string;
 
     /**
-     * The final amount after any discounts or minimums.
+     * The line amount after any adjustments and before overage conversion, credits and
+     * partial invoicing.
+     */
+    adjusted_subtotal: string;
+
+    /**
+     * All adjustments (ie. maximums, minimums, discounts) applied to the line item.
+     */
+    adjustments: Array<
+      | LineItem.MonetaryUsageDiscountAdjustment
+      | LineItem.MonetaryAmountDiscountAdjustment
+      | LineItem.MonetaryPercentageDiscountAdjustment
+      | LineItem.MonetaryMinimumAdjustment
+      | LineItem.MonetaryMaximumAdjustment
+    >;
+
+    /**
+     * The final amount for a line item after all adjustments and pre paid credits have
+     * been applied.
      */
     amount: string;
 
+    /**
+     * The number of prepaid credits applied.
+     */
+    credits_applied: string;
+
     discount: Shared.Discount | null;
 
     /**
@@ -865,12 +888,24 @@ export namespace Invoice {
      */
     grouping: string | null;
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     maximum: LineItem.Maximum | null;
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     maximum_amount: string | null;
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     minimum: LineItem.Minimum | null;
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     minimum_amount: string | null;
 
     /**
@@ -878,6 +913,11 @@ export namespace Invoice {
      */
     name: string;
 
+    /**
+     * Any amount applied from a partial invoice
+     */
+    partially_invoiced_amount: string;
+
     /**
      * The Price resource represents a price that can be billed on a subscription,
      * resulting in a charge on an invoice in the form of an invoice line item. Prices
@@ -892,6 +932,9 @@ export namespace Invoice {
      */
     price: PricesAPI.Price | null;
 
+    /**
+     * Either the fixed fee quantity or the usage during the service period.
+     */
     quantity: number;
 
     /**
@@ -906,7 +949,7 @@ export namespace Invoice {
     sub_line_items: Array<LineItem.MatrixSubLineItem | LineItem.TierSubLineItem | LineItem.OtherSubLineItem>;
 
     /**
-     * The line amount before any line item-specific discounts or minimums.
+     * The line amount before before any adjustments.
      */
     subtotal: string;
 
@@ -918,6 +961,179 @@ export namespace Invoice {
   }
 
   export namespace LineItem {
+    export interface MonetaryUsageDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'usage_discount';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+
+      /**
+       * The number of usage units by which to discount the price this adjustment applies
+       * to in a given billing period.
+       */
+      usage_discount: number;
+    }
+
+    export interface MonetaryAmountDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'amount_discount';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The amount by which to discount the prices this adjustment applies to in a given
+       * billing period.
+       */
+      amount_discount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface MonetaryPercentageDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'percentage_discount';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The percentage (as a value between 0 and 1) by which to discount the price
+       * intervals this adjustment applies to in a given billing period.
+       */
+      percentage_discount: number;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface MonetaryMinimumAdjustment {
+      id: string;
+
+      adjustment_type: 'minimum';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The item ID that revenue from this minimum will be attributed to.
+       */
+      item_id: string;
+
+      /**
+       * The minimum amount to charge in a given billing period for the prices this
+       * adjustment applies to.
+       */
+      minimum_amount: string;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface MonetaryMaximumAdjustment {
+      id: string;
+
+      adjustment_type: 'maximum';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The maximum amount to charge in a given billing period for the prices this
+       * adjustment applies to.
+       */
+      maximum_amount: string;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     export interface Maximum {
       /**
        * List of price_ids that this maximum amount applies to. For plan/plan phase
@@ -931,6 +1147,9 @@ export namespace Invoice {
       maximum_amount: string;
     }
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     export interface Minimum {
       /**
        * List of price_ids that this minimum amount applies to. For plan/plan phase
@@ -1838,10 +2057,33 @@ export namespace InvoiceFetchUpcomingResponse {
     id: string;
 
     /**
-     * The final amount after any discounts or minimums.
+     * The line amount after any adjustments and before overage conversion, credits and
+     * partial invoicing.
+     */
+    adjusted_subtotal: string;
+
+    /**
+     * All adjustments (ie. maximums, minimums, discounts) applied to the line item.
+     */
+    adjustments: Array<
+      | LineItem.MonetaryUsageDiscountAdjustment
+      | LineItem.MonetaryAmountDiscountAdjustment
+      | LineItem.MonetaryPercentageDiscountAdjustment
+      | LineItem.MonetaryMinimumAdjustment
+      | LineItem.MonetaryMaximumAdjustment
+    >;
+
+    /**
+     * The final amount for a line item after all adjustments and pre paid credits have
+     * been applied.
      */
     amount: string;
 
+    /**
+     * The number of prepaid credits applied.
+     */
+    credits_applied: string;
+
     discount: Shared.Discount | null;
 
     /**
@@ -1856,12 +2098,24 @@ export namespace InvoiceFetchUpcomingResponse {
      */
     grouping: string | null;
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     maximum: LineItem.Maximum | null;
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     maximum_amount: string | null;
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     minimum: LineItem.Minimum | null;
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     minimum_amount: string | null;
 
     /**
@@ -1869,6 +2123,11 @@ export namespace InvoiceFetchUpcomingResponse {
      */
     name: string;
 
+    /**
+     * Any amount applied from a partial invoice
+     */
+    partially_invoiced_amount: string;
+
     /**
      * The Price resource represents a price that can be billed on a subscription,
      * resulting in a charge on an invoice in the form of an invoice line item. Prices
@@ -1883,6 +2142,9 @@ export namespace InvoiceFetchUpcomingResponse {
      */
     price: PricesAPI.Price | null;
 
+    /**
+     * Either the fixed fee quantity or the usage during the service period.
+     */
     quantity: number;
 
     /**
@@ -1897,7 +2159,7 @@ export namespace InvoiceFetchUpcomingResponse {
     sub_line_items: Array<LineItem.MatrixSubLineItem | LineItem.TierSubLineItem | LineItem.OtherSubLineItem>;
 
     /**
-     * The line amount before any line item-specific discounts or minimums.
+     * The line amount before before any adjustments.
      */
     subtotal: string;
 
@@ -1909,6 +2171,179 @@ export namespace InvoiceFetchUpcomingResponse {
   }
 
   export namespace LineItem {
+    export interface MonetaryUsageDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'usage_discount';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+
+      /**
+       * The number of usage units by which to discount the price this adjustment applies
+       * to in a given billing period.
+       */
+      usage_discount: number;
+    }
+
+    export interface MonetaryAmountDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'amount_discount';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The amount by which to discount the prices this adjustment applies to in a given
+       * billing period.
+       */
+      amount_discount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface MonetaryPercentageDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'percentage_discount';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The percentage (as a value between 0 and 1) by which to discount the price
+       * intervals this adjustment applies to in a given billing period.
+       */
+      percentage_discount: number;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface MonetaryMinimumAdjustment {
+      id: string;
+
+      adjustment_type: 'minimum';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The item ID that revenue from this minimum will be attributed to.
+       */
+      item_id: string;
+
+      /**
+       * The minimum amount to charge in a given billing period for the prices this
+       * adjustment applies to.
+       */
+      minimum_amount: string;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface MonetaryMaximumAdjustment {
+      id: string;
+
+      adjustment_type: 'maximum';
+
+      /**
+       * The value applied by an adjustment.
+       */
+      amount: string;
+
+      /**
+       * The price IDs that this adjustment applies to.
+       */
+      applies_to_price_ids: Array<string>;
+
+      /**
+       * True for adjustments that apply to an entire invocice, false for adjustments
+       * that apply to only one price.
+       */
+      is_invoice_level: boolean;
+
+      /**
+       * The maximum amount to charge in a given billing period for the prices this
+       * adjustment applies to.
+       */
+      maximum_amount: string;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     export interface Maximum {
       /**
        * List of price_ids that this maximum amount applies to. For plan/plan phase
@@ -1922,6 +2357,9 @@ export namespace InvoiceFetchUpcomingResponse {
       maximum_amount: string;
     }
 
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     export interface Minimum {
       /**
        * List of price_ids that this minimum amount applies to. For plan/plan phase