dodopayments 2.33.0 → 2.35.0

data/lib/dodopayments/models/price.rb

@@ -122,14 +122,16 @@ module Dodopayments
         required :currency, enum: -> { Dodopayments::Currency }
 
         # @!attribute payment_frequency_count
-        #   Number of units for the payment frequency. For example, a value of `1` with a
-        #   `payment_frequency_interval` of `month` represents monthly payments.
+        #   Number of `payment_frequency_interval` units between two charges. This field
+        #   sets the billing cycle. For example, `1` with a `payment_frequency_interval` of
+        #   `month` charges the customer every month.
         #
         #   @return [Integer]
         required :payment_frequency_count, Integer
 
         # @!attribute payment_frequency_interval
-        #   The time interval for the payment frequency (e.g., day, month, year).
+        #   The time unit of the billing cycle (e.g., day, month, year). Use it with
+        #   `payment_frequency_count`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
         required :payment_frequency_interval, enum: -> { Dodopayments::TimeInterval }
@@ -142,14 +144,30 @@ module Dodopayments
         required :price, Integer
 
         # @!attribute subscription_period_count
-        #   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.
+        #   Number of `subscription_period_interval` units for the total duration of the
+        #   subscription. This field does not set the billing cycle. Use
+        #   `payment_frequency_count` for the billing cycle. When this period ends, the
+        #   subscription expires. Dodo Payments does not start a new billing cycle after the
+        #   subscription expires. Dodo Payments can still retry a failed payment for an
+        #   earlier billing cycle.
+        #
+        #   For a subscription that renews until the customer cancels it, set this to `20`
+        #   with a `subscription_period_interval` of `year`. This is the recommended value
+        #   and also the maximum. The subscription expires after 20 years if the customer
+        #   does not cancel it before then.
+        #
+        #   For example, a monthly plan uses a `payment_frequency_count` of `1`, a
+        #   `payment_frequency_interval` of `month`, and a subscription period of `20`
+        #   `year`. Do not set the subscription period to `1` `month` for a monthly plan:
+        #   the subscription then expires after one month.
         #
         #   @return [Integer]
         required :subscription_period_count, Integer
 
         # @!attribute subscription_period_interval
-        #   The time interval for the subscription period (e.g., day, month, year).
+        #   The time unit of the total subscription duration (e.g., day, month, year). Use
+        #   it with `subscription_period_count`. The recommended value is `year`, with a
+        #   `subscription_period_count` of `20`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
         required :subscription_period_interval, enum: -> { Dodopayments::TimeInterval }
@@ -235,15 +253,15 @@ module Dodopayments
         #
         #   @param currency [Symbol, Dodopayments::Models::Currency] The currency in which the payment is made.
         #
-        #   @param payment_frequency_count [Integer] Number of units for the payment frequency.
+        #   @param payment_frequency_count [Integer] Number of `payment_frequency_interval` units between two charges.
         #
-        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the payment frequency (e.g., day, month, year).
+        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time unit of the billing cycle (e.g., day, month, year).
         #
         #   @param price [Integer] The payment amount. Represented in the lowest denomination of the currency (e.g.
         #
-        #   @param subscription_period_count [Integer] Number of units for the subscription period.
+        #   @param subscription_period_count [Integer] Number of `subscription_period_interval` units for the total duration of the sub
         #
-        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
+        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time unit of the total subscription duration (e.g., day, month, year).
         #
         #   @param discount [Integer] Deprecated: use `discount_bps` instead.
         #
@@ -281,27 +299,45 @@ module Dodopayments
         required :fixed_price, Integer
 
         # @!attribute payment_frequency_count
-        #   Number of units for the payment frequency. For example, a value of `1` with a
-        #   `payment_frequency_interval` of `month` represents monthly payments.
+        #   Number of `payment_frequency_interval` units between two charges. This field
+        #   sets the billing cycle. For example, `1` with a `payment_frequency_interval` of
+        #   `month` charges the customer every month.
         #
         #   @return [Integer]
         required :payment_frequency_count, Integer
 
         # @!attribute payment_frequency_interval
-        #   The time interval for the payment frequency (e.g., day, month, year).
+        #   The time unit of the billing cycle (e.g., day, month, year). Use it with
+        #   `payment_frequency_count`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
         required :payment_frequency_interval, enum: -> { Dodopayments::TimeInterval }
 
         # @!attribute subscription_period_count
