dodopayments 1.51.1 → 1.52.5

data/rbi/dodopayments/models/meter_list_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class MeterListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Dodopayments::MeterListParams, Dodopayments::Internal::AnyHash)
+        end
+
+      # List archived meters
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :archived
+
+      sig { params(archived: T::Boolean).void }
+      attr_writer :archived
+
+      # Page number default is 0
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Page size default is 10 max is 100
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      sig do
+        params(
+          archived: T::Boolean,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # List archived meters
+        archived: nil,
+        # Page number default is 0
+        page_number: nil,
+        # Page size default is 10 max is 100
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            archived: T::Boolean,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/{product_delete_params.rbi → meter_retrieve_params.rbi}

@@ -2,14 +2,14 @@
 
 module Dodopayments
   module Models
-    class ProductDeleteParams < Dodopayments::Internal::Type::BaseModel
+    class MeterRetrieveParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Dodopayments::ProductDeleteParams,
+            Dodopayments::MeterRetrieveParams,
             Dodopayments::Internal::AnyHash
           )
         end

data/rbi/dodopayments/models/meter_unarchive_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class MeterUnarchiveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::MeterUnarchiveParams,
+            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

data/rbi/dodopayments/models/payment.rbi

@@ -93,6 +93,11 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :card_type
 
+      # If payment is made using a checkout session, this field is set to the id of the
+      # session.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :checkout_session_id
+
       # The discount id if discount is applied
       sig { returns(T.nilable(String)) }
       attr_accessor :discount_id
@@ -163,6 +168,7 @@ module Dodopayments
           card_last_four: T.nilable(String),
           card_network: T.nilable(String),
           card_type: T.nilable(String),
+          checkout_session_id: T.nilable(String),
           discount_id: T.nilable(String),
           error_code: T.nilable(String),
           error_message: T.nilable(String),
@@ -220,6 +226,9 @@ module Dodopayments
         card_network: nil,
         # The type of card DEBIT or CREDIT
         card_type: nil,
+        # If payment is made using a checkout session, this field is set to the id of the
+        # session.
+        checkout_session_id: nil,
         # The discount id if discount is applied
         discount_id: nil,
         # An error code if the payment failed
@@ -271,6 +280,7 @@ module Dodopayments
             card_last_four: T.nilable(String),
             card_network: T.nilable(String),
             card_type: T.nilable(String),
+            checkout_session_id: T.nilable(String),
             discount_id: T.nilable(String),
             error_code: T.nilable(String),
             error_message: T.nilable(String),

data/rbi/dodopayments/models/price.rbi

@@ -10,7 +10,8 @@ module Dodopayments
         T.type_alias do
           T.any(
             Dodopayments::Price::OneTimePrice,
-            Dodopayments::Price::RecurringPrice
+            Dodopayments::Price::RecurringPrice,
+            Dodopayments::Price::UsageBasedPrice
           )
         end
 
@@ -28,7 +29,7 @@ module Dodopayments
         attr_accessor :currency
 
         # Discount applied to the price, represented as a percentage (0 to 100).
-        sig { returns(Float) }
+        sig { returns(Integer) }
         attr_accessor :discount
 
         # The payment amount, in the smallest denomination of the currency (e.g., cents
