orb-billing 6.18.0 → 6.19.0

package/src/client.ts

@@ -46,6 +46,7 @@ import {
 import {
   InvoiceCreateParams,
   InvoiceDeleteLineItemParams,
+  InvoiceFetchParams,
   InvoiceFetchUpcomingParams,
   InvoiceFetchUpcomingResponse,
   InvoiceIssueParams,
@@ -1201,6 +1202,7 @@ export declare namespace Orb {
     type InvoiceUpdateParams as InvoiceUpdateParams,
     type InvoiceListParams as InvoiceListParams,
     type InvoiceDeleteLineItemParams as InvoiceDeleteLineItemParams,
+    type InvoiceFetchParams as InvoiceFetchParams,
     type InvoiceFetchUpcomingParams as InvoiceFetchUpcomingParams,
     type InvoiceIssueParams as InvoiceIssueParams,
     type InvoiceIssueSummaryParams as InvoiceIssueSummaryParams,

package/src/resources/index.ts

@@ -88,6 +88,7 @@ export {
   type InvoiceUpdateParams,
   type InvoiceListParams,
   type InvoiceDeleteLineItemParams,
+  type InvoiceFetchParams,
   type InvoiceFetchUpcomingParams,
   type InvoiceIssueParams,
   type InvoiceIssueSummaryParams,

package/src/resources/invoices.ts

@@ -130,8 +130,12 @@ export class Invoices extends APIResource {
    * const invoice = await client.invoices.fetch('invoice_id');
    * ```
    */
-  fetch(invoiceID: string, options?: RequestOptions): APIPromise<Shared.Invoice> {
-    return this._client.get(path`/invoices/${invoiceID}`, options);
+  fetch(
+    invoiceID: string,
+    query: InvoiceFetchParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.Invoice> {
+    return this._client.get(path`/invoices/${invoiceID}`, { query, ...options });
   }
 
   /**
@@ -578,6 +582,14 @@ export interface InvoiceFetchUpcomingResponse {
    */
   eligible_to_issue_at: string | null;
 
+  /**
+   * The number of line items omitted from `line_items` because they have zero
+   * quantity. Amounts such as `subtotal` and `total` are computed over every line
+   * item on the invoice, including the omitted ones. In rare circumstances, hidden
+   * line items may still contribute to these amounts.
+   */
+  hidden_line_item_count: number;
+
   /**
    * A URL for the customer-facing invoice portal. This URL expires 60 days after the
    * link is generated, or 30 days after the invoice's due date — whichever is later.
@@ -2143,6 +2155,13 @@ export interface InvoiceListParams extends PageParams {
 
   external_customer_id?: string | null;
 
+  /**
+   * Whether to return line items with a quantity of zero. When omitted, Orb returns
+   * every line item. A line item that is grouped as part of a line item minimum is
+   * always returned; an invoice-level minimum does not exempt it.
+   */
+  include_zero_quantity_line_items?: boolean | null;
+
   'invoice_date[gt]'?: string | null;
 
   'invoice_date[gte]'?: string | null;
@@ -2162,8 +2181,24 @@ export interface InvoiceDeleteLineItemParams {
   invoice_id: string;
 }
 
+export interface InvoiceFetchParams {
+  /**
+   * Whether to return line items with a quantity of zero. When omitted, Orb returns
+   * every line item. A line item that is grouped as part of a line item minimum is
+   * always returned; an invoice-level minimum does not exempt it.
+   */
+  include_zero_quantity_line_items?: boolean | null;
+}
+
 export interface InvoiceFetchUpcomingParams {
   subscription_id: string;
+
+  /**
+   * Whether to return line items with a quantity of zero. When omitted, Orb returns
+   * every line item. A line item that is grouped as part of a line item minimum is
+   * always returned; an invoice-level minimum does not exempt it.
+   */
+  include_zero_quantity_line_items?: boolean | null;
 }
 
 export interface InvoiceIssueParams {
@@ -2264,6 +2299,7 @@ export declare namespace Invoices {
     type InvoiceUpdateParams as InvoiceUpdateParams,
     type InvoiceListParams as InvoiceListParams,
     type InvoiceDeleteLineItemParams as InvoiceDeleteLineItemParams,
+    type InvoiceFetchParams as InvoiceFetchParams,
     type InvoiceFetchUpcomingParams as InvoiceFetchUpcomingParams,
     type InvoiceIssueParams as InvoiceIssueParams,
     type InvoiceIssueSummaryParams as InvoiceIssueSummaryParams,

package/src/resources/shared.ts

@@ -564,6 +564,14 @@ export namespace ChangedSubscriptionResources {
      */
     eligible_to_issue_at: string | null;
 
+    /**
+     * The number of line items omitted from `line_items` because they have zero
+     * quantity. Amounts such as `subtotal` and `total` are computed over every line
+     * item on the invoice, including the omitted ones. In rare circumstances, hidden
+     * line items may still contribute to these amounts.
+     */
+    hidden_line_item_count: number;
+
     /**
      * A URL for the customer-facing invoice portal. This URL expires 60 days after the
      * link is generated, or 30 days after the invoice's due date — whichever is later.
@@ -2004,6 +2012,14 @@ export interface Invoice {
    */
   eligible_to_issue_at: string | null;
 
+  /**
+   * The number of line items omitted from `line_items` because they have zero
+   * quantity. Amounts such as `subtotal` and `total` are computed over every line
+   * item on the invoice, including the omitted ones. In rare circumstances, hidden
+   * line items may still contribute to these amounts.
+   */
+  hidden_line_item_count: number;
+
   /**
    * A URL for the customer-facing invoice portal. This URL expires 60 days after the
    * link is generated, or 30 days after the invoice's due date — whichever is later.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.18.0'; // x-release-please-version
+export const VERSION = '6.19.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.18.0";
+export declare const VERSION = "6.19.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.18.0";
+export declare const VERSION = "6.19.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 = '6.18.0'; // x-release-please-version
+exports.VERSION = '6.19.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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