orb-billing 1.49.0 → 1.51.0

data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb

@@ -395,6 +395,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -438,7 +454,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_received_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:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice} for
           #   more details.
@@ -500,6 +516,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb

@@ -474,6 +474,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -518,7 +534,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_received_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:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice}
           #   for more details.
@@ -580,6 +596,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb

@@ -475,6 +475,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -519,7 +535,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_received_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:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice}
           #   for more details.
@@ -581,6 +597,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice::Status]

data/lib/orb/resources/customers/credits.rb

@@ -75,6 +75,82 @@ module Orb
           )
         end
 
+        # This endpoint returns a customer's credit balance in a single currency or custom
+        # pricing unit: the total available balance, the balance waiting on payment, and
+        # the next upcoming expiration.
+        #
+        # `balance` is the sum of `balance` across the customer's `active` credit blocks,
+        # as listed by
+        # [Fetch customer credit balance](/api-reference/credit/fetch-customer-credit-balance).
+        # Expired, depleted, and voided blocks are not included. Blocks in
+        # `pending_payment` status are totaled in `pending_payment_balance` instead, and
+        # become available once their invoice is paid.
+        #
+        # Note that `currency` defaults to credits if not specified. To use a real world
+        # currency, set `currency` to an ISO 4217 string. A customer with no credits in
+        # that currency returns a balance of `0`.
+        #
+        # @overload fetch_balance(customer_id, currency: nil, request_options: {})
+        #
+        # @param customer_id [String]
+        #
+        # @param currency [String, nil] The ledger currency or custom pricing unit to use.
+        #
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::Customers::CreditFetchBalanceResponse]
+        #
+        # @see Orb::Models::Customers::CreditFetchBalanceParams
+        def fetch_balance(customer_id, params = {})
+          parsed, options = Orb::Customers::CreditFetchBalanceParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["customers/%1$s/credits/balance", customer_id],
+            query: query,
+            model: Orb::Models::Customers::CreditFetchBalanceResponse,
+            options: options
+          )
+        end
+
+        # This endpoint returns a customer's credit balance in a single currency or custom
+        # pricing unit: the total available balance, the balance waiting on payment, and
+        # the next upcoming expiration.
+        #
+        # `balance` is the sum of `balance` across the customer's `active` credit blocks,
+        # as listed by
+        # [Fetch customer credit balance](/api-reference/credit/fetch-customer-credit-balance).
+        # Expired, depleted, and voided blocks are not included. Blocks in
+        # `pending_payment` status are totaled in `pending_payment_balance` instead, and
+        # become available once their invoice is paid.
+        #
+        # Note that `currency` defaults to credits if not specified. To use a real world
+        # currency, set `currency` to an ISO 4217 string. A customer with no credits in
+        # that currency returns a balance of `0`.
+        #
+        # @overload fetch_balance_by_external_id(external_customer_id, currency: nil, request_options: {})
+        #
+        # @param external_customer_id [String]
+        #
+        # @param currency [String, nil] The ledger currency or custom pricing unit to use.
+        #
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::Customers::CreditFetchBalanceByExternalIDResponse]
+        #
+        # @see Orb::Models::Customers::CreditFetchBalanceByExternalIDParams
+        def fetch_balance_by_external_id(external_customer_id, params = {})
+          parsed, options = Orb::Customers::CreditFetchBalanceByExternalIDParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["customers/external_customer_id/%1$s/credits/balance", external_customer_id],
+            query: query,
+            model: Orb::Models::Customers::CreditFetchBalanceByExternalIDResponse,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Customers::CreditListByExternalIDParams} for more details.
         #

data/lib/orb/version.rb

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

data/lib/orb.rb

@@ -147,6 +147,10 @@ require_relative "orb/models/customers/cost_list_by_external_id_params"
 require_relative "orb/models/customers/cost_list_by_external_id_response"
 require_relative "orb/models/customers/cost_list_params"
 require_relative "orb/models/customers/cost_list_response"
