dodopayments 1.71.1 → 1.74.0

data/rbi/dodopayments/resources/discounts.rbi

@@ -111,8 +111,12 @@ module Dodopayments
       # GET /discounts
       sig do
         params(
+          active: T::Boolean,
+          code: String,
+          discount_type: Dodopayments::DiscountType::OrSymbol,
           page_number: Integer,
           page_size: Integer,
+          product_id: String,
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(
           Dodopayments::Internal::DefaultPageNumberPagination[
@@ -121,10 +125,18 @@ module Dodopayments
         )
       end
       def list(
+        # Filter by active status (true = not expired, false = expired)
+        active: nil,
+        # Filter by discount code (partial match, case-insensitive)
+        code: nil,
+        # Filter by discount type (percentage)
+        discount_type: nil,
         # Page number (default = 0).
         page_number: nil,
         # Page size (default = 10, max = 100).
         page_size: nil,
+        # Filter by product restriction (only discounts that apply to this product)
+        product_id: nil,
         request_options: {}
       )
       end
@@ -143,6 +155,22 @@ module Dodopayments
       )
       end
 
+      # Validate and fetch a discount by its code name (e.g., "SAVE20"). This allows
+      # real-time validation directly against the API using the human-readable discount
+      # code instead of requiring the internal discount_id.
+      sig do
+        params(
+          code: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Discount)
+      end
+      def retrieve_by_code(
+        # The discount code (e.g., 'SAVE20')
+        code,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Dodopayments::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/dodopayments/resources/license_keys.rbi

@@ -43,6 +43,8 @@ module Dodopayments
 
       sig do
         params(
+          created_at_gte: Time,
+          created_at_lte: Time,
           customer_id: String,
           page_number: Integer,
           page_size: Integer,
@@ -56,6 +58,10 @@ module Dodopayments
         )
       end
       def list(
+        # Filter license keys created on or after this timestamp
+        created_at_gte: nil,
+        # Filter license keys created on or before this timestamp
+        created_at_lte: nil,
         # Filter by customer ID
         customer_id: nil,
         # Page number default is 0

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -179,6 +179,7 @@ module Dodopayments
             Dodopayments::SubscriptionChangePlanParams::ProrationBillingMode::OrSymbol,
           quantity: Integer,
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          metadata: T.nilable(T::Hash[Symbol, String]),
           request_options: Dodopayments::RequestOptions::OrHash
         ).void
       end
@@ -194,6 +195,9 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # Metadata for the payment. If not passed, the metadata of the subscription will
+        # be taken
+        metadata: nil,
         request_options: {}
       )
       end
@@ -246,6 +250,7 @@ module Dodopayments
             Dodopayments::SubscriptionPreviewChangePlanParams::ProrationBillingMode::OrSymbol,
           quantity: Integer,
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          metadata: T.nilable(T::Hash[Symbol, String]),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Models::SubscriptionPreviewChangePlanResponse)
       end
@@ -261,6 +266,9 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # Metadata for the payment. If not passed, the metadata of the subscription will
+        # be taken
+        metadata: nil,
         request_options: {}
       )
       end

data/sig/dodopayments/models/checkout_session_preview_params.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    type checkout_session_preview_params =
+      {  } & Dodopayments::Internal::Type::request_parameters
+
+    class CheckoutSessionPreviewParams < Dodopayments::Models::CheckoutSessionRequest
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Dodopayments::request_opts) -> void
+
+      def to_hash: -> { request_options: Dodopayments::RequestOptions }
+    end
+  end
+end

data/sig/dodopayments/models/checkout_session_preview_response.rbs

