orb-billing 1.13.0 → 1.14.0

data/rbi/orb/models/beta_fetch_plan_version_params.rbi

@@ -14,18 +14,26 @@ module Orb
       sig { returns(String) }
       attr_accessor :plan_id
 
+      sig { returns(String) }
+      attr_accessor :version
+
       sig do
         params(
           plan_id: String,
+          version: String,
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(plan_id:, request_options: {})
+      def self.new(plan_id:, version:, request_options: {})
       end
 
       sig do
         override.returns(
-          { plan_id: String, request_options: Orb::RequestOptions }
+          {
+            plan_id: String,
+            version: String,
+            request_options: Orb::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/orb/models/beta_set_default_plan_version_params.rbi

@@ -11,17 +11,22 @@ module Orb
           T.any(Orb::BetaSetDefaultPlanVersionParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :plan_id
+
       # Plan version to set as the default.
       sig { returns(Integer) }
       attr_accessor :version
 
       sig do
         params(
+          plan_id: String,
           version: Integer,
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        plan_id:,
         # Plan version to set as the default.
         version:,
         request_options: {}
@@ -30,7 +35,11 @@ module Orb
 
       sig do
         override.returns(
-          { version: Integer, request_options: Orb::RequestOptions }
+          {
+            plan_id: String,
+            version: Integer,
+            request_options: Orb::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/orb/models/coupon_archive_params.rbi

@@ -9,15 +9,23 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::CouponArchiveParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :coupon_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          coupon_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(coupon_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { coupon_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/coupon_fetch_params.rbi

@@ -9,15 +9,23 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::CouponFetchParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :coupon_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          coupon_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(coupon_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { coupon_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/coupons/subscription_list_params.rbi

@@ -12,6 +12,9 @@ module Orb
             T.any(Orb::Coupons::SubscriptionListParams, Orb::Internal::AnyHash)
           end
 
+        sig { returns(String) }
+        attr_accessor :coupon_id
+
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
         # from the initial request.
         sig { returns(T.nilable(String)) }
@@ -26,12 +29,14 @@ module Orb
 
         sig do
           params(
+            coupon_id: String,
             cursor: T.nilable(String),
             limit: Integer,
             request_options: Orb::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          coupon_id:,
           # Cursor for pagination. This can be populated by the `next_cursor` value returned
           # from the initial request.
           cursor: nil,
@@ -44,6 +49,7 @@ module Orb
         sig do
           override.returns(
             {
+              coupon_id: String,
               cursor: T.nilable(String),
               limit: Integer,
               request_options: Orb::RequestOptions

data/rbi/orb/models/credit_block_delete_params.rbi

@@ -11,15 +11,23 @@ module Orb
           T.any(Orb::CreditBlockDeleteParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :block_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          block_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(block_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { block_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/credit_block_list_invoices_params.rbi

@@ -11,15 +11,23 @@ module Orb
           T.any(Orb::CreditBlockListInvoicesParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :block_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          block_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(block_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { block_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/credit_block_retrieve_params.rbi

@@ -11,15 +11,23 @@ module Orb
           T.any(Orb::CreditBlockRetrieveParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :block_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          block_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(block_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { block_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/credit_note_fetch_params.rbi

@@ -11,15 +11,23 @@ module Orb
           T.any(Orb::CreditNoteFetchParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :credit_note_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          credit_note_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(credit_note_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { credit_note_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/customer.rbi

@@ -636,6 +636,11 @@ module Orb
           T.let(:stripe_invoice, Orb::Customer::PaymentProvider::TaggedSymbol)
         NETSUITE =
           T.let(:netsuite, Orb::Customer::PaymentProvider::TaggedSymbol)
+        NETSUITE_AMPERSAND =
+          T.let(
+            :netsuite_ampersand,
+            Orb::Customer::PaymentProvider::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -756,6 +761,11 @@ module Orb
                 :netsuite,
                 Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol
               )
+            NETSUITE_AMPERSAND =
+              T.let(
+                :netsuite_ampersand,
+                Orb::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -840,6 +850,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
@@ -855,12 +871,17 @@ module Orb
             params(
               provider_type:
                 Orb::Customer::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
@@ -875,6 +896,7 @@ module Orb
               {
                 provider_type:
                   Orb::Customer::PaymentConfiguration::PaymentProvider::ProviderType::TaggedSymbol,
+                default_shared_payment_token: T.nilable(String),
                 excluded_payment_method_types: T::Array[String]
               }
             )

data/rbi/orb/models/customer_create_params.rbi

@@ -668,6 +668,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
@@ -683,12 +689,17 @@ module Orb
             params(
               provider_type:
                 Orb::CustomerCreateParams::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
@@ -703,6 +714,7 @@ module Orb
               {
                 provider_type:
                   Orb::CustomerCreateParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
+                default_shared_payment_token: T.nilable(String),
                 excluded_payment_method_types: T::Array[String]
               }
             )
@@ -779,6 +791,11 @@ module Orb
             :netsuite,
             Orb::CustomerCreateParams::PaymentProvider::TaggedSymbol
           )
+        NETSUITE_AMPERSAND =
+          T.let(
+            :netsuite_ampersand,
+            Orb::CustomerCreateParams::PaymentProvider::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/orb/models/customer_delete_params.rbi

@@ -11,15 +11,23 @@ module Orb
           T.any(Orb::CustomerDeleteParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :customer_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          customer_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(customer_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { customer_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/customer_fetch_by_external_id_params.rbi

@@ -11,15 +11,23 @@ module Orb
           T.any(Orb::CustomerFetchByExternalIDParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :external_customer_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          external_customer_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(external_customer_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { external_customer_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/customer_fetch_params.rbi

@@ -9,15 +9,23 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::CustomerFetchParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :customer_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          customer_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(customer_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { customer_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi

@@ -14,15 +14,23 @@ module Orb
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :external_customer_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          external_customer_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(external_customer_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { external_customer_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi

@@ -14,15 +14,23 @@ module Orb
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :customer_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          customer_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(customer_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { customer_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/customer_update_by_external_id_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::CustomerUpdateByExternalIDParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :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
 
@@ -314,6 +319,7 @@ module Orb
 
       sig do
         params(
+          id: String,
           accounting_sync_configuration:
             T.nilable(Orb::NewAccountingSyncConfiguration::OrHash),
           additional_emails: T.nilable(T::Array[String]),
@@ -355,6 +361,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        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
@@ -370,8 +377,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,
@@ -560,6 +569,7 @@ module Orb
       sig do
         override.returns(
           {
+            id: String,
             accounting_sync_configuration:
               T.nilable(Orb::NewAccountingSyncConfiguration),
             additional_emails: T.nilable(T::Array[String]),
@@ -680,6 +690,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
@@ -695,12 +711,17 @@ module Orb
             params(
               provider_type:
                 Orb::CustomerUpdateByExternalIDParams::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
@@ -715,6 +736,7 @@ module Orb
               {
                 provider_type:
                   Orb::CustomerUpdateByExternalIDParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
+                default_shared_payment_token: T.nilable(String),
                 excluded_payment_method_types: T::Array[String]
               }
             )
@@ -798,6 +820,11 @@ module Orb
             :netsuite,
             Orb::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol
           )
+        NETSUITE_AMPERSAND =
+          T.let(
+            :netsuite_ampersand,
+            Orb::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol
+          )
 
         sig do
           override.returns(