orb-billing 4.52.0 → 4.54.0

package/src/resources/invoices.ts

@@ -846,11 +846,33 @@ export namespace Invoice {
      */
     id: string;
 
+    /**
+     * The line amount after any adjustments, before overage conversion, credits and
+     * partial invoicing.
+     */
+    adjusted_subtotal: string;
+
+    /**
+     * All adjustments applied to the line item.
+     */
+    adjustments: Array<
+      | LineItem.AmountDiscountAdjustment
+      | LineItem.PercentageDiscountAdjustment
+      | LineItem.UsageDiscountAdjustment
+      | LineItem.MinimumAdjustment
+      | LineItem.MaximumAdjustment
+    >;
+
     /**
      * The final amount after any discounts or minimums.
      */
     amount: string;
 
+    /**
+     * The number of credits used
+     */
+    credits_applied: string;
+
     discount: Shared.Discount | null;
 
     /**
@@ -865,12 +887,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 +912,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
@@ -918,6 +957,179 @@ export namespace Invoice {
   }
 
   export namespace LineItem {
+    export interface AmountDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'amount_discount';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface PercentageDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'percentage_discount';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface UsageDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'usage_discount';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * 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 MinimumAdjustment {
+      id: string;
+
+      adjustment_type: 'minimum';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface MaximumAdjustment {
+      id: string;
+
+      adjustment_type: 'maximum';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * 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 +1143,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
@@ -1837,11 +2052,33 @@ export namespace InvoiceFetchUpcomingResponse {
      */
     id: string;
 
+    /**
+     * The line amount after any adjustments, before overage conversion, credits and
+     * partial invoicing.
+     */
+    adjusted_subtotal: string;
+
+    /**
+     * All adjustments applied to the line item.
+     */
+    adjustments: Array<
+      | LineItem.AmountDiscountAdjustment
+      | LineItem.PercentageDiscountAdjustment
+      | LineItem.UsageDiscountAdjustment
+      | LineItem.MinimumAdjustment
+      | LineItem.MaximumAdjustment
+    >;
+
     /**
      * The final amount after any discounts or minimums.
      */
     amount: string;
 
+    /**
+     * The number of credits used
+     */
+    credits_applied: string;
+
     discount: Shared.Discount | null;
 
     /**
@@ -1856,12 +2093,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 +2118,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
@@ -1909,6 +2163,179 @@ export namespace InvoiceFetchUpcomingResponse {
   }
 
   export namespace LineItem {
+    export interface AmountDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'amount_discount';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface PercentageDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'percentage_discount';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface UsageDiscountAdjustment {
+      id: string;
+
+      adjustment_type: 'usage_discount';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * 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 MinimumAdjustment {
+      id: string;
+
+      adjustment_type: 'minimum';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * The reason for the adjustment.
+       */
+      reason: string | null;
+    }
+
+    export interface MaximumAdjustment {
+      id: string;
+
+      adjustment_type: 'maximum';
+
+      /**
+       * 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 plan phase in which this adjustment is active.
+       */
+      plan_phase_order: number | null;
+
+      /**
+       * 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 +2349,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
@@ -2284,7 +2714,7 @@ export interface InvoiceIssueParams {
   /**
    * If true, the invoice will be issued synchronously. If false, the invoice will be
    * issued asynchronously. The synchronous option is only available for invoices
-   * containin no usage fees. If the invoice is configured to sync to an external
+   * that have no usage fees. If the invoice is configured to sync to an external
    * provider, a successful response from this endpoint guarantees the invoice is
    * present in the provider.
    */