-        #   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.
+        #   Number of `subscription_period_interval` units for the total duration of the
+        #   subscription. This field does not set the billing cycle. Use
+        #   `payment_frequency_count` for the billing cycle. When this period ends, the
+        #   subscription expires. Dodo Payments does not start a new billing cycle after the
+        #   subscription expires. Dodo Payments can still retry a failed payment for an
+        #   earlier billing cycle.
+        #
+        #   For a subscription that renews until the customer cancels it, set this to `20`
+        #   with a `subscription_period_interval` of `year`. This is the recommended value
+        #   and also the maximum. The subscription expires after 20 years if the customer
+        #   does not cancel it before then.
+        #
+        #   For example, a monthly plan uses a `payment_frequency_count` of `1`, a
+        #   `payment_frequency_interval` of `month`, and a subscription period of `20`
+        #   `year`. Do not set the subscription period to `1` `month` for a monthly plan:
+        #   the subscription then expires after one month.
         #
         #   @return [Integer]
         required :subscription_period_count, Integer
 
         # @!attribute subscription_period_interval
-        #   The time interval for the subscription period (e.g., day, month, year).
+        #   The time unit of the total subscription duration (e.g., day, month, year). Use
+        #   it with `subscription_period_count`. The recommended value is `year`, with a
+        #   `subscription_period_count` of `20`.
         #
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
         required :subscription_period_interval, enum: -> { Dodopayments::TimeInterval }
@@ -366,13 +402,13 @@ module Dodopayments
         #
         #   @param fixed_price [Integer] The fixed payment amount. Represented in the lowest denomination of the currency
         #
-        #   @param payment_frequency_count [Integer] Number of units for the payment frequency.
+        #   @param payment_frequency_count [Integer] Number of `payment_frequency_interval` units between two charges.
         #
-        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the payment frequency (e.g., day, month, year).
+        #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time unit of the billing cycle (e.g., day, month, year).
         #
-        #   @param subscription_period_count [Integer] Number of units for the subscription period.
+        #   @param subscription_period_count [Integer] Number of `subscription_period_interval` units for the total duration of the sub
         #
-        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
+        #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time unit of the total subscription duration (e.g., day, month, year).
         #
         #   @param discount [Integer] Deprecated: use `discount_bps` instead.
         #

data/lib/dodopayments/models/product_collection_list_params.rb

@@ -19,6 +19,17 @@ module Dodopayments
       #   @return [String, nil]
       optional :brand_id, String
 
+      # @!attribute locale
+      #   Shows the translated name, description and unit of the catalog entities in this
+      #   locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      #   with no translation, an unknown code, or no code shows the base text.
+      #
+      #   Do not send a text from a localized response back in a create or update request.
+      #   The base text then changes to the translated text.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
       # @!attribute page_number
       #   Page number default is 0
       #
@@ -31,11 +42,16 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :page_size, Integer
 
-      # @!method initialize(archived: nil, brand_id: nil, page_number: nil, page_size: nil, request_options: {})
+      # @!method initialize(archived: nil, brand_id: nil, locale: nil, page_number: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductCollectionListParams} for more details.
+      #
       #   @param archived [Boolean] List archived collections
       #
       #   @param brand_id [String] Filter by Brand id
       #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param page_number [Integer] Page number default is 0
       #
       #   @param page_size [Integer] Page size default is 10 max is 100

data/lib/dodopayments/models/product_collection_retrieve_params.rb

@@ -12,8 +12,25 @@ module Dodopayments
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute locale
+      #   Shows the translated name, description and unit of the catalog entities in this
+      #   locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      #   with no translation, an unknown code, or no code shows the base text.
+      #
+      #   Do not send a text from a localized response back in a create or update request.
+      #   The base text then changes to the translated text.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!method initialize(id:, locale: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductCollectionRetrieveParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/product_collections/group_update_params.rb

@@ -20,7 +20,8 @@ module Dodopayments
 
         # @!attribute group_name
         #   Optional group name update: Some(Some(name)) = set name, Some(None) = clear
-        #   name, None = no change
+        #   name, None = no change The API returns 422 if another group in the collection
+        #   has no name.
         #
         #   @return [String, nil]
         optional :group_name, String, nil?: true

data/lib/dodopayments/models/product_collections/translation_delete_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      # @see Dodopayments::Resources::ProductCollections::Translations#delete
+      class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!method initialize(id:, locale:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::ProductCollections::TranslationDeleteParams} for more
+        #   details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/translation_list_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      # @see Dodopayments::Resources::ProductCollections::Translations#list
+      class TranslationListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+        #   the response has all the locales.
+        #
+        #   @return [Array<String>, nil]
+        optional :locale, Dodopayments::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, locale: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::ProductCollections::TranslationListParams} for more
+        #   details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Array<String>] Returns only these locales, for example `?locale=fr&locale=de`. With no value, t
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/translation_update_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      # @see Dodopayments::Resources::ProductCollections::Translations#update
+      class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!attribute description
+        #   The translated description.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   The translated name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(id:, locale:, description: nil, name: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::ProductCollections::TranslationUpdateParams} for more
+        #   details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param description [String, nil] The translated description.
+        #
+        #   @param name [String, nil] The translated name.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_list_params.rb

