orb-billing 1.48.0 → 1.50.0

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,

data/rbi/orb/models/invoice_issue_summary_response.rbi

@@ -319,6 +319,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
 
@@ -400,6 +412,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::InvoiceIssueSummaryResponse::Status::OrSymbol,
           subscription: T.nilable(Orb::SubscriptionMinified::OrHash),
@@ -629,6 +643,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:,
@@ -686,6 +708,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::InvoiceIssueSummaryResponse::Status::TaggedSymbol,

data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi

@@ -422,6 +422,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
 
@@ -507,6 +519,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::InvoiceIssuedSummaryWebhookEvent::Invoice::Status::OrSymbol,
@@ -737,6 +751,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:,
@@ -796,6 +818,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::InvoiceIssuedSummaryWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/invoice_list_summary_response.rbi

@@ -316,6 +316,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
 
@@ -397,6 +409,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::InvoiceListSummaryResponse::Status::OrSymbol,
           subscription: T.nilable(Orb::SubscriptionMinified::OrHash),
@@ -626,6 +640,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:,
@@ -681,6 +703,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::InvoiceListSummaryResponse::Status::TaggedSymbol,