dodopayments 1.71.1 → 1.73.0

data/lib/dodopayments/models/product.rb

@@ -110,7 +110,13 @@ module Dodopayments
       #   @return [String, nil]
       optional :name, String, nil?: true
 
-      # @!method initialize(brand_id:, business_id:, created_at:, is_recurring:, license_key_enabled:, metadata:, price:, product_id:, tax_category:, updated_at:, addons: nil, description: nil, digital_product_delivery: nil, image: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, name: nil)
+      # @!attribute product_collection_id
+      #   The product collection ID this product belongs to, if any
+      #
+      #   @return [String, nil]
+      optional :product_collection_id, String, nil?: true
+
+      # @!method initialize(brand_id:, business_id:, created_at:, is_recurring:, license_key_enabled:, metadata:, price:, product_id:, tax_category:, updated_at:, addons: nil, description: nil, digital_product_delivery: nil, image: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, name: nil, product_collection_id: nil)
       #   @param brand_id [String]
       #
       #   @param business_id [String] Unique identifier for the business to which the product belongs.
@@ -146,6 +152,8 @@ module Dodopayments
       #   @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil] Duration of the license key validity, if enabled.
       #
       #   @param name [String, nil] Name of the product, optional.
+      #
+      #   @param product_collection_id [String, nil] The product collection ID this product belongs to, if any
 
       # @see Dodopayments::Models::Product#digital_product_delivery
       class DigitalProductDelivery < Dodopayments::Internal::Type::BaseModel

data/lib/dodopayments/models/subscription_change_plan_params.rb

@@ -33,7 +33,14 @@ module Dodopayments
       #   @return [Array<Dodopayments::Models::AttachAddon>, nil]
       optional :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AttachAddon] }, nil?: true
 
-      # @!method initialize(product_id:, proration_billing_mode:, quantity:, addons: nil, request_options: {})
+      # @!attribute metadata
+      #   Metadata for the payment. If not passed, the metadata of the subscription will
+      #   be taken
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true
+
+      # @!method initialize(product_id:, proration_billing_mode:, quantity:, addons: nil, metadata: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionChangePlanParams} for more details.
       #
@@ -45,6 +52,8 @@ module Dodopayments
       #
       #   @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
+      #   @param metadata [Hash{Symbol=>String}, nil] Metadata for the payment. If not passed, the metadata of the subscription will b
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
       # Proration Billing Mode

data/lib/dodopayments/models/subscription_preview_change_plan_params.rb

@@ -33,7 +33,14 @@ module Dodopayments
       #   @return [Array<Dodopayments::Models::AttachAddon>, nil]
       optional :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AttachAddon] }, nil?: true
 
-      # @!method initialize(product_id:, proration_billing_mode:, quantity:, addons: nil, request_options: {})
+      # @!attribute metadata
+      #   Metadata for the payment. If not passed, the metadata of the subscription will
+      #   be taken
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true
+
+      # @!method initialize(product_id:, proration_billing_mode:, quantity:, addons: nil, metadata: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionPreviewChangePlanParams} for more details.
       #
@@ -45,6 +52,8 @@ module Dodopayments
       #
       #   @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
+      #   @param metadata [Hash{Symbol=>String}, nil] Metadata for the payment. If not passed, the metadata of the subscription will b
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
       # Proration Billing Mode

data/lib/dodopayments/models.rb

@@ -75,6 +75,8 @@ module Dodopayments
 
   CheckoutSessionCreateParams = Dodopayments::Models::CheckoutSessionCreateParams
 
+  CheckoutSessionPreviewParams = Dodopayments::Models::CheckoutSessionPreviewParams
+
   CheckoutSessionRequest = Dodopayments::Models::CheckoutSessionRequest
 
   CheckoutSessionResponse = Dodopayments::Models::CheckoutSessionResponse
@@ -117,6 +119,8 @@ module Dodopayments
 
   DiscountListParams = Dodopayments::Models::DiscountListParams
 
+  DiscountRetrieveByCodeParams = Dodopayments::Models::DiscountRetrieveByCodeParams
+
   DiscountRetrieveParams = Dodopayments::Models::DiscountRetrieveParams
 
   DiscountType = Dodopayments::Models::DiscountType

data/lib/dodopayments/resources/checkout_sessions.rb

@@ -6,7 +6,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::CheckoutSessionCreateParams} for more details.
       #
-      # @overload create(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, confirm: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, request_options: {})
+      # @overload create(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, confirm: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, request_options: {})
       #
       # @param product_cart [Array<Dodopayments::Models::CheckoutSessionRequest::ProductCart>]
       #
@@ -34,6 +34,8 @@ module Dodopayments
       #
       # @param payment_method_id [String, nil] Optional payment method ID to use for this checkout session.
       #
+      # @param product_collection_id [String, nil] Product collection ID for collection-based checkout flow
+      #
       # @param return_url [String, nil] The url to redirect after payment failure or success.
       #
       # @param short_link [Boolean] If true, returns a shortened checkout URL.
