orb-billing - npm Package Compare versions

Comparing version 4.53.0 to 4.54.0

package.json

 {
   "name": "orb-billing",
-  "version": "4.53.0",
+  "version": "4.54.0",
   "description": "The official TypeScript library for the Orb API",
@@ -5,0 +5,0 @@ "author": "Orb <[e-mail]>",

resources/invoice-line-items.d.ts

@@ -18,5 +18,18 @@ import { APIResource } from "../resource.js";
     /**
+     * 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<InvoiceLineItemCreateResponse.AmountDiscountAdjustment | InvoiceLineItemCreateResponse.PercentageDiscountAdjustment | InvoiceLineItemCreateResponse.UsageDiscountAdjustment | InvoiceLineItemCreateResponse.MinimumAdjustment | InvoiceLineItemCreateResponse.MaximumAdjustment>;
+    /**
      * The final amount after any discounts or minimums.
      */
     amount: string;
+    /**
+     * The number of credits used
+     */
+    credits_applied: string;
     discount: Shared.Discount | null;
@@ -33,5 +46,17 @@ /**
     grouping: string | null;
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     maximum: InvoiceLineItemCreateResponse.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: InvoiceLineItemCreateResponse.Minimum | null;
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     minimum_amount: string | null;
@@ -43,2 +68,6 @@ /**
     /**
+     * Any amount applied from a partial invoice
+     */
+    partially_invoiced_amount: string;
+    /**
      * The Price resource represents a price that can be billed on a subscription,
@@ -77,2 +106,139 @@ * resulting in a charge on an invoice in the form of an invoice line item. Prices
 export declare namespace InvoiceLineItemCreateResponse {
+    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;
+    }
+    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;
+    }
+    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;
+    }
+    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;
+    }
+    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`.
+     */
     interface Maximum {
@@ -89,2 +255,5 @@ /**
     }
+    /**
+     * @deprecated This field is deprecated in favor of `adjustments`.
+     */
     interface Minimum {
@@ -91,0 +260,0 @@ /**

src/resources/invoice-line-items.ts

@@ -28,2 +28,19 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
   /**
+   * 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<
+    | InvoiceLineItemCreateResponse.AmountDiscountAdjustment
+    | InvoiceLineItemCreateResponse.PercentageDiscountAdjustment
+    | InvoiceLineItemCreateResponse.UsageDiscountAdjustment
+    | InvoiceLineItemCreateResponse.MinimumAdjustment
+    | InvoiceLineItemCreateResponse.MaximumAdjustment
+  >;
+
+  /**
    * The final amount after any discounts or minimums.
@@ -33,2 +50,7 @@ */
 
+  /**
+   * The number of credits used
+   */
+  credits_applied: string;
+
   discount: Shared.Discount | null;
@@ -48,8 +70,20 @@
 
+  /**
+   * @deprecated This field is deprecated in favor of `adjustments`.
+   */
   maximum: InvoiceLineItemCreateResponse.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: InvoiceLineItemCreateResponse.Minimum | null;
 
+  /**
+   * @deprecated This field is deprecated in favor of `adjustments`.
+   */
   minimum_amount: string | null;
@@ -63,2 +97,7 @@
   /**
+   * Any amount applied from a partial invoice
+   */
+  partially_invoiced_amount: string;
+
+  /**
    * The Price resource represents a price that can be billed on a subscription,
@@ -107,2 +146,175 @@ * resulting in a charge on an invoice in the form of an invoice line item. Prices
 export namespace InvoiceLineItemCreateResponse {
+  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 {
@@ -121,2 +333,5 @@ /**
 
+  /**
+   * @deprecated This field is deprecated in favor of `adjustments`.
+   */
   export interface Minimum {
@@ -123,0 +338,0 @@ /**

src/version.ts

@@ -1,1 +0,1 @@
-export const VERSION = '4.53.0'; // x-release-please-version
+export const VERSION = '4.54.0'; // x-release-please-version

version.d.ts

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

version.js

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

No alert changes

Improved metrics

Total package byte prevSize

4469952

increased by2.7%

Lines of code

86800

increased by3.25%

No dependency changes