@@ -69,7 +70,7 @@ module Dodopayments
         sig do
           params(
             currency: Dodopayments::Currency::OrSymbol,
-            discount: Float,
+            discount: Integer,
             price: Integer,
             purchasing_power_parity: T::Boolean,
             type: Dodopayments::Price::OneTimePrice::Type::OrSymbol,
@@ -109,7 +110,7 @@ module Dodopayments
           override.returns(
             {
               currency: Dodopayments::Currency::OrSymbol,
-              discount: Float,
+              discount: Integer,
               price: Integer,
               purchasing_power_parity: T::Boolean,
               type: Dodopayments::Price::OneTimePrice::Type::OrSymbol,
@@ -161,7 +162,7 @@ module Dodopayments
         attr_accessor :currency
 
         # Discount applied to the price, represented as a percentage (0 to 100).
-        sig { returns(Float) }
+        sig { returns(Integer) }
         attr_accessor :discount
 
         # Number of units for the payment frequency. For example, a value of `1` with a
@@ -210,7 +211,7 @@ module Dodopayments
         sig do
           params(
             currency: Dodopayments::Currency::OrSymbol,
-            discount: Float,
+            discount: Integer,
             payment_frequency_count: Integer,
             payment_frequency_interval: Dodopayments::TimeInterval::OrSymbol,
             price: Integer,
@@ -255,7 +256,7 @@ module Dodopayments
           override.returns(
             {
               currency: Dodopayments::Currency::OrSymbol,
-              discount: Float,
+              discount: Integer,
               payment_frequency_count: Integer,
               payment_frequency_interval: Dodopayments::TimeInterval::OrSymbol,
               price: Integer,
@@ -297,6 +298,151 @@ module Dodopayments
         end
       end
 
+      class UsageBasedPrice < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Price::UsageBasedPrice,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The currency in which the payment is made.
+        sig { returns(Dodopayments::Currency::OrSymbol) }
+        attr_accessor :currency
+
+        # Discount applied to the price, represented as a percentage (0 to 100).
+        sig { returns(Integer) }
+        attr_accessor :discount
+
+        # The fixed payment amount. Represented in the lowest denomination of the currency
+        # (e.g., cents for USD). For example, to charge $1.00, pass `100`.
+        sig { returns(Integer) }
+        attr_accessor :fixed_price
+
+        # Number of units for the payment frequency. For example, a value of `1` with a
+        # `payment_frequency_interval` of `month` represents monthly payments.
+        sig { returns(Integer) }
+        attr_accessor :payment_frequency_count
+
+        # The time interval for the payment frequency (e.g., day, month, year).
+        sig { returns(Dodopayments::TimeInterval::OrSymbol) }
+        attr_accessor :payment_frequency_interval
+
+        # Indicates if purchasing power parity adjustments are applied to the price.
+        # Purchasing power parity feature is not available as of now
+        sig { returns(T::Boolean) }
+        attr_accessor :purchasing_power_parity
+
+        # Number of units for the subscription period. For example, a value of `12` with a
+        # `subscription_period_interval` of `month` represents a one-year subscription.
+        sig { returns(Integer) }
+        attr_accessor :subscription_period_count
+
+        # The time interval for the subscription period (e.g., day, month, year).
+        sig { returns(Dodopayments::TimeInterval::OrSymbol) }
+        attr_accessor :subscription_period_interval
+
+        sig { returns(Dodopayments::Price::UsageBasedPrice::Type::OrSymbol) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(T::Array[Dodopayments::AddMeterToPrice])) }
+        attr_accessor :meters
+
+        # Indicates if the price is tax inclusive
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :tax_inclusive
+
+        # Usage Based price details.
+        sig do
+          params(
+            currency: Dodopayments::Currency::OrSymbol,
+            discount: Integer,
+            fixed_price: Integer,
+            payment_frequency_count: Integer,
+            payment_frequency_interval: Dodopayments::TimeInterval::OrSymbol,
+            purchasing_power_parity: T::Boolean,
+            subscription_period_count: Integer,
+            subscription_period_interval: Dodopayments::TimeInterval::OrSymbol,
+            type: Dodopayments::Price::UsageBasedPrice::Type::OrSymbol,
+            meters: T.nilable(T::Array[Dodopayments::AddMeterToPrice::OrHash]),
+            tax_inclusive: T.nilable(T::Boolean)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The currency in which the payment is made.
+          currency:,
+          # Discount applied to the price, represented as a percentage (0 to 100).
+          discount:,
+          # The fixed payment amount. Represented in the lowest denomination of the currency
+          # (e.g., cents for USD). For example, to charge $1.00, pass `100`.
+          fixed_price:,
+          # Number of units for the payment frequency. For example, a value of `1` with a
+          # `payment_frequency_interval` of `month` represents monthly payments.
+          payment_frequency_count:,
+          # The time interval for the payment frequency (e.g., day, month, year).
+          payment_frequency_interval:,
+          # Indicates if purchasing power parity adjustments are applied to the price.
+          # Purchasing power parity feature is not available as of now
+          purchasing_power_parity:,
+          # Number of units for the subscription period. For example, a value of `12` with a
+          # `subscription_period_interval` of `month` represents a one-year subscription.
+          subscription_period_count:,
+          # The time interval for the subscription period (e.g., day, month, year).
+          subscription_period_interval:,
+          type:,
+          meters: nil,
+          # Indicates if the price is tax inclusive
+          tax_inclusive: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              currency: Dodopayments::Currency::OrSymbol,
+              discount: Integer,
+              fixed_price: Integer,
+              payment_frequency_count: Integer,
+              payment_frequency_interval: Dodopayments::TimeInterval::OrSymbol,
+              purchasing_power_parity: T::Boolean,
+              subscription_period_count: Integer,
+              subscription_period_interval:
+                Dodopayments::TimeInterval::OrSymbol,
+              type: Dodopayments::Price::UsageBasedPrice::Type::OrSymbol,
+              meters: T.nilable(T::Array[Dodopayments::AddMeterToPrice]),
+              tax_inclusive: T.nilable(T::Boolean)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Dodopayments::Price::UsageBasedPrice::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          USAGE_BASED_PRICE =
+            T.let(
+              :usage_based_price,
+              Dodopayments::Price::UsageBasedPrice::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Dodopayments::Price::UsageBasedPrice::Type::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       sig { override.returns(T::Array[Dodopayments::Price::Variants]) }
       def self.variants
       end

data/rbi/dodopayments/models/product.rbi

@@ -105,7 +105,8 @@ module Dodopayments
           price:
             T.any(
               Dodopayments::Price::OneTimePrice::OrHash,
-              Dodopayments::Price::RecurringPrice::OrHash
+              Dodopayments::Price::RecurringPrice::OrHash,
+              Dodopayments::Price::UsageBasedPrice::OrHash
             ),
           product_id: String,
           tax_category: Dodopayments::TaxCategory::OrSymbol,

data/rbi/dodopayments/models/product_archive_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductArchiveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductArchiveParams,
+            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

data/rbi/dodopayments/models/product_create_params.rbi

@@ -19,7 +19,8 @@ module Dodopayments
         returns(
           T.any(
             Dodopayments::Price::OneTimePrice,
-            Dodopayments::Price::RecurringPrice
+            Dodopayments::Price::RecurringPrice,
+            Dodopayments::Price::UsageBasedPrice
           )
         )
       end
@@ -101,7 +102,8 @@ module Dodopayments
           price:
             T.any(
               Dodopayments::Price::OneTimePrice::OrHash,
-              Dodopayments::Price::RecurringPrice::OrHash
+              Dodopayments::Price::RecurringPrice::OrHash,
+              Dodopayments::Price::UsageBasedPrice::OrHash
             ),
           tax_category: Dodopayments::TaxCategory::OrSymbol,
           addons: T.nilable(T::Array[String]),
@@ -158,7 +160,8 @@ module Dodopayments
             price:
               T.any(
                 Dodopayments::Price::OneTimePrice,
-                Dodopayments::Price::RecurringPrice
+                Dodopayments::Price::RecurringPrice,
+                Dodopayments::Price::UsageBasedPrice
               ),
             tax_category: Dodopayments::TaxCategory::OrSymbol,
             addons: T.nilable(T::Array[String]),

data/rbi/dodopayments/models/product_list_response.rbi

@@ -94,7 +94,8 @@ module Dodopayments
             T.nilable(
               T.any(
                 Dodopayments::Price::OneTimePrice::OrHash,
-                Dodopayments::Price::RecurringPrice::OrHash
+                Dodopayments::Price::RecurringPrice::OrHash,
+                Dodopayments::Price::UsageBasedPrice::OrHash
               )
             ),
           tax_inclusive: T.nilable(T::Boolean)

data/rbi/dodopayments/models/product_update_params.rbi

@@ -97,7 +97,8 @@ module Dodopayments
           T.nilable(
             T.any(
               Dodopayments::Price::OneTimePrice,
-              Dodopayments::Price::RecurringPrice
+              Dodopayments::Price::RecurringPrice,
+              Dodopayments::Price::UsageBasedPrice
             )
           )
         )
@@ -129,7 +130,8 @@ module Dodopayments
             T.nilable(
               T.any(
                 Dodopayments::Price::OneTimePrice::OrHash,
-                Dodopayments::Price::RecurringPrice::OrHash
+                Dodopayments::Price::RecurringPrice::OrHash,
+                Dodopayments::Price::UsageBasedPrice::OrHash
               )
             ),
           tax_category: T.nilable(Dodopayments::TaxCategory::OrSymbol),
@@ -199,7 +201,8 @@ module Dodopayments
               T.nilable(
                 T.any(
                   Dodopayments::Price::OneTimePrice,
-                  Dodopayments::Price::RecurringPrice
+                  Dodopayments::Price::RecurringPrice,
+                  Dodopayments::Price::UsageBasedPrice
                 )
               ),
             tax_category: T.nilable(Dodopayments::TaxCategory::OrSymbol),

data/rbi/dodopayments/models/subscription.rbi

@@ -44,6 +44,10 @@ module Dodopayments
       sig { returns(T::Hash[Symbol, String]) }
       attr_accessor :metadata
 
+      # Meters associated with this subscription (for usage-based billing)
+      sig { returns(T::Array[Dodopayments::Subscription::Meter]) }
+      attr_accessor :meters
+
       # Timestamp of the next scheduled billing. Indicates the end of current billing
       # period
       sig { returns(Time) }
@@ -128,6 +132,7 @@ module Dodopayments
           currency: Dodopayments::Currency::OrSymbol,
           customer: Dodopayments::CustomerLimitedDetails::OrHash,
           metadata: T::Hash[Symbol, String],
+          meters: T::Array[Dodopayments::Subscription::Meter::OrHash],
           next_billing_date: Time,
           on_demand: T::Boolean,
           payment_frequency_count: Integer,
@@ -163,6 +168,8 @@ module Dodopayments
         customer:,
         # Additional custom data associated with the subscription
         metadata:,
+        # Meters associated with this subscription (for usage-based billing)
+        meters:,
         # Timestamp of the next scheduled billing. Indicates the end of current billing
         # period
         next_billing_date:,
@@ -214,6 +221,7 @@ module Dodopayments
             currency: Dodopayments::Currency::TaggedSymbol,
             customer: Dodopayments::CustomerLimitedDetails,
             metadata: T::Hash[Symbol, String],
+            meters: T::Array[Dodopayments::Subscription::Meter],
             next_billing_date: Time,
             on_demand: T::Boolean,
             payment_frequency_count: Integer,
@@ -239,6 +247,76 @@ module Dodopayments
       end
       def to_hash
       end
+
+      class Meter < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Subscription::Meter,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Dodopayments::Currency::TaggedSymbol) }
+        attr_accessor :currency
+
+        sig { returns(Integer) }
+        attr_accessor :free_threshold
+
+        sig { returns(String) }
+        attr_accessor :measurement_unit
+
+        sig { returns(String) }
+        attr_accessor :meter_id
+
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig { returns(String) }
+        attr_accessor :price_per_unit
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # Response struct representing usage-based meter cart details for a subscription
+        sig do
+          params(
+            currency: Dodopayments::Currency::OrSymbol,
+            free_threshold: Integer,
+            measurement_unit: String,
+            meter_id: String,
+            name: String,
+            price_per_unit: String,
+            description: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          currency:,
+          free_threshold:,
+          measurement_unit:,
+          meter_id:,
+          name:,
+          price_per_unit:,
+          description: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              currency: Dodopayments::Currency::TaggedSymbol,
+              free_threshold: Integer,
+              measurement_unit: String,
+              meter_id: String,
+              name: String,
+              price_per_unit: String,
+              description: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/subscription_retrieve_usage_history_params.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionRetrieveUsageHistoryParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::SubscriptionRetrieveUsageHistoryParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Filter by end date (inclusive)
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :end_date
+
+      # Filter by specific meter ID
+      sig { returns(T.nilable(String)) }
+      attr_accessor :meter_id
+
+      # Page number (default: 0)
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :page_number
+
+      # Page size (default: 10, max: 100)
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :page_size
+
+      # Filter by start date (inclusive)
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :start_date
+
+      sig do
+        params(
+          end_date: T.nilable(Time),
+          meter_id: T.nilable(String),
+          page_number: T.nilable(Integer),
+          page_size: T.nilable(Integer),
+          start_date: T.nilable(Time),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter by end date (inclusive)
+        end_date: nil,
+        # Filter by specific meter ID
+        meter_id: nil,
+        # Page number (default: 0)
+        page_number: nil,
+        # Page size (default: 10, max: 100)
+        page_size: nil,
+        # Filter by start date (inclusive)
+        start_date: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            end_date: T.nilable(Time),
+            meter_id: T.nilable(String),
+            page_number: T.nilable(Integer),
+            page_size: T.nilable(Integer),
+            start_date: T.nilable(Time),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end