@@ -19,6 +19,17 @@ module Dodopayments
       #   @return [String, nil]
       optional :brand_id, String
 
+      # @!attribute locale
+      #   Shows the translated name, description and unit of the catalog entities in this
+      #   locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      #   with no translation, an unknown code, or no code shows the base text.
+      #
+      #   Do not send a text from a localized response back in a create or update request.
+      #   The base text then changes to the translated text.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
       # @!attribute page_number
       #   Page number default is 0
       #
@@ -41,7 +52,7 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :recurring, Dodopayments::Internal::Type::Boolean
 
-      # @!method initialize(archived: nil, brand_id: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {})
+      # @!method initialize(archived: nil, brand_id: nil, locale: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::ProductListParams} for more details.
       #
@@ -49,6 +60,8 @@ module Dodopayments
       #
       #   @param brand_id [String] filter by Brand id
       #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param page_number [Integer] Page number default is 0
       #
       #   @param page_size [Integer] Page size default is 10 max is 100

data/lib/dodopayments/models/product_retrieve_params.rb

@@ -12,8 +12,25 @@ module Dodopayments
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute locale
+      #   Shows the translated name, description and unit of the catalog entities in this
+      #   locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      #   with no translation, an unknown code, or no code shows the base text.
+      #
+      #   Do not send a text from a localized response back in a create or update request.
+      #   The base text then changes to the translated text.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!method initialize(id:, locale: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductRetrieveParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/products/translation.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#update
+      class Translation < Dodopayments::Internal::Type::BaseModel
+        # @!attribute locale
+        #   The locale of the translation.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!attribute updated_at
+        #   The time of the last change.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute description
+        #   The translated description. `null` shows that the description has no
+        #   translation.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   The translated name. `null` shows that the name has no translation.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(locale:, updated_at:, description: nil, name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Products::Translation} for more details.
+        #
+        #   The translation of a product, an add-on, a product collection or a meter in one
+        #   locale.
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] The locale of the translation.
+        #
+        #   @param updated_at [Time] The time of the last change.
+        #
+        #   @param description [String, nil] The translated description. `null` shows that the description has no translation
+        #
+        #   @param name [String, nil] The translated name. `null` shows that the name has no translation.
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/translation_delete_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#delete
+      class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!method initialize(id:, locale:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Products::TranslationDeleteParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/translation_list_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#list
+      class TranslationListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+        #   the response has all the locales.
+        #
+        #   @return [Array<String>, nil]
+        optional :locale, Dodopayments::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, locale: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Products::TranslationListParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Array<String>] Returns only these locales, for example `?locale=fr&locale=de`. With no value, t
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/translation_update_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#update
+      class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!attribute description
+        #   The translated description.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   The translated name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(id:, locale:, description: nil, name: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Products::TranslationUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param description [String, nil] The translated description.
+        #
+        #   @param name [String, nil] The translated name.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/products/translations_list_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Products
+      # @see Dodopayments::Resources::Products::Translations#list
+      class TranslationsListResponse < Dodopayments::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<Dodopayments::Models::Products::Translation>]
+        required :items, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Products::Translation] }
+
+        # @!method initialize(items:)
+        #   The translations of a product, an add-on, a product collection or a meter.
+        #
+        #   @param items [Array<Dodopayments::Models::Products::Translation>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/refund_create_params.rb

@@ -13,6 +13,13 @@ module Dodopayments
       #   @return [String]
       required :payment_id, String
 
+      # @!attribute currency
+      #   The currency of every `items[].amount`. It must be the currency the customer
+      #   paid in. Without it, the amounts are in the settlement currency.
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency, nil]
+      optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
+
       # @!attribute items
       #   Partially Refund an Individual Item
       #
@@ -33,9 +40,14 @@ module Dodopayments
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(payment_id:, items: nil, metadata: nil, reason: nil, request_options: {})
+      # @!method initialize(payment_id:, currency: nil, items: nil, metadata: nil, reason: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::RefundCreateParams} for more details.
+      #
       #   @param payment_id [String] The unique identifier of the payment to be refunded.
       #
+      #   @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of every `items[].amount`. It must be the currency the customer pai
+      #
       #   @param items [Array<Dodopayments::Models::RefundCreateParams::Item>, nil] Partially Refund an Individual Item
       #
       #   @param metadata [Hash{Symbol=>String, Float, Boolean}] Additional metadata associated with the refund.