orb-billing 1.13.0 → 1.14.0

data/rbi/orb/models/customer_update_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::CustomerUpdateParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :customer_id
+
       sig { returns(T.nilable(Orb::NewAccountingSyncConfiguration)) }
       attr_reader :accounting_sync_configuration
 
@@ -47,8 +50,10 @@ module Orb
       sig { params(billing_address: T.nilable(Orb::AddressInput::OrHash)).void }
       attr_writer :billing_address
 
-      # An ISO 4217 currency string used for the customer's invoices and balance. If not
-      # set at creation time, will be set at subscription creation time.
+      # An ISO 4217 currency string used for the customer's invoices and balance. This
+      # can only be set if the customer does not already have a currency configured. If
+      # not set at creation or update time, it will be set at subscription creation
+      # time.
       sig { returns(T.nilable(String)) }
       attr_accessor :currency
 
@@ -306,6 +311,7 @@ module Orb
 
       sig do
         params(
+          customer_id: String,
           accounting_sync_configuration:
             T.nilable(Orb::NewAccountingSyncConfiguration::OrHash),
           additional_emails: T.nilable(T::Array[String]),
@@ -343,6 +349,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        customer_id:,
         accounting_sync_configuration: nil,
         # Additional email addresses for this customer. If populated, these email
         # addresses will be CC'd for customer communications. The total number of email
@@ -358,8 +365,10 @@ module Orb
         # will be inherited from the account-level setting.
         auto_issuance: nil,
         billing_address: nil,
-        # An ISO 4217 currency string used for the customer's invoices and balance. If not
-        # set at creation time, will be set at subscription creation time.
+        # An ISO 4217 currency string used for the customer's invoices and balance. This
+        # can only be set if the customer does not already have a currency configured. If
+        # not set at creation or update time, it will be set at subscription creation
+        # time.
         currency: nil,
         # A valid customer email, to be used for invoicing and notifications.
         email: nil,
@@ -548,6 +557,7 @@ module Orb
       sig do
         override.returns(
           {
+            customer_id: String,
             accounting_sync_configuration:
               T.nilable(Orb::NewAccountingSyncConfiguration),
             additional_emails: T.nilable(T::Array[String]),
@@ -664,6 +674,12 @@ module Orb
           end
           attr_accessor :provider_type
 
+          # The ID of a shared payment token granted by an agent to use as the default
+          # payment instrument for this customer. When set, auto-collection will use this
+          # token instead of the customer's default payment method.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :default_shared_payment_token
+
           # List of Stripe payment method types to exclude for this customer. Excluded
           # payment methods will not be available for the customer to select during payment,
           # and will not be used for auto-collection. If a customer's default payment method
@@ -679,12 +695,17 @@ module Orb
             params(
               provider_type:
                 Orb::CustomerUpdateParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
+              default_shared_payment_token: T.nilable(String),
               excluded_payment_method_types: T::Array[String]
             ).returns(T.attached_class)
           end
           def self.new(
             # The payment provider to configure.
             provider_type:,
+            # The ID of a shared payment token granted by an agent to use as the default
+            # payment instrument for this customer. When set, auto-collection will use this
+            # token instead of the customer's default payment method.
+            default_shared_payment_token: nil,
             # List of Stripe payment method types to exclude for this customer. Excluded
             # payment methods will not be available for the customer to select during payment,
             # and will not be used for auto-collection. If a customer's default payment method
@@ -699,6 +720,7 @@ module Orb
               {
                 provider_type:
                   Orb::CustomerUpdateParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
+                default_shared_payment_token: T.nilable(String),
                 excluded_payment_method_types: T::Array[String]
               }
             )
@@ -779,6 +801,11 @@ module Orb
             :netsuite,
             Orb::CustomerUpdateParams::PaymentProvider::TaggedSymbol
           )
+        NETSUITE_AMPERSAND =
+          T.let(
+            :netsuite_ampersand,
+            Orb::CustomerUpdateParams::PaymentProvider::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/orb/models/customers/balance_transaction_create_params.rbi

@@ -15,6 +15,9 @@ module Orb
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :customer_id
+
         sig { returns(String) }
         attr_accessor :amount
 
@@ -31,6 +34,7 @@ module Orb
 
         sig do
           params(
+            customer_id: String,
             amount: String,
             type:
               Orb::Customers::BalanceTransactionCreateParams::Type::OrSymbol,
@@ -39,6 +43,7 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
+          customer_id:,
           amount:,
           type:,
           # An optional description that can be specified around this entry.
@@ -50,6 +55,7 @@ module Orb
         sig do
           override.returns(
             {
+              customer_id: String,
               amount: String,
               type:
                 Orb::Customers::BalanceTransactionCreateParams::Type::OrSymbol,

data/rbi/orb/models/customers/balance_transaction_list_params.rbi

@@ -15,6 +15,9 @@ module Orb
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :customer_id
+
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
         # from the initial request.
         sig { returns(T.nilable(String)) }
@@ -41,6 +44,7 @@ module Orb
 
         sig do
           params(
+            customer_id: String,
             cursor: T.nilable(String),
             limit: Integer,
             operation_time_gt: T.nilable(Time),
@@ -51,6 +55,7 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
+          customer_id:,
           # Cursor for pagination. This can be populated by the `next_cursor` value returned
           # from the initial request.
           cursor: nil,
@@ -67,6 +72,7 @@ module Orb
         sig do
           override.returns(
             {
+              customer_id: String,
               cursor: T.nilable(String),
               limit: Integer,
               operation_time_gt: T.nilable(Time),

data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi

@@ -15,6 +15,9 @@ module Orb
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :external_customer_id
+
         # The currency or custom pricing unit to use.
         sig { returns(T.nilable(String)) }
         attr_accessor :currency
@@ -42,6 +45,7 @@ module Orb
 
         sig do
           params(
+            external_customer_id: String,
             currency: T.nilable(String),
             timeframe_end: T.nilable(Time),
             timeframe_start: T.nilable(Time),
@@ -53,6 +57,7 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
+          external_customer_id:,
           # The currency or custom pricing unit to use.
           currency: nil,
           # Costs returned are exclusive of `timeframe_end`.
@@ -71,6 +76,7 @@ module Orb
         sig do
           override.returns(
             {
+              external_customer_id: String,
               currency: T.nilable(String),
               timeframe_end: T.nilable(Time),
               timeframe_start: T.nilable(Time),

data/rbi/orb/models/customers/cost_list_params.rbi

@@ -12,6 +12,9 @@ module Orb
             T.any(Orb::Customers::CostListParams, Orb::Internal::AnyHash)
           end
 
+        sig { returns(String) }
+        attr_accessor :customer_id
+
         # The currency or custom pricing unit to use.
         sig { returns(T.nilable(String)) }
         attr_accessor :currency
@@ -35,6 +38,7 @@ module Orb
 
         sig do
           params(
+            customer_id: String,
             currency: T.nilable(String),
             timeframe_end: T.nilable(Time),
             timeframe_start: T.nilable(Time),
@@ -44,6 +48,7 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
+          customer_id:,
           # The currency or custom pricing unit to use.
           currency: nil,
           # Costs returned are exclusive of `timeframe_end`.
@@ -62,6 +67,7 @@ module Orb
         sig do
           override.returns(
             {
+              customer_id: String,
               currency: T.nilable(String),
               timeframe_end: T.nilable(Time),
               timeframe_start: T.nilable(Time),

data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi

@@ -15,6 +15,9 @@ module Orb
             )
           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
@@ -53,6 +56,7 @@ module Orb
 
         sig do
           params(
+            external_customer_id: String,
             currency: T.nilable(String),
             cursor: T.nilable(String),
             effective_date_gt: T.nilable(Time),
@@ -65,6 +69,7 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
+          external_customer_id:,
           # The ledger currency or custom pricing unit to use.
           currency: nil,
           # Cursor for pagination. This can be populated by the `next_cursor` value returned
@@ -86,6 +91,7 @@ module Orb
         sig do
           override.returns(
             {
+              external_customer_id: String,
               currency: T.nilable(String),
               cursor: T.nilable(String),
               effective_date_gt: T.nilable(Time),

data/rbi/orb/models/customers/credit_list_params.rbi

@@ -12,6 +12,9 @@ module Orb
             T.any(Orb::Customers::CreditListParams, 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
@@ -50,6 +53,7 @@ module Orb
 
         sig do
           params(
+            customer_id: String,
             currency: T.nilable(String),
             cursor: T.nilable(String),
             effective_date_gt: T.nilable(Time),
@@ -62,6 +66,7 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
+          customer_id:,
           # The ledger currency or custom pricing unit to use.
           currency: nil,
           # Cursor for pagination. This can be populated by the `next_cursor` value returned
@@ -83,6 +88,7 @@ module Orb
         sig do
           override.returns(
             {
+              customer_id: String,
               currency: T.nilable(String),
               cursor: T.nilable(String),
               effective_date_gt: T.nilable(Time),

data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi

@@ -74,6 +74,8 @@ module Orb
           sig { returns(Float) }
           attr_accessor :starting_balance
 
+          # This field is deprecated and will always be null. Decrements are not associated
+          # with individual events.
           sig { returns(T.nilable(String)) }
           attr_accessor :event_id
 
@@ -123,6 +125,8 @@ module Orb
             # `null`.
             metadata:,
             starting_balance:,
+            # This field is deprecated and will always be null. Decrements are not associated
+            # with individual events.
             event_id: nil,
             invoice_id: nil,
             price_id: nil