@@ -0,0 +1,330 @@
+module Dodopayments
+  module Models
+    type checkout_session_preview_response =
+      {
+        billing_country: Dodopayments::Models::country_code,
+        currency: Dodopayments::Models::currency,
+        current_breakup: Dodopayments::Models::CheckoutSessionPreviewResponse::CurrentBreakup,
+        product_cart: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart],
+        total_price: Integer,
+        recurring_breakup: Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup?,
+        total_tax: Integer?
+      }
+
+    class CheckoutSessionPreviewResponse < Dodopayments::Internal::Type::BaseModel
+      attr_accessor billing_country: Dodopayments::Models::country_code
+
+      attr_accessor currency: Dodopayments::Models::currency
+
+      attr_accessor current_breakup: Dodopayments::Models::CheckoutSessionPreviewResponse::CurrentBreakup
+
+      attr_accessor product_cart: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart]
+
+      attr_accessor total_price: Integer
+
+      attr_accessor recurring_breakup: Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup?
+
+      attr_accessor total_tax: Integer?
+
+      def initialize: (
+        billing_country: Dodopayments::Models::country_code,
+        currency: Dodopayments::Models::currency,
+        current_breakup: Dodopayments::Models::CheckoutSessionPreviewResponse::CurrentBreakup,
+        product_cart: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart],
+        total_price: Integer,
+        ?recurring_breakup: Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup?,
+        ?total_tax: Integer?
+      ) -> void
+
+      def to_hash: -> {
+        billing_country: Dodopayments::Models::country_code,
+        currency: Dodopayments::Models::currency,
+        current_breakup: Dodopayments::Models::CheckoutSessionPreviewResponse::CurrentBreakup,
+        product_cart: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart],
+        total_price: Integer,
+        recurring_breakup: Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup?,
+        total_tax: Integer?
+      }
+
+      type current_breakup =
+        {
+          discount: Integer,
+          subtotal: Integer,
+          total_amount: Integer,
+          tax: Integer?
+        }
+
+      class CurrentBreakup < Dodopayments::Internal::Type::BaseModel
+        attr_accessor discount: Integer
+
+        attr_accessor subtotal: Integer
+
+        attr_accessor total_amount: Integer
+
+        attr_accessor tax: Integer?
+
+        def initialize: (
+          discount: Integer,
+          subtotal: Integer,
+          total_amount: Integer,
+          ?tax: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          discount: Integer,
+          subtotal: Integer,
+          total_amount: Integer,
+          tax: Integer?
+        }
+      end
+
+      type product_cart =
+        {
+          currency: Dodopayments::Models::currency,
+          discounted_price: Integer,
+          is_subscription: bool,
+          is_usage_based: bool,
+          meters: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Meter],
+          og_currency: Dodopayments::Models::currency,
+          og_price: Integer,
+          product_id: String,
+          quantity: Integer,
+          tax_category: Dodopayments::Models::tax_category,
+          tax_inclusive: bool,
+          tax_rate: Integer,
+          addons: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Addon]?,
+          description: String?,
+          discount_amount: Integer?,
+          discount_cycle: Integer?,
+          name: String?,
+          tax: Integer?
+        }
+
+      class ProductCart < Dodopayments::Internal::Type::BaseModel
+        attr_accessor currency: Dodopayments::Models::currency
+
+        attr_accessor discounted_price: Integer
+
+        attr_accessor is_subscription: bool
+
+        attr_accessor is_usage_based: bool
+
+        attr_accessor meters: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Meter]
+
+        attr_accessor og_currency: Dodopayments::Models::currency
+
+        attr_accessor og_price: Integer
+
+        attr_accessor product_id: String
+
+        attr_accessor quantity: Integer
+
+        attr_accessor tax_category: Dodopayments::Models::tax_category
+
+        attr_accessor tax_inclusive: bool
+
+        attr_accessor tax_rate: Integer
+
+        attr_accessor addons: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Addon]?
+
+        attr_accessor description: String?
+
+        attr_accessor discount_amount: Integer?
+
+        attr_accessor discount_cycle: Integer?
+
+        attr_accessor name: String?
+
+        attr_accessor tax: Integer?
+
+        def initialize: (
+          currency: Dodopayments::Models::currency,
+          discounted_price: Integer,
+          is_subscription: bool,
+          is_usage_based: bool,
+          meters: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Meter],
+          og_currency: Dodopayments::Models::currency,
+          og_price: Integer,
+          product_id: String,
+          quantity: Integer,
+          tax_category: Dodopayments::Models::tax_category,
+          tax_inclusive: bool,
+          tax_rate: Integer,
+          ?addons: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Addon]?,
+          ?description: String?,
+          ?discount_amount: Integer?,
+          ?discount_cycle: Integer?,
+          ?name: String?,
+          ?tax: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          currency: Dodopayments::Models::currency,
+          discounted_price: Integer,
+          is_subscription: bool,
+          is_usage_based: bool,
+          meters: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Meter],
+          og_currency: Dodopayments::Models::currency,
+          og_price: Integer,
+          product_id: String,
+          quantity: Integer,
+          tax_category: Dodopayments::Models::tax_category,
+          tax_inclusive: bool,
+          tax_rate: Integer,
+          addons: ::Array[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Addon]?,
+          description: String?,
+          discount_amount: Integer?,
+          discount_cycle: Integer?,
+          name: String?,
+          tax: Integer?
+        }
+
+        type meter =
+          {
+            measurement_unit: String,
+            name: String,
+            price_per_unit: String,
+            description: String?,
+            free_threshold: Integer?
+          }
+
+        class Meter < Dodopayments::Internal::Type::BaseModel
+          attr_accessor measurement_unit: String
+
+          attr_accessor name: String
+
+          attr_accessor price_per_unit: String
+
+          attr_accessor description: String?
+
+          attr_accessor free_threshold: Integer?
+
+          def initialize: (
+            measurement_unit: String,
+            name: String,
+            price_per_unit: String,
+            ?description: String?,
+            ?free_threshold: Integer?
+          ) -> void
+
+          def to_hash: -> {
+            measurement_unit: String,
+            name: String,
+            price_per_unit: String,
+            description: String?,
+            free_threshold: Integer?
+          }
+        end
+
+        type addon =
+          {
+            addon_id: String,
+            currency: Dodopayments::Models::currency,
+            discounted_price: Integer,
+            name: String,
+            og_currency: Dodopayments::Models::currency,
+            og_price: Integer,
+            quantity: Integer,
+            tax_category: Dodopayments::Models::tax_category,
+            tax_inclusive: bool,
+            tax_rate: Integer,
+            description: String?,
+            discount_amount: Integer?,
+            tax: Integer?
+          }
+
+        class Addon < Dodopayments::Internal::Type::BaseModel
+          attr_accessor addon_id: String
+
+          attr_accessor currency: Dodopayments::Models::currency
+
+          attr_accessor discounted_price: Integer
+
+          attr_accessor name: String
+
+          attr_accessor og_currency: Dodopayments::Models::currency
+
+          attr_accessor og_price: Integer
+
+          attr_accessor quantity: Integer
+
+          attr_accessor tax_category: Dodopayments::Models::tax_category
+
+          attr_accessor tax_inclusive: bool
+
+          attr_accessor tax_rate: Integer
+
+          attr_accessor description: String?
+
+          attr_accessor discount_amount: Integer?
+
+          attr_accessor tax: Integer?
+
+          def initialize: (
+            addon_id: String,
+            currency: Dodopayments::Models::currency,
+            discounted_price: Integer,
+            name: String,
+            og_currency: Dodopayments::Models::currency,
+            og_price: Integer,
+            quantity: Integer,
+            tax_category: Dodopayments::Models::tax_category,
+            tax_inclusive: bool,
+            tax_rate: Integer,
+            ?description: String?,
+            ?discount_amount: Integer?,
+            ?tax: Integer?
+          ) -> void
+
+          def to_hash: -> {
+            addon_id: String,
+            currency: Dodopayments::Models::currency,
+            discounted_price: Integer,
+            name: String,
+            og_currency: Dodopayments::Models::currency,
+            og_price: Integer,
+            quantity: Integer,
+            tax_category: Dodopayments::Models::tax_category,
+            tax_inclusive: bool,
+            tax_rate: Integer,
+            description: String?,
+            discount_amount: Integer?,
+            tax: Integer?
+          }
+        end
+      end
+
+      type recurring_breakup =
+        {
+          discount: Integer,
+          subtotal: Integer,
+          total_amount: Integer,
+          tax: Integer?
+        }
+
+      class RecurringBreakup < Dodopayments::Internal::Type::BaseModel
+        attr_accessor discount: Integer
+
+        attr_accessor subtotal: Integer
+
+        attr_accessor total_amount: Integer
+
+        attr_accessor tax: Integer?
+
+        def initialize: (
+          discount: Integer,
+          subtotal: Integer,
+          total_amount: Integer,
+          ?tax: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          discount: Integer,
+          subtotal: Integer,
+          total_amount: Integer,
+          tax: Integer?
+        }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/checkout_session_request.rbs

