dodopayments 1.52.4 → 1.53.2

data/lib/dodopayments/models/subscription.rb

@@ -46,6 +46,12 @@ module Dodopayments
       #   @return [Hash{Symbol=>String}]
       required :metadata, Dodopayments::Internal::Type::HashOf[String]
 
+      # @!attribute meters
+      #   Meters associated with this subscription (for usage-based billing)
+      #
+      #   @return [Array<Dodopayments::Models::Subscription::Meter>]
+      required :meters, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Subscription::Meter] }
+
       # @!attribute next_billing_date
       #   Timestamp of the next scheduled billing. Indicates the end of current billing
       #   period
@@ -156,7 +162,7 @@ module Dodopayments
       #   @return [Time, nil]
       optional :expires_at, Time, nil?: true
 
-      # @!method initialize(addons:, billing:, cancel_at_next_billing_date:, created_at:, currency:, customer:, metadata:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, discount_cycles_remaining: nil, discount_id: nil, expires_at: nil)
+      # @!method initialize(addons:, billing:, cancel_at_next_billing_date:, created_at:, currency:, customer:, metadata:, meters:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, discount_cycles_remaining: nil, discount_id: nil, expires_at: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Subscription} for more details.
       #
@@ -176,6 +182,8 @@ module Dodopayments
       #
       #   @param metadata [Hash{Symbol=>String}] Additional custom data associated with the subscription
       #
+      #   @param meters [Array<Dodopayments::Models::Subscription::Meter>] Meters associated with this subscription (for usage-based billing)
+      #
       #   @param next_billing_date [Time] Timestamp of the next scheduled billing. Indicates the end of current billing pe
       #
       #   @param on_demand [Boolean] Wether the subscription is on-demand or not
@@ -211,6 +219,54 @@ module Dodopayments
       #   @param discount_id [String, nil] The discount id if discount is applied
       #
       #   @param expires_at [Time, nil] Timestamp when the subscription will expire
+
+      class Meter < Dodopayments::Internal::Type::BaseModel
+        # @!attribute currency
+        #
+        #   @return [Symbol, Dodopayments::Models::Currency]
+        required :currency, enum: -> { Dodopayments::Currency }
+
+        # @!attribute free_threshold
+        #
+        #   @return [Integer]
+        required :free_threshold, Integer
+
+        # @!attribute measurement_unit
+        #
+        #   @return [String]
+        required :measurement_unit, String
+
+        # @!attribute meter_id
+        #
+        #   @return [String]
+        required :meter_id, String
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute price_per_unit
+        #
+        #   @return [String]
+        required :price_per_unit, String
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!method initialize(currency:, free_threshold:, measurement_unit:, meter_id:, name:, price_per_unit:, description: nil)
+        #   Response struct representing usage-based meter cart details for a subscription
+        #
+        #   @param currency [Symbol, Dodopayments::Models::Currency]
+        #   @param free_threshold [Integer]
+        #   @param measurement_unit [String]
+        #   @param meter_id [String]
+        #   @param name [String]
+        #   @param price_per_unit [String]
+        #   @param description [String, nil]
+      end
     end
   end
 end

data/lib/dodopayments/models/subscription_charge_params.rb

@@ -22,6 +22,14 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :adaptive_currency_fees_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
+      # @!attribute customer_balance_config
+      #   Specify how customer balance is used for the payment
+      #
+      #   @return [Dodopayments::Models::SubscriptionChargeParams::CustomerBalanceConfig, nil]
+      optional :customer_balance_config,
+               -> { Dodopayments::SubscriptionChargeParams::CustomerBalanceConfig },
+               nil?: true
+
       # @!attribute metadata
       #   Metadata for the payment. If not passed, the metadata of the subscription will
       #   be taken
@@ -43,7 +51,7 @@ module Dodopayments
       #   @return [String, nil]
       optional :product_description, String, nil?: true
 