@@ -75,6 +77,63 @@ module Dodopayments
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::CheckoutSessionPreviewParams} for more details.
+      #
+      # @overload preview(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, confirm: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, request_options: {})
+      #
+      # @param product_cart [Array<Dodopayments::Models::CheckoutSessionRequest::ProductCart>]
+      #
+      # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil] Customers will never see payment methods that are not in this list.
+      #
+      # @param billing_address [Dodopayments::Models::CheckoutSessionRequest::BillingAddress, nil] Billing address information for the session
+      #
+      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] This field is ingored if adaptive pricing is disabled
+      #
+      # @param confirm [Boolean] If confirm is true, all the details will be finalized. If required data is missi
+      #
+      # @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer, nil] Customer details for the session
+      #
+      # @param customization [Dodopayments::Models::CheckoutSessionRequest::Customization] Customization for the checkout session page
+      #
+      # @param discount_code [String, nil]
+      #
+      # @param feature_flags [Dodopayments::Models::CheckoutSessionRequest::FeatureFlags]
+      #
+      # @param force_3ds [Boolean, nil] Override merchant default 3DS behaviour for this session
+      #
+      # @param metadata [Hash{Symbol=>String}, nil] Additional metadata associated with the payment. Defaults to empty if not provid
+      #
+      # @param minimal_address [Boolean] If true, only zipcode is required when confirm is true; other address fields rem
+      #
+      # @param payment_method_id [String, nil] Optional payment method ID to use for this checkout session.
+      #
+      # @param product_collection_id [String, nil] Product collection ID for collection-based checkout flow
+      #
+      # @param return_url [String, nil] The url to redirect after payment failure or success.
+      #
+      # @param short_link [Boolean] If true, returns a shortened checkout URL.
+      #
+      # @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer False by default
+      #
+      # @param subscription_data [Dodopayments::Models::CheckoutSessionRequest::SubscriptionData, nil]
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::CheckoutSessionPreviewResponse]
+      #
+      # @see Dodopayments::Models::CheckoutSessionPreviewParams
+      def preview(params)
+        parsed, options = Dodopayments::CheckoutSessionPreviewParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "checkouts/preview",
+          body: parsed,
+          model: Dodopayments::Models::CheckoutSessionPreviewResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Dodopayments::Client]

data/lib/dodopayments/resources/discounts.rb

@@ -149,6 +149,28 @@ 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.
+      #
+      # @overload retrieve_by_code(code, request_options: {})
+      #
+      # @param code [String] The discount code (e.g., 'SAVE20')
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Discount]
+      #
+      # @see Dodopayments::Models::DiscountRetrieveByCodeParams
+      def retrieve_by_code(code, params = {})
+        @client.request(
+          method: :get,
+          path: ["discounts/code/%1$s", code],
+          model: Dodopayments::Discount,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Dodopayments::Client]

data/lib/dodopayments/resources/subscriptions.rb

@@ -156,7 +156,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionChangePlanParams} for more details.
       #
-      # @overload change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, addons: nil, request_options: {})
+      # @overload change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, addons: nil, metadata: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -168,6 +168,8 @@ module Dodopayments
       #
       # @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
+      # @param metadata [Hash{Symbol=>String}, nil] Metadata for the payment. If not passed, the metadata of the subscription will b
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -222,7 +224,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionPreviewChangePlanParams} for more details.
       #
-      # @overload preview_change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, addons: nil, request_options: {})
+      # @overload preview_change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, addons: nil, metadata: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -234,6 +236,8 @@ module Dodopayments
       #
       # @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
+      # @param metadata [Hash{Symbol=>String}, nil] Metadata for the payment. If not passed, the metadata of the subscription will b
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::SubscriptionPreviewChangePlanResponse]

data/lib/dodopayments/version.rb

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

data/lib/dodopayments.rb

@@ -81,6 +81,8 @@ require_relative "dodopayments/models/brand_update_images_params"
 require_relative "dodopayments/models/brand_update_images_response"
 require_relative "dodopayments/models/brand_update_params"
 require_relative "dodopayments/models/checkout_session_create_params"
+require_relative "dodopayments/models/checkout_session_preview_params"
+require_relative "dodopayments/models/checkout_session_preview_response"
 require_relative "dodopayments/models/checkout_session_response"
 require_relative "dodopayments/models/checkout_session_retrieve_params"
 require_relative "dodopayments/models/checkout_session_status"
@@ -108,6 +110,7 @@ require_relative "dodopayments/models/discount"
 require_relative "dodopayments/models/discount_create_params"
 require_relative "dodopayments/models/discount_delete_params"
 require_relative "dodopayments/models/discount_list_params"
+require_relative "dodopayments/models/discount_retrieve_by_code_params"
 require_relative "dodopayments/models/discount_retrieve_params"
 require_relative "dodopayments/models/discount_type"
 require_relative "dodopayments/models/discount_update_params"

data/rbi/dodopayments/models/checkout_session_preview_params.rbi

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