orb-billing 1.38.0 → 1.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08d38e370980ec182afc292c85c50e3e3d97915a13674b58f16205536ac40509'
-  data.tar.gz: d6fabb14c95ee9c31d50ea0d2f77e0531ab4aa2719e36ae21d59911a53406962
+  metadata.gz: ae1a554ffa1f02c4a6389c6399a1ad669067740cb555aed61f1aa9f9431450f0
+  data.tar.gz: 61e554cca021010bd8a5fb9b05f6737277ebba9d41812e7f517c66c7263f1757
 SHA512:
-  metadata.gz: 18505cebc20678a82ead5270592e366c99faba099075532ea2f126cde3587e288c237fc1eac3ef617cff148f2f06e4973da7eb110490b175e9ef9b1ae99fed82
-  data.tar.gz: 84c365786b41b80d4609739230596d4728757c2ebbd38c32b40e7d94c37d5fed954d4e96fad227f1445e9210a725619431ad319601dca64b72f2c75afb6c1869
+  metadata.gz: 504c8ea65bf2ed7be2e1f88dc3a5cfef668638559902cecafaad975b8281019d86e3d25a0f9d20d06c758cc616b811bb22d5fd0fa980f8ac8cdb6724834f41ec
+  data.tar.gz: 9b751116050e2768715cdbc5b196c145f4efdcba8547c58fd1ac51d05208fa1d146c30b8bec593a4fa93954b8b8454275aaee2dd0535ae57885b4d40b6ab3772

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [1.40.0](https://github.com/orbcorp/orb-ruby/compare/v1.39.0...v1.40.0) (2026-10-07)
+
+
+### Features
+
+* **api:** add billable_metric_id filter, price_count, and prices list endpoint for dimensional price groups ([3b4e02a](https://github.com/orbcorp/orb-ruby/commit/3b4e02a8ad9286a0e1496a484e5255805c9a75ea))
+
+## [1.39.0](https://github.com/orbcorp/orb-ruby/compare/v1.38.0...v1.39.0) (2026-10-01)
+
+
+### Features
+
+* **api:** add `customer_id` and `status` filters to list backfills endpoint ([3d497bc](https://github.com/orbcorp/orb-ruby/commit/3d497bc1dde6257959f0bd502057e91b4229356e))
+* **api:** add `payment_received_at` field to invoice responses ([959a88d](https://github.com/orbcorp/orb-ruby/commit/959a88d58c0fb54a2d9c28a8c9c91f5a1a42c5a8))
+
+
+### Bug Fixes
+
+* **api:** correct webhook doc page titles and remove inapplicable auth section ([959a88d](https://github.com/orbcorp/orb-ruby/commit/959a88d58c0fb54a2d9c28a8c9c91f5a1a42c5a8))
+
 ## [1.38.0](https://github.com/orbcorp/orb-ruby/compare/v1.37.0...v1.38.0) (2026-09-25)
 
 

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.38.0"
+gem "orb-billing", "~> 1.40.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/models/changed_subscription_resources.rb

@@ -399,6 +399,17 @@ module Orb
         #   @return [Time, nil]
         required :payment_failed_at, Time, nil?: true
 
+        # @!attribute payment_received_at
+        #   When payment for this invoice was received. For an invoice manually marked as
+        #   paid, this is the `payment_received_date` that was supplied. For an invoice paid
+        #   through a payment provider, this is the settlement time reported by that
+        #   provider. It is `null` for an invoice that became `paid` without a payment, such
+        #   as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
+        #   when the invoice reached the `paid` status in Orb.
+        #
+        #   @return [Time, nil]
+        required :payment_received_at, Time, nil?: true
+
         # @!attribute payment_started_at
         #   If payment was attempted on this invoice, this will be the start time of the
         #   most recent attempt. This field is especially useful for delayed-notification
@@ -463,7 +474,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:, 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:)
+        # @!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_received_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.
         #
@@ -533,6 +544,8 @@ module Orb
         #
         #   @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
         #
+        #   @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
+        #
         #   @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
         #
         #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche

data/lib/orb/models/dimensional_price_group.rb

@@ -44,7 +44,14 @@ module Orb
       #   @return [String]
       required :name, String
 
-      # @!method initialize(id:, billable_metric_id:, dimensions:, external_dimensional_price_group_id:, metadata:, name:)
+      # @!attribute price_count
+      #   The number of prices in this group. Archived prices and subscription overrides
+      #   are excluded.
+      #
+      #   @return [Integer]
+      required :price_count, Integer
+
+      # @!method initialize(id:, billable_metric_id:, dimensions:, external_dimensional_price_group_id:, metadata:, name:, price_count:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::DimensionalPriceGroup} for more details.
       #
@@ -63,6 +70,8 @@ module Orb
       #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
       #
       #   @param name [String] The name of the dimensional price group
+      #
+      #   @param price_count [Integer] The number of prices in this group. Archived prices and subscription overrides a
     end
   end
 end

data/lib/orb/models/dimensional_price_group_list_params.rb

@@ -7,6 +7,12 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute billable_metric_id
+      #   Filter to groups that use this billable metric.
+      #
+      #   @return [String, nil]
+      optional :billable_metric_id, String, nil?: true
+
       # @!attribute cursor
       #   Cursor for pagination. This can be populated by the `next_cursor` value returned
       #   from the initial request.
@@ -20,10 +26,12 @@ module Orb
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!method initialize(cursor: nil, limit: nil, request_options: {})
+      # @!method initialize(billable_metric_id: nil, cursor: nil, limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::DimensionalPriceGroupListParams} for more details.
       #
+      #   @param billable_metric_id [String, nil] Filter to groups that use this billable metric.
+      #
       #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
       #
       #   @param limit [Integer] The number of items to fetch. Defaults to 20.

data/lib/orb/models/events/backfill_list_params.rb

@@ -15,21 +15,49 @@ module Orb
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String, nil?: true
+
         # @!attribute limit
         #   The number of items to fetch. Defaults to 20.
         #
         #   @return [Integer, nil]
         optional :limit, Integer
 
-        # @!method initialize(cursor: nil, limit: nil, request_options: {})
+        # @!attribute status
+        #   The status of the backfill.
+        #
+        #   @return [Symbol, Orb::Models::Events::BackfillListParams::Status, nil]
+        optional :status, enum: -> { Orb::Events::BackfillListParams::Status }, nil?: true
+
+        # @!method initialize(cursor: nil, customer_id: nil, limit: nil, status: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Events::BackfillListParams} for more details.
         #
         #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
         #
+        #   @param customer_id [String, nil]
+        #
         #   @param limit [Integer] The number of items to fetch. Defaults to 20.
         #
+        #   @param status [Symbol, Orb::Models::Events::BackfillListParams::Status, nil] The status of the backfill.
+        #
         #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+
+        # The status of the backfill.
+        module Status
+          extend Orb::Internal::Type::Enum
+
+          PENDING = :pending
+          REFLECTED = :reflected
+          PENDING_REVERT = :pending_revert
+          REVERTED = :reverted
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/orb/models/invoice.rb

@@ -355,6 +355,17 @@ module Orb
       #   @return [Time, nil]
       required :payment_failed_at, Time, nil?: true
 
+      # @!attribute payment_received_at
+      #   When payment for this invoice was received. For an invoice manually marked as
+      #   paid, this is the `payment_received_date` that was supplied. For an invoice paid
+      #   through a payment provider, this is the settlement time reported by that
+      #   provider. It is `null` for an invoice that became `paid` without a payment, such
+      #   as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
+      #   when the invoice reached the `paid` status in Orb.
+      #
+      #   @return [Time, nil]
+      required :payment_received_at, Time, nil?: true
+
       # @!attribute payment_started_at
       #   If payment was attempted on this invoice, this will be the start time of the
       #   most recent attempt. This field is especially useful for delayed-notification
@@ -419,7 +430,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:, 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:)
+      # @!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_received_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.
       #
@@ -493,6 +504,8 @@ module Orb
       #
       #   @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
       #
+      #   @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
+      #
       #   @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
       #
       #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche

data/lib/orb/models/invoice_fetch_upcoming_response.rb

@@ -353,6 +353,17 @@ module Orb
       #   @return [Time, nil]
       required :payment_failed_at, Time, nil?: true
 
+      # @!attribute payment_received_at
+      #   When payment for this invoice was received. For an invoice manually marked as
+      #   paid, this is the `payment_received_date` that was supplied. For an invoice paid
+      #   through a payment provider, this is the settlement time reported by that
+      #   provider. It is `null` for an invoice that became `paid` without a payment, such
+      #   as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
+      #   when the invoice reached the `paid` status in Orb.
+      #
+      #   @return [Time, nil]
+      required :payment_received_at, Time, nil?: true
+
       # @!attribute payment_started_at
       #   If payment was attempted on this invoice, this will be the start time of the
       #   most recent attempt. This field is especially useful for delayed-notification
@@ -423,7 +434,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:, 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:)
+      # @!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_received_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.
       #
@@ -489,6 +500,8 @@ module Orb
       #
       #   @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
       #
+      #   @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
+      #
       #   @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
       #
       #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche

data/lib/orb/models/invoice_issue_summary_response.rb

@@ -308,6 +308,17 @@ module Orb
       #   @return [Time, nil]
       required :payment_failed_at, Time, nil?: true
 
+      # @!attribute payment_received_at
+      #   When payment for this invoice was received. For an invoice manually marked as
+      #   paid, this is the `payment_received_date` that was supplied. For an invoice paid
+      #   through a payment provider, this is the settlement time reported by that
+      #   provider. It is `null` for an invoice that became `paid` without a payment, such
+      #   as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
+      #   when the invoice reached the `paid` status in Orb.
+      #
+      #   @return [Time, nil]
+      required :payment_received_at, Time, nil?: true
+
       # @!attribute payment_started_at
       #   If payment was attempted on this invoice, this will be the start time of the
       #   most recent attempt. This field is especially useful for delayed-notification
@@ -366,7 +377,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:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, 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:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::InvoiceIssueSummaryResponse} for more details.
       #
@@ -420,6 +431,8 @@ module Orb
       #
       #   @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
       #
+      #   @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
+      #
       #   @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
       #
       #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche

data/lib/orb/models/invoice_issued_summary_webhook_event.rb

@@ -352,6 +352,17 @@ module Orb
         #   @return [Time, nil]
         required :payment_failed_at, Time, nil?: true
 
+        # @!attribute payment_received_at
+        #   When payment for this invoice was received. For an invoice manually marked as
+        #   paid, this is the `payment_received_date` that was supplied. For an invoice paid
+        #   through a payment provider, this is the settlement time reported by that
+        #   provider. It is `null` for an invoice that became `paid` without a payment, such
+        #   as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
+        #   when the invoice reached the `paid` status in Orb.
+        #
+        #   @return [Time, nil]
+        required :payment_received_at, Time, nil?: true
+
         # @!attribute payment_started_at
         #   If payment was attempted on this invoice, this will be the start time of the
         #   most recent attempt. This field is especially useful for delayed-notification
@@ -410,7 +421,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:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, 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:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice} for more details.
         #
@@ -464,6 +475,8 @@ module Orb
         #
         #   @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
         #
+        #   @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
+        #
         #   @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
         #
         #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche

data/lib/orb/models/invoice_list_summary_response.rb

@@ -308,6 +308,17 @@ module Orb
       #   @return [Time, nil]
       required :payment_failed_at, Time, nil?: true
 
+      # @!attribute payment_received_at
+      #   When payment for this invoice was received. For an invoice manually marked as
+      #   paid, this is the `payment_received_date` that was supplied. For an invoice paid
+      #   through a payment provider, this is the settlement time reported by that
+      #   provider. It is `null` for an invoice that became `paid` without a payment, such
+      #   as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
+      #   when the invoice reached the `paid` status in Orb.
+      #
+      #   @return [Time, nil]
+      required :payment_received_at, Time, nil?: true
+
       # @!attribute payment_started_at
       #   If payment was attempted on this invoice, this will be the start time of the
       #   most recent attempt. This field is especially useful for delayed-notification
@@ -366,7 +377,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:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, 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:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::InvoiceListSummaryResponse} for more details.
       #
@@ -420,6 +431,8 @@ module Orb
       #
       #   @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
       #
+      #   @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
+      #
       #   @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
       #
       #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche

data/lib/orb/resources/dimensional_price_groups.rb

@@ -107,10 +107,15 @@ module Orb
       # dimensions, and the prices in the group specify which partition their usage is
       # derived from.
       #
+      # Filter with `billable_metric_id`. Each group includes `price_count`:
+      # non-archived prices in the group. Subscription overrides are not counted.
+      #
       # The response also includes pagination_metadata, which lets the caller retrieve
       # the next page of results if they exist.
       #
-      # @overload list(cursor: nil, limit: nil, request_options: {})
+      # @overload list(billable_metric_id: nil, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param billable_metric_id [String, nil] Filter to groups that use this billable metric.
       #
       # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
       #

data/lib/orb/resources/events/backfills.rb

@@ -46,7 +46,10 @@ module Orb
         # enables filtering using
         # [computed properties](/extensibility/advanced-metrics#computed-properties). The
         # expressiveness of computed properties allows you to deprecate existing events
-        # based on both a period of time and specific property values.
+        # based on both a period of time and specific property values. When
+        # `deprecation_filter` is provided, the timeframe may extend to `now` rather than
+        # the event reporting grace boundary. Matching events that arrive later with
+        # timestamps inside the timeframe will also be deprecated.
         #
         # You may not have multiple backfills in a pending or pending_revert state with
         # overlapping timeframes.
@@ -93,12 +96,18 @@ module Orb
         # [`pagination_metadata`](/api-reference/pagination), which lets the caller
         # retrieve the next page of results if they exist.
         #
-        # @overload list(cursor: nil, limit: nil, request_options: {})
+        # Use `customer_id` and `status` to filter the results.
+        #
+        # @overload list(cursor: nil, customer_id: nil, limit: nil, status: nil, request_options: {})
         #
         # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
         #
+        # @param customer_id [String, nil]
+        #
         # @param limit [Integer] The number of items to fetch. Defaults to 20.
         #
+        # @param status [Symbol, Orb::Models::Events::BackfillListParams::Status, nil] The status of the backfill.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Internal::Page<Orb::Models::Events::BackfillListResponse>]

data/lib/orb/version.rb

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

data/rbi/orb/models/changed_subscription_resources.rbi

@@ -416,6 +416,15 @@ module Orb
         sig { returns(T.nilable(Time)) }
         attr_accessor :payment_failed_at
 
+        # When payment for this invoice was received. For an invoice manually marked as
+        # paid, this is the `payment_received_date` that was supplied. For an invoice paid
+        # through a payment provider, this is the settlement time reported by that
+        # provider. It is `null` for an invoice that became `paid` without a payment, such
+        # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
+        # when the invoice reached the `paid` status in Orb.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :payment_received_at
+
         # If payment was attempted on this invoice, this will be the start time of the
         # most recent attempt. This field is especially useful for delayed-notification
         # payment mechanisms (like bank transfers), where payment can take 3 days or more.
@@ -531,6 +540,7 @@ module Orb
                 Orb::ChangedSubscriptionResources::CreatedInvoice::PaymentAttempt::OrHash
               ],
             payment_failed_at: T.nilable(Time),
+            payment_received_at: T.nilable(Time),
             payment_started_at: T.nilable(Time),
             scheduled_issue_at: T.nilable(Time),
             shipping_address: T.nilable(Orb::Address::OrHash),
@@ -768,6 +778,13 @@ module Orb
           # If payment was attempted on this invoice but failed, this will be the time of
           # the most recent attempt.
           payment_failed_at:,
+          # When payment for this invoice was received. For an invoice manually marked as
+          # paid, this is the `payment_received_date` that was supplied. For an invoice paid
+          # through a payment provider, this is the settlement time reported by that
+          # provider. It is `null` for an invoice that became `paid` without a payment, such
+          # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
+          # when the invoice reached the `paid` status in Orb.
+          payment_received_at:,
           # If payment was attempted on this invoice, this will be the start time of the
           # most recent attempt. This field is especially useful for delayed-notification
           # payment mechanisms (like bank transfers), where payment can take 3 days or more.
@@ -845,6 +862,7 @@ module Orb
                   Orb::ChangedSubscriptionResources::CreatedInvoice::PaymentAttempt
                 ],
               payment_failed_at: T.nilable(Time),
+              payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address),