@@ -7,6 +7,7 @@ module Dodopayments
         billing_address: Dodopayments::CheckoutSessionRequest::BillingAddress?,
         billing_currency: Dodopayments::Models::currency?,
         confirm: bool,
+        custom_fields: ::Array[Dodopayments::CheckoutSessionRequest::CustomField]?,
         customer: Dodopayments::Models::customer_request?,
         customization: Dodopayments::CheckoutSessionRequest::Customization,
         discount_code: String?,
@@ -15,6 +16,7 @@ module Dodopayments
         metadata: ::Hash[Symbol, String]?,
         minimal_address: bool,
         payment_method_id: String?,
+        product_collection_id: String?,
         return_url: String?,
         short_link: bool,
         show_saved_payment_methods: bool,
@@ -34,6 +36,8 @@ module Dodopayments
 
       def confirm=: (bool) -> bool
 
+      attr_accessor custom_fields: ::Array[Dodopayments::CheckoutSessionRequest::CustomField]?
+
       attr_accessor customer: Dodopayments::Models::customer_request?
 
       attr_reader customization: Dodopayments::CheckoutSessionRequest::Customization?
@@ -60,6 +64,8 @@ module Dodopayments
 
       attr_accessor payment_method_id: String?
 
+      attr_accessor product_collection_id: String?
+
       attr_accessor return_url: String?
 
       attr_reader short_link: bool?
@@ -78,6 +84,7 @@ module Dodopayments
         ?billing_address: Dodopayments::CheckoutSessionRequest::BillingAddress?,
         ?billing_currency: Dodopayments::Models::currency?,
         ?confirm: bool,
