orb-billing 1.32.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474c5f8856abcdfd5bb60bb6189ff6df0c37d53904af22c15217c13345be0981
-  data.tar.gz: b7e0e71a2d5f327cd97ff719dbeb8abdc5865fb302527df8aa7e74c59629b861
+  metadata.gz: d22f2113a4acbd1c6f8d94504b3c2e5b751636c2e24cd2c7bdc25897e3d6dd8b
+  data.tar.gz: 4b5092fb788b3bd1b064c20fe160a92bccf05e2394b1af40b715df5db403a27f
 SHA512:
-  metadata.gz: d2c18d18236ba5ef13d5b57a1a7019188b78c163655b7088be529a5a4e7e930346fc51446e758b789d12f962893c2632a6367d1530177eff8a370e02dcf16e7b
-  data.tar.gz: '08bd0e25966042f967884e2e2f0b90a00ae6efc8758823d9768f3db1bef4c629d9e59b072d78c8743a1c496804b9a4789665ca9aba251c0bb715c1f8e1dd8772'
+  metadata.gz: 322da3b2af920d12a3967a9599f3c2b1a104e25497a66d42175e2387f6879edbe7e8338a5cecd098a009c5347046f6de5863a161f049e67ab31b78cb965d1573
+  data.tar.gz: 8a7db721c8affc90f7c0b32113ab96118dc139005bba72b2a8ee03b6944aff99413f8b9e296b96f911c21097e4597143a43ae1da4dafb048dea667d0a896df20

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.34.0](https://github.com/orbcorp/orb-ruby/compare/v1.33.0...v1.34.0) (2026-09-13)
+
+
+### Features
+
+* **api:** add `include_zero_quantity_line_items` param and `hidden_line_item_count` to invoice endpoints ([69e2aaa](https://github.com/orbcorp/orb-ruby/commit/69e2aaa6d1b8227f7342735077c25cbcca72804e))
+
+## [1.33.0](https://github.com/orbcorp/orb-ruby/compare/v1.32.0...v1.33.0) (2026-09-12)
+
+
+### Features
+
+* **api:** remove deprecated debug parameter and response details from ingestion ([ab3504d](https://github.com/orbcorp/orb-ruby/commit/ab3504dea69e04f8e83747110b8b962b11dec833))
+
 ## [1.32.0](https://github.com/orbcorp/orb-ruby/compare/v1.31.0...v1.32.0) (2026-09-10)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 1.32.0"
+gem "orb-billing", "~> 1.34.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/models/changed_subscription_resources.rb

@@ -275,6 +275,15 @@ module Orb
         #   @return [Time, nil]
         required :eligible_to_issue_at, Time, nil?: true
 
+        # @!attribute hidden_line_item_count
+        #   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.
+        #
+        #   @return [Integer]
+        required :hidden_line_item_count, Integer
+
         # @!attribute hosted_invoice_url
         #   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.
@@ -454,7 +463,7 @@ module Orb
         #   @return [Boolean]
         required :will_auto_issue, Orb::Internal::Type::Boolean
 
-        # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, is_payable_now:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+        # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, is_payable_now:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::ChangedSubscriptionResources::CreatedInvoice} for more details.
         #
@@ -486,6 +495,8 @@ module Orb
         #
         #   @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
         #
+        #   @param hidden_line_item_count [Integer] The number of line items omitted from `line_items` because they have zero quanti
+        #
         #   @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 60 days after the
         #
         #   @param invoice_date [Time] The scheduled date of the invoice

data/lib/orb/models/invoice.rb

@@ -239,6 +239,15 @@ module Orb
       #   @return [Time, nil]
       required :eligible_to_issue_at, Time, nil?: true
 
+      # @!attribute hidden_line_item_count
+      #   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.
+      #
+      #   @return [Integer]
+      required :hidden_line_item_count, Integer
+
       # @!attribute hosted_invoice_url
       #   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.
@@ -410,7 +419,7 @@ module Orb
       #   @return [Boolean]
       required :will_auto_issue, Orb::Internal::Type::Boolean
 
-      # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+      # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
       #   Some parameter documentations has been truncated, see {Orb::Models::Invoice} for
       #   more details.
       #
@@ -448,6 +457,8 @@ module Orb
       #
       #   @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
       #
+      #   @param hidden_line_item_count [Integer] The number of line items omitted from `line_items` because they have zero quanti
+      #
       #   @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 60 days after the
       #
       #   @param invoice_date [Time] The scheduled date of the invoice

data/lib/orb/models/invoice_fetch_params.rb

@@ -12,8 +12,22 @@ module Orb
       #   @return [String]
       required :invoice_id, String
 
-      # @!method initialize(invoice_id:, request_options: {})
+      # @!attribute include_zero_quantity_line_items
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :include_zero_quantity_line_items, Orb::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(invoice_id:, include_zero_quantity_line_items: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceFetchParams} for more details.
+      #
       #   @param invoice_id [String]
+      #
+      #   @param include_zero_quantity_line_items [Boolean, nil] Whether to return line items with a quantity of zero. When omitted, Orb returns
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/invoice_fetch_upcoming_params.rb

@@ -12,8 +12,22 @@ module Orb
       #   @return [String]
       required :subscription_id, String
 
-      # @!method initialize(subscription_id:, request_options: {})
+      # @!attribute include_zero_quantity_line_items
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :include_zero_quantity_line_items, Orb::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(subscription_id:, include_zero_quantity_line_items: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceFetchUpcomingParams} for more details.
+      #
       #   @param subscription_id [String]
+      #
+      #   @param include_zero_quantity_line_items [Boolean, nil] Whether to return line items with a quantity of zero. When omitted, Orb returns
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/invoice_fetch_upcoming_response.rb

@@ -241,6 +241,15 @@ module Orb
       #   @return [Time, nil]
       required :eligible_to_issue_at, Time, nil?: true
 
+      # @!attribute hidden_line_item_count
+      #   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.
+      #
+      #   @return [Integer]
+      required :hidden_line_item_count, Integer
+
       # @!attribute hosted_invoice_url
       #   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.
@@ -414,7 +423,7 @@ module Orb
       #   @return [Boolean]
       required :will_auto_issue, Orb::Internal::Type::Boolean
 
-      # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, target_date:, total:, voided_at:, will_auto_issue:)
+      # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hidden_line_item_count:, hosted_invoice_url:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, target_date:, total:, voided_at:, will_auto_issue:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::InvoiceFetchUpcomingResponse} for more details.
       #
@@ -446,6 +455,8 @@ module Orb
       #
       #   @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
       #
+      #   @param hidden_line_item_count [Integer] The number of line items omitted from `line_items` because they have zero quanti
+      #
       #   @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 60 days after the
       #
       #   @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv

data/lib/orb/models/invoice_list_params.rb

@@ -68,6 +68,14 @@ module Orb
       #   @return [String, nil]
       optional :external_customer_id, String, nil?: true
 
+      # @!attribute include_zero_quantity_line_items
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :include_zero_quantity_line_items, Orb::Internal::Type::Boolean, nil?: true
+
       # @!attribute invoice_date_gt
       #
       #   @return [Time, nil]
@@ -109,7 +117,7 @@ module Orb
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!method initialize(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {})
+      # @!method initialize(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, include_zero_quantity_line_items: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::InvoiceListParams} for more details.
       #
@@ -135,6 +143,8 @@ module Orb
       #
       #   @param external_customer_id [String, nil]
       #
+      #   @param include_zero_quantity_line_items [Boolean, nil] Whether to return line items with a quantity of zero. When omitted, Orb returns
+      #
       #   @param invoice_date_gt [Time, nil]
       #
       #   @param invoice_date_gte [Time, nil]

data/lib/orb/resources/invoices.rb

@@ -112,7 +112,7 @@ module Orb
       # the [list invoices summary](/api-reference/invoice/list-invoices-summary)
       # endpoint for better performance.
       #
-      # @overload list(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {})
+      # @overload list(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, include_zero_quantity_line_items: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {})
       #
       # @param amount [String, nil]
       #
@@ -136,6 +136,8 @@ module Orb
       #
       # @param external_customer_id [String, nil]
       #
+      # @param include_zero_quantity_line_items [Boolean, nil] Whether to return line items with a quantity of zero. When omitted, Orb returns
+      #
       # @param invoice_date_gt [Time, nil]
       #
       # @param invoice_date_gte [Time, nil]
@@ -208,33 +210,48 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::InvoiceFetchParams} for more details.
+      #
       # This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an
       # identifier.
       #
-      # @overload fetch(invoice_id, request_options: {})
+      # @overload fetch(invoice_id, include_zero_quantity_line_items: nil, request_options: {})
       #
       # @param invoice_id [String]
+      #
+      # @param include_zero_quantity_line_items [Boolean, nil] Whether to return line items with a quantity of zero. When omitted, Orb returns
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Invoice]
       #
       # @see Orb::Models::InvoiceFetchParams
       def fetch(invoice_id, params = {})
+        parsed, options = Orb::InvoiceFetchParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["invoices/%1$s", invoice_id],
+          query: query,
           model: Orb::Invoice,
-          options: params[:request_options]
+          options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::InvoiceFetchUpcomingParams} for more details.
+      #
       # This endpoint can be used to fetch the upcoming
       # [invoice](/core-concepts#invoice) for the current billing period given a
       # subscription.
       #
-      # @overload fetch_upcoming(subscription_id:, request_options: {})
+      # @overload fetch_upcoming(subscription_id:, include_zero_quantity_line_items: nil, request_options: {})
       #
       # @param subscription_id [String]
+      #
+      # @param include_zero_quantity_line_items [Boolean, nil] Whether to return line items with a quantity of zero. When omitted, Orb returns
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::InvoiceFetchUpcomingResponse]

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.32.0"
+  VERSION = "1.34.0"
 end

data/rbi/orb/models/changed_subscription_resources.rbi

@@ -310,6 +310,13 @@ module Orb
         sig { returns(T.nilable(Time)) }
         attr_accessor :eligible_to_issue_at
 
+        # 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.
+        sig { returns(Integer) }
+        attr_accessor :hidden_line_item_count
+
         # 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.
         sig { returns(T.nilable(String)) }
@@ -498,6 +505,7 @@ module Orb
               ],
             due_date: T.nilable(Time),
             eligible_to_issue_at: T.nilable(Time),