-      # @!method initialize(product_price:, adaptive_currency_fees_inclusive: nil, metadata: nil, product_currency: nil, product_description: nil, request_options: {})
+      # @!method initialize(product_price:, adaptive_currency_fees_inclusive: nil, customer_balance_config: nil, metadata: nil, product_currency: nil, product_description: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionChargeParams} for more details.
       #
@@ -51,6 +59,8 @@ module Dodopayments
       #
       #   @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the product_price (true) or
       #
+      #   @param customer_balance_config [Dodopayments::Models::SubscriptionChargeParams::CustomerBalanceConfig, nil] Specify how customer balance is used for the payment
+      #
       #   @param metadata [Hash{Symbol=>String}, nil] Metadata for the payment. If not passed, the metadata of the subscription will b
       #
       #   @param product_currency [Symbol, Dodopayments::Models::Currency, nil] Optional currency of the product price. If not specified, defaults to the curren
@@ -58,6 +68,27 @@ module Dodopayments
       #   @param product_description [String, nil] Optional product description override for billing and line items.
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      class CustomerBalanceConfig < Dodopayments::Internal::Type::BaseModel
+        # @!attribute allow_customer_credits_purchase
+        #   Allows Customer Credit to be purchased to settle payments
+        #
+        #   @return [Boolean, nil]
+        optional :allow_customer_credits_purchase, Dodopayments::Internal::Type::Boolean, nil?: true
+
+        # @!attribute allow_customer_credits_usage
+        #   Allows Customer Credit Balance to be used to settle payments
+        #
+        #   @return [Boolean, nil]
+        optional :allow_customer_credits_usage, Dodopayments::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(allow_customer_credits_purchase: nil, allow_customer_credits_usage: nil)
+        #   Specify how customer balance is used for the payment
+        #
+        #   @param allow_customer_credits_purchase [Boolean, nil] Allows Customer Credit to be purchased to settle payments
+        #
+        #   @param allow_customer_credits_usage [Boolean, nil] Allows Customer Credit Balance to be used to settle payments
+      end
     end
   end
 end

data/lib/dodopayments/resources/customers/wallets/ledger_entries.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Customers
+      class Wallets
+        class LedgerEntries
+          # @overload create(customer_id, amount:, currency:, entry_type:, idempotency_key: nil, reason: nil, request_options: {})
+          #
+          # @param customer_id [String] Customer ID
+          #
+          # @param amount [Integer]
+          #
+          # @param currency [Symbol, Dodopayments::Models::Currency] Currency of the wallet to adjust
+          #
+          # @param entry_type [Symbol, Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams::EntryType] Type of ledger entry - credit or debit
+          #
+          # @param idempotency_key [String, nil] Optional idempotency key to prevent duplicate entries
+          #
+          # @param reason [String, nil]
+          #
+          # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Dodopayments::Models::Customers::CustomerWallet]
+          #
+          # @see Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams
+          def create(customer_id, params)
+            parsed, options = Dodopayments::Customers::Wallets::LedgerEntryCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["customers/%1$s/wallets/ledger-entries", customer_id],
+              body: parsed,
+              model: Dodopayments::Customers::CustomerWallet,
+              options: options
+            )
+          end
+
+          # @overload list(customer_id, currency: nil, page_number: nil, page_size: nil, request_options: {})
+          #
+          # @param customer_id [String] Customer ID
+          #
+          # @param currency [Symbol, Dodopayments::Models::Currency] Optional currency filter
+          #
+          # @param page_number [Integer]
+          #
+          # @param page_size [Integer]
+          #
+          # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction>]
+          #
+          # @see Dodopayments::Models::Customers::Wallets::LedgerEntryListParams
+          def list(customer_id, params = {})
+            parsed, options = Dodopayments::Customers::Wallets::LedgerEntryListParams.dump_request(params)
+            @client.request(
+              method: :get,
+              path: ["customers/%1$s/wallets/ledger-entries", customer_id],
+              query: parsed,
+              page: Dodopayments::Internal::DefaultPageNumberPagination,
+              model: Dodopayments::Customers::Wallets::CustomerWalletTransaction,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Dodopayments::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/customers/wallets.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Customers
+      class Wallets
+        # @return [Dodopayments::Resources::Customers::Wallets::LedgerEntries]
+        attr_reader :ledger_entries
+
+        # @overload list(customer_id, request_options: {})
+        #
+        # @param customer_id [String] Customer ID
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dodopayments::Models::Customers::WalletListResponse]
+        #
+        # @see Dodopayments::Models::Customers::WalletListParams
+        def list(customer_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["customers/%1$s/wallets", customer_id],
+            model: Dodopayments::Models::Customers::WalletListResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Dodopayments::Client]
+        def initialize(client:)
+          @client = client
+          @ledger_entries = Dodopayments::Resources::Customers::Wallets::LedgerEntries.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/customers.rb