+        ?custom_fields: ::Array[Dodopayments::CheckoutSessionRequest::CustomField]?,
         ?customer: Dodopayments::Models::customer_request?,
         ?customization: Dodopayments::CheckoutSessionRequest::Customization,
         ?discount_code: String?,
@@ -86,6 +93,7 @@ module Dodopayments
         ?metadata: ::Hash[Symbol, String]?,
         ?minimal_address: bool,
         ?payment_method_id: String?,
+        ?product_collection_id: String?,
         ?return_url: String?,
         ?short_link: bool,
         ?show_saved_payment_methods: bool,
@@ -98,6 +106,7 @@ module Dodopayments
         billing_address: Dodopayments::CheckoutSessionRequest::BillingAddress?,
         billing_currency: Dodopayments::Models::currency?,
         confirm: bool,
+        custom_fields: ::Array[Dodopayments::CheckoutSessionRequest::CustomField]?,
         customer: Dodopayments::Models::customer_request?,
         customization: Dodopayments::CheckoutSessionRequest::Customization,
         discount_code: String?,
@@ -106,6 +115,7 @@ module Dodopayments
         metadata: ::Hash[Symbol, String]?,
         minimal_address: bool,
         payment_method_id: String?,
+        product_collection_id: String?,
         return_url: String?,
         short_link: bool,
         show_saved_payment_methods: bool,
@@ -181,6 +191,77 @@ module Dodopayments
         }
       end
 
+      type custom_field =
+        {
+          field_type: Dodopayments::Models::CheckoutSessionRequest::CustomField::field_type,
+          key: String,
+          label: String,
+          options: ::Array[String]?,
+          placeholder: String?,
+          required: bool
+        }
+
+      class CustomField < Dodopayments::Internal::Type::BaseModel
+        attr_accessor field_type: Dodopayments::Models::CheckoutSessionRequest::CustomField::field_type
+
+        attr_accessor key: String
+
+        attr_accessor label: String
+
+        attr_accessor options: ::Array[String]?
+
+        attr_accessor placeholder: String?
+
+        attr_reader required: bool?
+
+        def required=: (bool) -> bool
+
+        def initialize: (
+          field_type: Dodopayments::Models::CheckoutSessionRequest::CustomField::field_type,
+          key: String,
+          label: String,
+          ?options: ::Array[String]?,
+          ?placeholder: String?,
+          ?required: bool
+        ) -> void
+
+        def to_hash: -> {
+          field_type: Dodopayments::Models::CheckoutSessionRequest::CustomField::field_type,
+          key: String,
+          label: String,
+          options: ::Array[String]?,
+          placeholder: String?,
+          required: bool
+        }
+
+        type field_type =
+          :text
+          | :number
+          | :email
+          | :url
+          | :phone
+          | :date
+          | :datetime
+          | :dropdown
+          | :boolean
+
+        module FieldType
+          extend Dodopayments::Internal::Type::Enum
+
+          TEXT: :text
+          NUMBER: :number
+          EMAIL: :email
+          URL: :url
+          PHONE: :phone
+          DATE: :date
+          DATETIME: :datetime
+          DROPDOWN: :dropdown
+          BOOLEAN: :boolean
+
+          def self?.values: -> ::Array[Dodopayments::Models::CheckoutSessionRequest::CustomField::field_type]
+        end
+      end
+
       type customization =
         {
           force_language: String?,

data/sig/dodopayments/models/customer_list_params.rbs

@@ -1,17 +1,36 @@
 module Dodopayments
   module Models
     type customer_list_params =
-      { email: String, page_number: Integer, page_size: Integer }
+      {
+        created_at_gte: Time,
+        created_at_lte: Time,
+        email: String,
+        name: String,
+        page_number: Integer,
+        page_size: Integer
+      }
       & Dodopayments::Internal::Type::request_parameters
 
     class CustomerListParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      attr_reader created_at_gte: Time?
+
+      def created_at_gte=: (Time) -> Time
+
+      attr_reader created_at_lte: Time?
+
+      def created_at_lte=: (Time) -> Time
+
       attr_reader email: String?
 
       def email=: (String) -> String
 
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
       attr_reader page_number: Integer?
 
       def page_number=: (Integer) -> Integer
@@ -21,14 +40,20 @@ module Dodopayments
       def page_size=: (Integer) -> Integer
 
       def initialize: (
+        ?created_at_gte: Time,
+        ?created_at_lte: Time,
         ?email: String,
+        ?name: String,
         ?page_number: Integer,
         ?page_size: Integer,
         ?request_options: Dodopayments::request_opts
       ) -> void
 
       def to_hash: -> {
+        created_at_gte: Time,
+        created_at_lte: Time,
         email: String,
+        name: String,
         page_number: Integer,
         page_size: Integer,
         request_options: Dodopayments::RequestOptions