data/rbi/orb/models/dimensional_price_group.rbi

@@ -36,6 +36,11 @@ module Orb
       sig { returns(String) }
       attr_accessor :name
 
+      # The number of prices in this group. Archived prices and subscription overrides
+      # are excluded.
+      sig { returns(Integer) }
+      attr_accessor :price_count
+
       # A dimensional price group is used to partition the result of a billable metric
       # by a set of dimensions. Prices in a price group must specify the partition used
       # to derive their usage.
@@ -46,7 +51,8 @@ module Orb
           dimensions: T::Array[String],
           external_dimensional_price_group_id: T.nilable(String),
           metadata: T::Hash[Symbol, String],
-          name: String
+          name: String,
+          price_count: Integer
         ).returns(T.attached_class)
       end
       def self.new(
@@ -65,7 +71,10 @@ module Orb
         # `null`.
         metadata:,
         # The name of the dimensional price group
-        name:
+        name:,
+        # The number of prices in this group. Archived prices and subscription overrides
+        # are excluded.
+        price_count:
       )
       end
 
@@ -77,7 +86,8 @@ module Orb
             dimensions: T::Array[String],
             external_dimensional_price_group_id: T.nilable(String),
             metadata: T::Hash[Symbol, String],
-            name: String
+            name: String,
+            price_count: Integer
           }
         )
       end

data/rbi/orb/models/dimensional_price_group_list_params.rbi

@@ -11,6 +11,10 @@ module Orb
           T.any(Orb::DimensionalPriceGroupListParams, Orb::Internal::AnyHash)
         end
 
+      # Filter to groups that use this billable metric.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :billable_metric_id
+
       # Cursor for pagination. This can be populated by the `next_cursor` value returned
       # from the initial request.
       sig { returns(T.nilable(String)) }
@@ -25,12 +29,15 @@ module Orb
 
       sig do
         params(
+          billable_metric_id: T.nilable(String),
           cursor: T.nilable(String),
           limit: Integer,
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # Filter to groups that use this billable metric.
+        billable_metric_id: nil,
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
         # from the initial request.
         cursor: nil,
@@ -43,6 +50,7 @@ module Orb
       sig do
         override.returns(
           {
+            billable_metric_id: T.nilable(String),
             cursor: T.nilable(String),
             limit: Integer,
             request_options: Orb::RequestOptions