@@ -6,6 +6,9 @@ module Dodopayments
       # @return [Dodopayments::Resources::Customers::CustomerPortal]
       attr_reader :customer_portal
 
+      # @return [Dodopayments::Resources::Customers::Wallets]
+      attr_reader :wallets
+
       # @overload create(email:, name:, phone_number: nil, request_options: {})
       #
       # @param email [String]
@@ -100,6 +103,7 @@ module Dodopayments
       def initialize(client:)
         @client = client
         @customer_portal = Dodopayments::Resources::Customers::CustomerPortal.new(client: client)
+        @wallets = Dodopayments::Resources::Customers::Wallets.new(client: client)
       end
     end
   end

data/lib/dodopayments/resources/licenses.rb

@@ -9,7 +9,7 @@ module Dodopayments
       # @param name [String]
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Dodopayments::Models::LicenseKeyInstance]
+      # @return [Dodopayments::Models::LicenseActivateResponse]
       #
       # @see Dodopayments::Models::LicenseActivateParams
       def activate(params)
@@ -18,7 +18,7 @@ module Dodopayments
           method: :post,
           path: "licenses/activate",
           body: parsed,
-          model: Dodopayments::LicenseKeyInstance,
+          model: Dodopayments::Models::LicenseActivateResponse,
           options: options
         )
       end

data/lib/dodopayments/resources/refunds.rb

@@ -61,7 +61,7 @@ module Dodopayments
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Refund>]
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::RefundListResponse>]
       #
       # @see Dodopayments::Models::RefundListParams
       def list(params = {})
@@ -71,7 +71,7 @@ module Dodopayments
           path: "refunds",
           query: parsed,
           page: Dodopayments::Internal::DefaultPageNumberPagination,
-          model: Dodopayments::Refund,
+          model: Dodopayments::Models::RefundListResponse,
           options: options
         )
       end

data/lib/dodopayments/resources/subscriptions.rb

@@ -173,7 +173,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionChargeParams} for more details.
       #
-      # @overload charge(subscription_id, product_price:, adaptive_currency_fees_inclusive: nil, metadata: nil, product_currency: nil, product_description: nil, request_options: {})
+      # @overload charge(subscription_id, product_price:, adaptive_currency_fees_inclusive: nil, customer_balance_config: nil, metadata: nil, product_currency: nil, product_description: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -181,6 +181,8 @@ module Dodopayments
       #
       # @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the product_price (true) or
       #
+      # @param customer_balance_config [Dodopayments::Models::SubscriptionChargeParams::CustomerBalanceConfig, nil] Specify how customer balance is used for the payment
+      #
       # @param metadata [Hash{Symbol=>String}, nil] Metadata for the payment. If not passed, the metadata of the subscription will b
       #
       # @param product_currency [Symbol, Dodopayments::Models::Currency, nil] Optional currency of the product price. If not specified, defaults to the curren

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "1.52.4"
+  VERSION = "1.53.2"
 end

data/lib/dodopayments.rb