+require_relative "orb/models/customers/credit_fetch_balance_by_external_id_params"
+require_relative "orb/models/customers/credit_fetch_balance_by_external_id_response"
+require_relative "orb/models/customers/credit_fetch_balance_params"
+require_relative "orb/models/customers/credit_fetch_balance_response"
 require_relative "orb/models/customers/credit_list_by_external_id_params"
 require_relative "orb/models/customers/credit_list_by_external_id_response"
 require_relative "orb/models/customers/credit_list_params"

data/rbi/orb/models/changed_subscription_resources.rbi

@@ -436,6 +436,18 @@ module Orb
         sig { returns(T.nilable(Time)) }
         attr_accessor :scheduled_issue_at
 
+        # The latest `end_date` of the invoice's line items, including any line items
+        # hidden because they have zero quantity. This is `null` when the invoice has no
+        # line items.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :service_period_end
+
+        # The earliest `start_date` of the invoice's line items, including any line items
+        # hidden because they have zero quantity. This is `null` when the invoice has no
+        # line items.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :service_period_start
+
         sig { returns(T.nilable(Orb::Address)) }
         attr_reader :shipping_address
 
@@ -543,6 +555,8 @@ module Orb
             payment_received_at: T.nilable(Time),
             payment_started_at: T.nilable(Time),
             scheduled_issue_at: T.nilable(Time),
+            service_period_end: T.nilable(Time),
+            service_period_start: T.nilable(Time),
             shipping_address: T.nilable(Orb::Address::OrHash),
             status:
               Orb::ChangedSubscriptionResources::CreatedInvoice::Status::OrSymbol,
@@ -792,6 +806,14 @@ module Orb
           # If the invoice is in draft, this timestamp will reflect when the invoice is
           # scheduled to be issued.
           scheduled_issue_at:,
+          # The latest `end_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          service_period_end:,
+          # The earliest `start_date` of the invoice's line items, including any line items
+          # hidden because they have zero quantity. This is `null` when the invoice has no
+          # line items.
+          service_period_start:,
           shipping_address:,
           status:,
           subscription:,
@@ -865,6 +887,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address),
               status:
                 Orb::ChangedSubscriptionResources::CreatedInvoice::Status::TaggedSymbol,