+            hidden_line_item_count: Integer,
             hosted_invoice_url: T.nilable(String),
             invoice_date: Time,
             invoice_number: String,
@@ -714,6 +722,11 @@ module Orb
           # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
           # true, the invoice will automatically begin issuing at this time.
           eligible_to_issue_at:,
+          # 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:,
           # 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.
           hosted_invoice_url:,
@@ -806,6 +819,7 @@ module Orb
               discounts: T::Array[Orb::InvoiceLevelDiscount::Variants],
               due_date: T.nilable(Time),
               eligible_to_issue_at: T.nilable(Time),
+              hidden_line_item_count: Integer,
               hosted_invoice_url: T.nilable(String),
               invoice_date: Time,
               invoice_number: String,

data/rbi/orb/models/invoice.rbi

@@ -224,6 +224,13 @@ module Orb
       sig { returns(T.nilable(Time)) }
       attr_accessor :eligible_to_issue_at
 
+      # 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.
+      sig { returns(Integer) }
+      attr_accessor :hidden_line_item_count
+
       # 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.
       sig { returns(T.nilable(String)) }
@@ -385,6 +392,7 @@ module Orb
             ],
           due_date: T.nilable(Time),
           eligible_to_issue_at: T.nilable(Time),
+          hidden_line_item_count: Integer,
           hosted_invoice_url: T.nilable(String),
           invoice_date: Time,
           invoice_number: String,
@@ -592,6 +600,11 @@ module Orb
         # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
         # true, the invoice will automatically begin issuing at this time.
         eligible_to_issue_at:,
+        # 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:,
         # 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.
         hosted_invoice_url:,
@@ -676,6 +689,7 @@ module Orb
             discounts: T::Array[Orb::InvoiceLevelDiscount::Variants],
             due_date: T.nilable(Time),
             eligible_to_issue_at: T.nilable(Time),
+            hidden_line_item_count: Integer,
             hosted_invoice_url: T.nilable(String),
             invoice_date: Time,
             invoice_number: String,

data/rbi/orb/models/invoice_fetch_params.rbi

@@ -12,18 +12,36 @@ module Orb
       sig { returns(String) }
       attr_accessor :invoice_id
 
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :include_zero_quantity_line_items
+
       sig do
         params(
           invoice_id: String,
+          include_zero_quantity_line_items: T.nilable(T::Boolean),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(invoice_id:, request_options: {})
+      def self.new(
+        invoice_id:,
+        # 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: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { invoice_id: String, request_options: Orb::RequestOptions }
+          {
+            invoice_id: String,
+            include_zero_quantity_line_items: T.nilable(T::Boolean),
+            request_options: Orb::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/orb/models/invoice_fetch_upcoming_params.rbi

@@ -14,18 +14,36 @@ module Orb
       sig { returns(String) }
       attr_accessor :subscription_id
 
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :include_zero_quantity_line_items
+
       sig do
         params(
           subscription_id: String,
+          include_zero_quantity_line_items: T.nilable(T::Boolean),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(subscription_id:, request_options: {})
+      def self.new(
+        subscription_id:,
+        # 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: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { subscription_id: String, request_options: Orb::RequestOptions }
+          {
+            subscription_id: String,
+            include_zero_quantity_line_items: T.nilable(T::Boolean),
+            request_options: Orb::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/orb/models/invoice_fetch_upcoming_response.rbi

@@ -243,6 +243,13 @@ module Orb
       sig { returns(T.nilable(Time)) }
       attr_accessor :eligible_to_issue_at
 
+      # 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.
+      sig { returns(Integer) }
+      attr_accessor :hidden_line_item_count
+
       # 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.
       sig { returns(T.nilable(String)) }
@@ -417,6 +424,7 @@ module Orb
             ],
           due_date: T.nilable(Time),
           eligible_to_issue_at: T.nilable(Time),
+          hidden_line_item_count: Integer,
           hosted_invoice_url: T.nilable(String),
           invoice_number: String,
           invoice_pdf: T.nilable(String),
@@ -631,6 +639,11 @@ module Orb
         # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
         # true, the invoice will automatically begin issuing at this time.
         eligible_to_issue_at:,
+        # 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:,
         # 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.
         hosted_invoice_url:,
@@ -719,6 +732,7 @@ module Orb
             discounts: T::Array[Orb::InvoiceLevelDiscount::Variants],
             due_date: T.nilable(Time),
             eligible_to_issue_at: T.nilable(Time),
+            hidden_line_item_count: Integer,
             hosted_invoice_url: T.nilable(String),
             invoice_number: String,
             invoice_pdf: T.nilable(String),

data/rbi/orb/models/invoice_list_params.rbi

@@ -48,6 +48,12 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :external_customer_id
 
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :include_zero_quantity_line_items
+
       sig { returns(T.nilable(Time)) }
       attr_accessor :invoice_date_gt
 
@@ -91,6 +97,7 @@ module Orb
           due_date_gt: T.nilable(Date),
           due_date_lt: T.nilable(Date),
           external_customer_id: T.nilable(String),
+          include_zero_quantity_line_items: T.nilable(T::Boolean),
           invoice_date_gt: T.nilable(Time),
           invoice_date_gte: T.nilable(Time),
           invoice_date_lt: T.nilable(Time),
@@ -120,6 +127,10 @@ module Orb
         due_date_gt: nil,
         due_date_lt: nil,
         external_customer_id: nil,
+        # 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: nil,
         invoice_date_gt: nil,
         invoice_date_gte: nil,
         invoice_date_lt: nil,
@@ -147,6 +158,7 @@ module Orb
             due_date_gt: T.nilable(Date),
             due_date_lt: T.nilable(Date),
             external_customer_id: T.nilable(String),
+            include_zero_quantity_line_items: T.nilable(T::Boolean),
             invoice_date_gt: T.nilable(Time),
             invoice_date_gte: T.nilable(Time),
             invoice_date_lt: T.nilable(Time),

data/rbi/orb/resources/invoices.rbi

@@ -156,6 +156,7 @@ module Orb
           due_date_gt: T.nilable(Date),
           due_date_lt: T.nilable(Date),
           external_customer_id: T.nilable(String),
+          include_zero_quantity_line_items: T.nilable(T::Boolean),
           invoice_date_gt: T.nilable(Time),
           invoice_date_gte: T.nilable(Time),
           invoice_date_lt: T.nilable(Time),
@@ -185,6 +186,10 @@ module Orb
         due_date_gt: nil,
         due_date_lt: nil,
         external_customer_id: nil,
+        # 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: nil,
         invoice_date_gt: nil,
         invoice_date_gte: nil,
         invoice_date_lt: nil,
@@ -218,10 +223,18 @@ module Orb
       sig do
         params(
           invoice_id: String,
+          include_zero_quantity_line_items: T.nilable(T::Boolean),
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::Invoice)
       end
-      def fetch(invoice_id, request_options: {})
+      def fetch(
+        invoice_id,
+        # 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: nil,
+        request_options: {}
+      )
       end
 
       # This endpoint can be used to fetch the upcoming
@@ -230,10 +243,18 @@ module Orb
       sig do
         params(
           subscription_id: String,
+          include_zero_quantity_line_items: T.nilable(T::Boolean),
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::Models::InvoiceFetchUpcomingResponse)
       end
-      def fetch_upcoming(subscription_id:, request_options: {})
+      def fetch_upcoming(
+        subscription_id:,
+        # 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: nil,
+        request_options: {}
+      )
       end
 
       # This endpoint allows an eligible invoice to be issued manually. This is only

data/sig/orb/models/changed_subscription_resources.rbs

@@ -47,6 +47,7 @@ module Orb
           discounts: ::Array[Orb::Models::invoice_level_discount],
           due_date: Time?,
           eligible_to_issue_at: Time?,
+          hidden_line_item_count: Integer,
           hosted_invoice_url: String?,
           invoice_date: Time,
           invoice_number: String,
@@ -106,6 +107,8 @@ module Orb
 
         attr_accessor eligible_to_issue_at: Time?
 
+        attr_accessor hidden_line_item_count: Integer
+
         attr_accessor hosted_invoice_url: String?
 
         attr_accessor invoice_date: Time
@@ -177,6 +180,7 @@ module Orb
           discounts: ::Array[Orb::Models::invoice_level_discount],
           due_date: Time?,
           eligible_to_issue_at: Time?,
+          hidden_line_item_count: Integer,
           hosted_invoice_url: String?,
           invoice_date: Time,
           invoice_number: String,
@@ -222,6 +226,7 @@ module Orb
           discounts: ::Array[Orb::Models::invoice_level_discount],
           due_date: Time?,
           eligible_to_issue_at: Time?,
+          hidden_line_item_count: Integer,
           hosted_invoice_url: String?,
           invoice_date: Time,
           invoice_number: String,

data/sig/orb/models/invoice.rbs

@@ -16,6 +16,7 @@ module Orb
         discounts: ::Array[Orb::Models::invoice_level_discount],
         due_date: Time?,
         eligible_to_issue_at: Time?,
+        hidden_line_item_count: Integer,
         hosted_invoice_url: String?,
         invoice_date: Time,
         invoice_number: String,
@@ -74,6 +75,8 @@ module Orb
 
       attr_accessor eligible_to_issue_at: Time?
 
+      attr_accessor hidden_line_item_count: Integer
+
       attr_accessor hosted_invoice_url: String?
 
       attr_accessor invoice_date: Time
@@ -143,6 +146,7 @@ module Orb
         discounts: ::Array[Orb::Models::invoice_level_discount],
         due_date: Time?,
         eligible_to_issue_at: Time?,
+        hidden_line_item_count: Integer,
         hosted_invoice_url: String?,
         invoice_date: Time,
         invoice_number: String,
@@ -187,6 +191,7 @@ module Orb
         discounts: ::Array[Orb::Models::invoice_level_discount],
         due_date: Time?,
         eligible_to_issue_at: Time?,
+        hidden_line_item_count: Integer,
         hosted_invoice_url: String?,
         invoice_date: Time,
         invoice_number: String,

data/sig/orb/models/invoice_fetch_params.rbs

@@ -1,7 +1,8 @@
 module Orb
   module Models
     type invoice_fetch_params =
-      { invoice_id: String } & Orb::Internal::Type::request_parameters
+      { invoice_id: String, include_zero_quantity_line_items: bool? }
+      & Orb::Internal::Type::request_parameters
 
     class InvoiceFetchParams < Orb::Internal::Type::BaseModel
       extend Orb::Internal::Type::RequestParameters::Converter
@@ -9,13 +10,17 @@ module Orb
 
       attr_accessor invoice_id: String
 
+      attr_accessor include_zero_quantity_line_items: bool?
+
       def initialize: (
         invoice_id: String,
+        ?include_zero_quantity_line_items: bool?,
         ?request_options: Orb::request_opts
       ) -> void
 
       def to_hash: -> {
         invoice_id: String,
+        include_zero_quantity_line_items: bool?,
         request_options: Orb::RequestOptions
       }
     end

data/sig/orb/models/invoice_fetch_upcoming_params.rbs

@@ -1,7 +1,8 @@
 module Orb
   module Models
     type invoice_fetch_upcoming_params =
-      { subscription_id: String } & Orb::Internal::Type::request_parameters
+      { subscription_id: String, include_zero_quantity_line_items: bool? }
+      & Orb::Internal::Type::request_parameters
 
     class InvoiceFetchUpcomingParams < Orb::Internal::Type::BaseModel
       extend Orb::Internal::Type::RequestParameters::Converter
@@ -9,13 +10,17 @@ module Orb
 
       attr_accessor subscription_id: String
 
+      attr_accessor include_zero_quantity_line_items: bool?
+
       def initialize: (
         subscription_id: String,
+        ?include_zero_quantity_line_items: bool?,
         ?request_options: Orb::request_opts
       ) -> void
 
       def to_hash: -> {
         subscription_id: String,
+        include_zero_quantity_line_items: bool?,
         request_options: Orb::RequestOptions
       }
     end

data/sig/orb/models/invoice_fetch_upcoming_response.rbs

@@ -16,6 +16,7 @@ module Orb
         discounts: ::Array[Orb::Models::invoice_level_discount],
         due_date: Time?,
         eligible_to_issue_at: Time?,
+        hidden_line_item_count: Integer,
         hosted_invoice_url: String?,
         invoice_number: String,
         invoice_pdf: String?,
@@ -74,6 +75,8 @@ module Orb
 
       attr_accessor eligible_to_issue_at: Time?
 
+      attr_accessor hidden_line_item_count: Integer
+
       attr_accessor hosted_invoice_url: String?
 
       attr_accessor invoice_number: String
@@ -143,6 +146,7 @@ module Orb
         discounts: ::Array[Orb::Models::invoice_level_discount],
         due_date: Time?,
         eligible_to_issue_at: Time?,
+        hidden_line_item_count: Integer,
         hosted_invoice_url: String?,
         invoice_number: String,
         invoice_pdf: String?,
@@ -187,6 +191,7 @@ module Orb
         discounts: ::Array[Orb::Models::invoice_level_discount],
         due_date: Time?,
         eligible_to_issue_at: Time?,
+        hidden_line_item_count: Integer,
         hosted_invoice_url: String?,
         invoice_number: String,
         invoice_pdf: String?,

data/sig/orb/models/invoice_list_params.rbs

@@ -13,6 +13,7 @@ module Orb
         due_date_gt: Date?,
         due_date_lt: Date?,
         external_customer_id: String?,
+        include_zero_quantity_line_items: bool?,
         invoice_date_gt: Time?,
         invoice_date_gte: Time?,
         invoice_date_lt: Time?,
@@ -50,6 +51,8 @@ module Orb
 
       attr_accessor external_customer_id: String?
 
+      attr_accessor include_zero_quantity_line_items: bool?
+
       attr_accessor invoice_date_gt: Time?
 
       attr_accessor invoice_date_gte: Time?
@@ -80,6 +83,7 @@ module Orb
         ?due_date_gt: Date?,
         ?due_date_lt: Date?,
         ?external_customer_id: String?,
+        ?include_zero_quantity_line_items: bool?,
         ?invoice_date_gt: Time?,
         ?invoice_date_gte: Time?,
         ?invoice_date_lt: Time?,
@@ -103,6 +107,7 @@ module Orb
         due_date_gt: Date?,
         due_date_lt: Date?,
         external_customer_id: String?,
+        include_zero_quantity_line_items: bool?,
         invoice_date_gt: Time?,
         invoice_date_gte: Time?,
         invoice_date_lt: Time?,

data/sig/orb/resources/invoices.rbs

@@ -39,6 +39,7 @@ module Orb
         ?due_date_gt: Date?,
         ?due_date_lt: Date?,
         ?external_customer_id: String?,
+        ?include_zero_quantity_line_items: bool?,
         ?invoice_date_gt: Time?,
         ?invoice_date_gte: Time?,
         ?invoice_date_lt: Time?,
@@ -58,11 +59,13 @@ module Orb
 
       def fetch: (
         String invoice_id,
+        ?include_zero_quantity_line_items: bool?,
         ?request_options: Orb::request_opts
       ) -> Orb::Invoice
 
       def fetch_upcoming: (
         subscription_id: String,
+        ?include_zero_quantity_line_items: bool?,
         ?request_options: Orb::request_opts
       ) -> Orb::Models::InvoiceFetchUpcomingResponse
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orb-billing
 version: !ruby/object:Gem::Version
-  version: 1.32.0
+  version: 1.34.0
 platform: ruby
 authors:
 - Orb