@@ -91,6 +91,12 @@ require_relative "dodopayments/models/customer_portal_session"
 require_relative "dodopayments/models/customer_request"
 require_relative "dodopayments/models/customer_retrieve_params"
 require_relative "dodopayments/models/customers/customer_portal_create_params"
+require_relative "dodopayments/models/customers/customer_wallet"
+require_relative "dodopayments/models/customers/wallet_list_params"
+require_relative "dodopayments/models/customers/wallet_list_response"
+require_relative "dodopayments/models/customers/wallets/customer_wallet_transaction"
+require_relative "dodopayments/models/customers/wallets/ledger_entry_create_params"
+require_relative "dodopayments/models/customers/wallets/ledger_entry_list_params"
 require_relative "dodopayments/models/customer_update_params"
 require_relative "dodopayments/models/discount"
 require_relative "dodopayments/models/discount_create_params"
@@ -111,6 +117,7 @@ require_relative "dodopayments/models/intent_status"
 require_relative "dodopayments/models/invoices/payment_retrieve_params"
 require_relative "dodopayments/models/invoices/payment_retrieve_refund_params"
 require_relative "dodopayments/models/license_activate_params"
+require_relative "dodopayments/models/license_activate_response"
 require_relative "dodopayments/models/license_deactivate_params"
 require_relative "dodopayments/models/license_key_duration"
 require_relative "dodopayments/models/license_key_instance"
@@ -161,6 +168,7 @@ require_relative "dodopayments/models/product_update_files_response"
 require_relative "dodopayments/models/product_update_params"
 require_relative "dodopayments/models/refund_create_params"
 require_relative "dodopayments/models/refund_list_params"
+require_relative "dodopayments/models/refund_list_response"
 require_relative "dodopayments/models/refund_retrieve_params"
 require_relative "dodopayments/models/refund_status"
 require_relative "dodopayments/models/subscription_change_plan_params"
@@ -200,6 +208,8 @@ require_relative "dodopayments/resources/brands"
 require_relative "dodopayments/resources/checkout_sessions"
 require_relative "dodopayments/resources/customers"
 require_relative "dodopayments/resources/customers/customer_portal"
+require_relative "dodopayments/resources/customers/wallets"
+require_relative "dodopayments/resources/customers/wallets/ledger_entries"
 require_relative "dodopayments/resources/discounts"
 require_relative "dodopayments/resources/disputes"
 require_relative "dodopayments/resources/invoices"

data/rbi/dodopayments/models/customers/customer_wallet.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    CustomerWallet = Customers::CustomerWallet
+
+    module Customers
+      class CustomerWallet < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Customers::CustomerWallet,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :balance
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(Dodopayments::Currency::TaggedSymbol) }
+        attr_accessor :currency
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        sig do
+          params(
+            balance: Integer,
+            created_at: Time,
+            currency: Dodopayments::Currency::OrSymbol,
+            customer_id: String,
+            updated_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          balance:,
+          created_at:,
+          currency:,
+          customer_id:,
+          updated_at:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              balance: Integer,
+              created_at: Time,
+              currency: Dodopayments::Currency::TaggedSymbol,
+              customer_id: String,
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customers/wallet_list_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Customers
+      class WalletListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Customers::WalletListParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Dodopayments::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig do
+          override.returns({ request_options: Dodopayments::RequestOptions })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customers/wallet_list_response.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Customers
+      class WalletListResponse < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Models::Customers::WalletListResponse,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Array[Dodopayments::Customers::CustomerWallet]) }
+        attr_accessor :items
+
+        # Sum of all wallet balances converted to USD (in smallest unit)
+        sig { returns(Integer) }
+        attr_accessor :total_balance_usd
+
+        sig do
+          params(
+            items: T::Array[Dodopayments::Customers::CustomerWallet::OrHash],
+            total_balance_usd: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          items:,
+          # Sum of all wallet balances converted to USD (in smallest unit)
+          total_balance_usd:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              items: T::Array[Dodopayments::Customers::CustomerWallet],
+              total_balance_usd: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end