data/rbi/orb/models/customers/credit_fetch_balance_by_external_id_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class CreditFetchBalanceByExternalIDParams < Orb::Internal::Type::BaseModel
+        extend Orb::Internal::Type::RequestParameters::Converter
+        include Orb::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Customers::CreditFetchBalanceByExternalIDParams,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :external_customer_id
+
+        # The ledger currency or custom pricing unit to use.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :currency
+
+        sig do
+          params(
+            external_customer_id: String,
+            currency: T.nilable(String),
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          external_customer_id:,
+          # The ledger currency or custom pricing unit to use.
+          currency: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              external_customer_id: String,
+              currency: T.nilable(String),
+              request_options: Orb::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/customers/credit_fetch_balance_by_external_id_response.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class CreditFetchBalanceByExternalIDResponse < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Models::Customers::CreditFetchBalanceByExternalIDResponse,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # The customer's available credit balance: the sum of `balance` across their
+        # `active` credit blocks.
+        sig { returns(Float) }
+        attr_accessor :balance
+
+        # The currency or custom pricing unit the balances are denominated in. Null when
+        # no `currency` is passed and the customer has no credit ledger, in which case
+        # every balance is `0`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :currency
+
+        # The balance that expires on `next_expiry_date`. Null if `next_expiry_date` is
+        # null.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :next_expiry_balance
+
+        # The earliest `expiry_date` among active credit blocks. Null if none of them
+        # expire.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :next_expiry_date
+
+        # The total balance of credit blocks in `pending_payment` status. Not included in
+        # `balance` until the invoice that funds them is paid.
+        sig { returns(Float) }
+        attr_accessor :pending_payment_balance
+
+        sig do
+          params(
+            balance: Float,
+            currency: T.nilable(String),
+            next_expiry_balance: T.nilable(Float),
+            next_expiry_date: T.nilable(Time),
+            pending_payment_balance: Float
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The customer's available credit balance: the sum of `balance` across their
+          # `active` credit blocks.
+          balance:,
+          # The currency or custom pricing unit the balances are denominated in. Null when
+          # no `currency` is passed and the customer has no credit ledger, in which case
+          # every balance is `0`.
+          currency:,
+          # The balance that expires on `next_expiry_date`. Null if `next_expiry_date` is
+          # null.
+          next_expiry_balance:,
+          # The earliest `expiry_date` among active credit blocks. Null if none of them
+          # expire.
+          next_expiry_date:,
+          # The total balance of credit blocks in `pending_payment` status. Not included in
+          # `balance` until the invoice that funds them is paid.
+          pending_payment_balance:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              balance: Float,
+              currency: T.nilable(String),
+              next_expiry_balance: T.nilable(Float),
+              next_expiry_date: T.nilable(Time),
+              pending_payment_balance: Float
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/customers/credit_fetch_balance_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class CreditFetchBalanceParams < Orb::Internal::Type::BaseModel
+        extend Orb::Internal::Type::RequestParameters::Converter
+        include Orb::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Customers::CreditFetchBalanceParams,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        # The ledger currency or custom pricing unit to use.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :currency
+
+        sig do
+          params(
+            customer_id: String,
+            currency: T.nilable(String),
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          customer_id:,
+          # The ledger currency or custom pricing unit to use.
+          currency: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              customer_id: String,
+              currency: T.nilable(String),
+              request_options: Orb::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/customers/credit_fetch_balance_response.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class CreditFetchBalanceResponse < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Models::Customers::CreditFetchBalanceResponse,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # The customer's available credit balance: the sum of `balance` across their
+        # `active` credit blocks.
+        sig { returns(Float) }
+        attr_accessor :balance
+
+        # The currency or custom pricing unit the balances are denominated in. Null when
+        # no `currency` is passed and the customer has no credit ledger, in which case
+        # every balance is `0`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :currency
+
+        # The balance that expires on `next_expiry_date`. Null if `next_expiry_date` is
+        # null.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :next_expiry_balance
+
+        # The earliest `expiry_date` among active credit blocks. Null if none of them
+        # expire.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :next_expiry_date
+
+        # The total balance of credit blocks in `pending_payment` status. Not included in
+        # `balance` until the invoice that funds them is paid.
+        sig { returns(Float) }
+        attr_accessor :pending_payment_balance
+
+        sig do
+          params(
+            balance: Float,
+            currency: T.nilable(String),
+            next_expiry_balance: T.nilable(Float),
+            next_expiry_date: T.nilable(Time),
+            pending_payment_balance: Float
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The customer's available credit balance: the sum of `balance` across their
+          # `active` credit blocks.
+          balance:,
+          # The currency or custom pricing unit the balances are denominated in. Null when
+          # no `currency` is passed and the customer has no credit ledger, in which case
+          # every balance is `0`.
+          currency:,
+          # The balance that expires on `next_expiry_date`. Null if `next_expiry_date` is
+          # null.
+          next_expiry_balance:,
+          # The earliest `expiry_date` among active credit blocks. Null if none of them
+          # expire.
+          next_expiry_date:,
+          # The total balance of credit blocks in `pending_payment` status. Not included in
+          # `balance` until the invoice that funds them is paid.
+          pending_payment_balance:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              balance: Float,
+              currency: T.nilable(String),
+              next_expiry_balance: T.nilable(Float),
+              next_expiry_date: T.nilable(Time),
+              pending_payment_balance: Float
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/invoice.rbi

@@ -330,6 +330,18 @@ module Orb
       sig { returns(T.nilable(Time)) }
       attr_accessor :scheduled_issue_at
 
+      # The latest `end_date` of the invoice's line items, including any line items
+      # hidden because they have zero quantity. This is `null` when the invoice has no
+      # line items.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :service_period_end
+
+      # The earliest `start_date` of the invoice's line items, including any line items
+      # hidden because they have zero quantity. This is `null` when the invoice has no
+      # line items.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :service_period_start
+
       sig { returns(T.nilable(Orb::Address)) }
       attr_reader :shipping_address
 
@@ -422,6 +434,8 @@ module Orb
           payment_received_at: T.nilable(Time),
           payment_started_at: T.nilable(Time),
           scheduled_issue_at: T.nilable(Time),
+          service_period_end: T.nilable(Time),
+          service_period_start: T.nilable(Time),
           shipping_address: T.nilable(Orb::Address::OrHash),
           status: Orb::Invoice::Status::OrSymbol,
           subscription: T.nilable(Orb::SubscriptionMinified::OrHash),
@@ -668,6 +682,14 @@ module Orb
         # If the invoice is in draft, this timestamp will reflect when the invoice is
         # scheduled to be issued.
         scheduled_issue_at:,
+        # The latest `end_date` of the invoice's line items, including any line items
+        # hidden because they have zero quantity. This is `null` when the invoice has no
+        # line items.
+        service_period_end:,
+        # The earliest `start_date` of the invoice's line items, including any line items
+        # hidden because they have zero quantity. This is `null` when the invoice has no
+        # line items.
+        service_period_start:,
         shipping_address:,
         status:,
         subscription:,
@@ -727,6 +749,8 @@ module Orb
             payment_received_at: T.nilable(Time),
             payment_started_at: T.nilable(Time),
             scheduled_issue_at: T.nilable(Time),
+            service_period_end: T.nilable(Time),
+            service_period_start: T.nilable(Time),
             shipping_address: T.nilable(Orb::Address),
             status: Orb::Invoice::Status::TaggedSymbol,
             subscription: T.nilable(Orb::SubscriptionMinified),

data/rbi/orb/models/invoice_fetch_upcoming_response.rbi

@@ -355,6 +355,18 @@ module Orb
       sig { returns(T.nilable(Time)) }
       attr_accessor :scheduled_issue_at
 
+      # The latest `end_date` of the invoice's line items, including any line items
+      # hidden because they have zero quantity. This is `null` when the invoice has no
+      # line items.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :service_period_end
+
+      # The earliest `start_date` of the invoice's line items, including any line items
+      # hidden because they have zero quantity. This is `null` when the invoice has no
+      # line items.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :service_period_start
+
       sig { returns(T.nilable(Orb::Address)) }
       attr_reader :shipping_address
 
@@ -460,6 +472,8 @@ module Orb
           payment_received_at: T.nilable(Time),
           payment_started_at: T.nilable(Time),
           scheduled_issue_at: T.nilable(Time),
+          service_period_end: T.nilable(Time),
+          service_period_start: T.nilable(Time),
           shipping_address: T.nilable(Orb::Address::OrHash),
           status: Orb::Models::InvoiceFetchUpcomingResponse::Status::OrSymbol,
           subscription: T.nilable(Orb::SubscriptionMinified::OrHash),
@@ -705,6 +719,14 @@ module Orb
         # If the invoice is in draft, this timestamp will reflect when the invoice is
         # scheduled to be issued.
         scheduled_issue_at:,
+        # The latest `end_date` of the invoice's line items, including any line items
+        # hidden because they have zero quantity. This is `null` when the invoice has no
+        # line items.
+        service_period_end:,
+        # The earliest `start_date` of the invoice's line items, including any line items
+        # hidden because they have zero quantity. This is `null` when the invoice has no
+        # line items.
+        service_period_start:,
         shipping_address:,
         status:,
         subscription:,
@@ -774,6 +796,8 @@ module Orb
             payment_received_at: T.nilable(Time),
             payment_started_at: T.nilable(Time),
             scheduled_issue_at: T.nilable(Time),
+            service_period_end: T.nilable(Time),
+            service_period_start: T.nilable(Time),
             shipping_address: T.nilable(Orb::Address),
             status:
               Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol,