dodopayments 1.22.0 → 1.47.0

data/lib/dodopayments/models/product_list_response.rb

@@ -22,6 +22,12 @@ module Dodopayments
       #   @return [Boolean]
       required :is_recurring, Dodopayments::Internal::Type::Boolean
 
+      # @!attribute metadata
+      #   Additional custom data associated with the product
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Dodopayments::Internal::Type::HashOf[String]
+
       # @!attribute product_id
       #   Unique identifier for the product.
       #
@@ -29,11 +35,10 @@ module Dodopayments
       required :product_id, String
 
       # @!attribute tax_category
-      #   Represents the different categories of taxation applicable to various products
-      #   and services.
+      #   Tax category associated with the product.
       #
       #   @return [Symbol, Dodopayments::Models::TaxCategory]
-      required :tax_category, enum: -> { Dodopayments::Models::TaxCategory }
+      required :tax_category, enum: -> { Dodopayments::TaxCategory }
 
       # @!attribute updated_at
       #   Timestamp when the product was last updated.
@@ -42,9 +47,10 @@ module Dodopayments
       required :updated_at, Time
 
       # @!attribute currency
+      #   Currency of the price
       #
       #   @return [Symbol, Dodopayments::Models::Currency, nil]
-      optional :currency, enum: -> { Dodopayments::Models::Currency }, nil?: true
+      optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
 
       # @!attribute description
       #   Description of the product, optional.
@@ -80,9 +86,10 @@ module Dodopayments
       optional :price, Integer, nil?: true
 
       # @!attribute price_detail
+      #   Details of the price
       #
       #   @return [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
-      optional :price_detail, union: -> { Dodopayments::Models::Price }, nil?: true
+      optional :price_detail, union: -> { Dodopayments::Price }, nil?: true
 
       # @!attribute tax_inclusive
       #   Indicates if the price is tax inclusive
@@ -90,7 +97,7 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
-      # @!method initialize(business_id:, created_at:, is_recurring:, product_id:, tax_category:, updated_at:, currency: nil, description: nil, image: nil, name: nil, price: nil, price_detail: nil, tax_inclusive: nil)
+      # @!method initialize(business_id:, created_at:, is_recurring:, metadata:, product_id:, tax_category:, updated_at:, currency: nil, description: nil, image: nil, name: nil, price: nil, price_detail: nil, tax_inclusive: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::ProductListResponse} for more details.
       #
@@ -100,14 +107,15 @@ module Dodopayments
       #
       #   @param is_recurring [Boolean] Indicates if the product is recurring (e.g., subscriptions).
       #
+      #   @param metadata [Hash{Symbol=>String}] Additional custom data associated with the product
+      #
       #   @param product_id [String] Unique identifier for the product.
       #
-      #   @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
-      #   ...
+      #   @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Tax category associated with the product.
       #
       #   @param updated_at [Time] Timestamp when the product was last updated.
       #
-      #   @param currency [Symbol, Dodopayments::Models::Currency, nil]
+      #   @param currency [Symbol, Dodopayments::Models::Currency, nil] Currency of the price
       #
       #   @param description [String, nil] Description of the product, optional.
       #
@@ -115,9 +123,9 @@ module Dodopayments
       #
       #   @param name [String, nil] Name of the product, optional.
       #
-      #   @param price [Integer, nil] Price of the product, optional. ...
+      #   @param price [Integer, nil] Price of the product, optional.
       #
-      #   @param price_detail [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
+      #   @param price_detail [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil] Details of the price
       #
       #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive
     end

data/lib/dodopayments/models/product_update_files_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Products#update_files
+    class ProductUpdateFilesParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute file_name
+      #
+      #   @return [String]
+      required :file_name, String
+
+      # @!method initialize(file_name:, request_options: {})
+      #   @param file_name [String]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/product_update_files_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Products#update_files
+    class ProductUpdateFilesResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute file_id
+      #
+      #   @return [String]
+      required :file_id, String
+
+      # @!attribute url
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(file_id:, url:)
+      #   @param file_id [String]
+      #   @param url [String]
+    end
+  end
+end

data/lib/dodopayments/models/product_update_params.rb

@@ -13,12 +13,25 @@ module Dodopayments
       #   @return [Array<String>, nil]
       optional :addons, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
 
+      # @!attribute brand_id
+      #
+      #   @return [String, nil]
+      optional :brand_id, String, nil?: true
+
       # @!attribute description
       #   Description of the product, optional and must be at most 1000 characters.
       #
       #   @return [String, nil]
       optional :description, String, nil?: true
 
+      # @!attribute digital_product_delivery
+      #   Choose how you would like you digital product delivered
+      #
+      #   @return [Dodopayments::Models::ProductUpdateParams::DigitalProductDelivery, nil]
+      optional :digital_product_delivery,
+               -> { Dodopayments::ProductUpdateParams::DigitalProductDelivery },
+               nil?: true
+
       # @!attribute image_id
       #   Product image id after its uploaded to S3
       #
@@ -44,9 +57,13 @@ module Dodopayments
       optional :license_key_activations_limit, Integer, nil?: true
 
       # @!attribute license_key_duration
+      #   Duration of the license key if enabled.
+      #
+      #   Only applicable if `license_key_enabled` is `true`. Represents the duration in
+      #   days for which the license key is valid.
       #
       #   @return [Dodopayments::Models::LicenseKeyDuration, nil]
-      optional :license_key_duration, -> { Dodopayments::Models::LicenseKeyDuration }, nil?: true
+      optional :license_key_duration, -> { Dodopayments::LicenseKeyDuration }, nil?: true
 
       # @!attribute license_key_enabled
       #   Whether the product requires a license key.
@@ -57,6 +74,12 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :license_key_enabled, Dodopayments::Internal::Type::Boolean, nil?: true
 
+      # @!attribute metadata
+      #   Additional metadata for the product
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true
+
       # @!attribute name
       #   Name of the product, optional and must be at most 100 characters.
       #
@@ -64,43 +87,77 @@ module Dodopayments
       optional :name, String, nil?: true
 
       # @!attribute price
+      #   Price details of the product.
       #
       #   @return [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
-      optional :price, union: -> { Dodopayments::Models::Price }, nil?: true
+      optional :price, union: -> { Dodopayments::Price }, nil?: true
 
       # @!attribute tax_category
-      #   Represents the different categories of taxation applicable to various products
-      #   and services.
+      #   Tax category of the product.
       #
       #   @return [Symbol, Dodopayments::Models::TaxCategory, nil]
-      optional :tax_category, enum: -> { Dodopayments::Models::TaxCategory }, nil?: true
+      optional :tax_category, enum: -> { Dodopayments::TaxCategory }, nil?: true
 
-      # @!method initialize(addons: nil, description: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, name: nil, price: nil, tax_category: nil, request_options: {})
+      # @!method initialize(addons: nil, brand_id: nil, description: nil, digital_product_delivery: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, tax_category: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::ProductUpdateParams} for more details.
       #
       #   @param addons [Array<String>, nil] Available Addons for subscription products
       #
+      #   @param brand_id [String, nil]
+      #
       #   @param description [String, nil] Description of the product, optional and must be at most 1000 characters.
       #
+      #   @param digital_product_delivery [Dodopayments::Models::ProductUpdateParams::DigitalProductDelivery, nil] Choose how you would like you digital product delivered
+      #
       #   @param image_id [String, nil] Product image id after its uploaded to S3
       #
-      #   @param license_key_activation_message [String, nil] Message sent to the customer upon license key activation. ...
+      #   @param license_key_activation_message [String, nil] Message sent to the customer upon license key activation.
       #
-      #   @param license_key_activations_limit [Integer, nil] Limit for the number of activations for the license key. ...
+      #   @param license_key_activations_limit [Integer, nil] Limit for the number of activations for the license key.
       #
-      #   @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil]
+      #   @param license_key_duration [Dodopayments::Models::LicenseKeyDuration, nil] Duration of the license key if enabled.
       #
-      #   @param license_key_enabled [Boolean, nil] Whether the product requires a license key. ...
+      #   @param license_key_enabled [Boolean, nil] Whether the product requires a license key.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the product
       #
       #   @param name [String, nil] Name of the product, optional and must be at most 100 characters.
       #
-      #   @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil]
+      #   @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, nil] Price details of the product.
       #
-      #   @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
-      #   ...
+      #   @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Tax category of the product.
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      class DigitalProductDelivery < Dodopayments::Internal::Type::BaseModel
+        # @!attribute external_url
+        #   External URL to digital product
+        #
+        #   @return [String, nil]
+        optional :external_url, String, nil?: true
+
+        # @!attribute files
+        #   Uploaded files ids of digital product
+        #
+        #   @return [Array<String>, nil]
+        optional :files, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute instructions
+        #   Instructions to download and use the digital product
+        #
+        #   @return [String, nil]
+        optional :instructions, String, nil?: true
+
+        # @!method initialize(external_url: nil, files: nil, instructions: nil)
+        #   Choose how you would like you digital product delivered
+        #
+        #   @param external_url [String, nil] External URL to digital product
+        #
+        #   @param files [Array<String>, nil] Uploaded files ids of digital product
+        #
+        #   @param instructions [String, nil] Instructions to download and use the digital product
+      end
     end
   end
 end

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

@@ -11,10 +11,10 @@ module Dodopayments
         # @!attribute force_update
         #
         #   @return [Boolean, nil]
-        optional :force_update, Dodopayments::Internal::Type::Boolean, nil?: true
+        optional :force_update, Dodopayments::Internal::Type::Boolean
 
         # @!method initialize(force_update: nil, request_options: {})
-        #   @param force_update [Boolean, nil]
+        #   @param force_update [Boolean]
         #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/dodopayments/models/refund.rb

@@ -16,6 +16,12 @@ module Dodopayments
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute is_partial
+      #   If true the refund is a partial refund
+      #
+      #   @return [Boolean]
+      required :is_partial, Dodopayments::Internal::Type::Boolean
+
       # @!attribute payment_id
       #   The unique identifier of the payment associated with the refund.
       #
@@ -29,9 +35,10 @@ module Dodopayments
       required :refund_id, String
 
       # @!attribute status
+      #   The current status of the refund.
       #
       #   @return [Symbol, Dodopayments::Models::RefundStatus]
-      required :status, enum: -> { Dodopayments::Models::RefundStatus }
+      required :status, enum: -> { Dodopayments::RefundStatus }
 
       # @!attribute amount
       #   The refunded amount.
@@ -40,9 +47,10 @@ module Dodopayments
       optional :amount, Integer, nil?: true
 
       # @!attribute currency
+      #   The currency of the refund, represented as an ISO 4217 currency code.
       #
       #   @return [Symbol, Dodopayments::Models::Currency, nil]
-      optional :currency, enum: -> { Dodopayments::Models::Currency }, nil?: true
+      optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
 
       # @!attribute reason
       #   The reason provided for the refund, if any. Optional.
@@ -50,20 +58,22 @@ module Dodopayments
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(business_id:, created_at:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil)
+      # @!method initialize(business_id:, created_at:, is_partial:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil)
       #   @param business_id [String] The unique identifier of the business issuing the refund.
       #
       #   @param created_at [Time] The timestamp of when the refund was created in UTC.
       #
+      #   @param is_partial [Boolean] If true the refund is a partial refund
+      #
       #   @param payment_id [String] The unique identifier of the payment associated with the refund.
       #
       #   @param refund_id [String] The unique identifier of the refund.
       #
-      #   @param status [Symbol, Dodopayments::Models::RefundStatus]
+      #   @param status [Symbol, Dodopayments::Models::RefundStatus] The current status of the refund.
       #
       #   @param amount [Integer, nil] The refunded amount.
       #
-      #   @param currency [Symbol, Dodopayments::Models::Currency, nil]
+      #   @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of the refund, represented as an ISO 4217 currency code.
       #
       #   @param reason [String, nil] The reason provided for the refund, if any. Optional.
     end

data/lib/dodopayments/models/refund_create_params.rb

@@ -13,18 +13,55 @@ module Dodopayments
       #   @return [String]
       required :payment_id, String
 
+      # @!attribute items
+      #   Partially Refund an Individual Item
+      #
+      #   @return [Array<Dodopayments::Models::RefundCreateParams::Item>, nil]
+      optional :items,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::RefundCreateParams::Item] },
+               nil?: true
+
       # @!attribute reason
       #   The reason for the refund, if any. Maximum length is 3000 characters. Optional.
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(payment_id:, reason: nil, request_options: {})
+      # @!method initialize(payment_id:, items: nil, reason: nil, request_options: {})
       #   @param payment_id [String] The unique identifier of the payment to be refunded.
       #
+      #   @param items [Array<Dodopayments::Models::RefundCreateParams::Item>, nil] Partially Refund an Individual Item
+      #
       #   @param reason [String, nil] The reason for the refund, if any. Maximum length is 3000 characters. Optional.
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      class Item < Dodopayments::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The id of the item (i.e. `product_id` or `addon_id`)
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute amount
+        #   The amount to refund. if None the whole item is refunded
+        #
+        #   @return [Integer, nil]
+        optional :amount, Integer, nil?: true
+
+        # @!attribute tax_inclusive
+        #   Specify if tax is inclusive of the refund. Default true.
+        #
+        #   @return [Boolean, nil]
+        optional :tax_inclusive, Dodopayments::Internal::Type::Boolean
+
+        # @!method initialize(item_id:, amount: nil, tax_inclusive: nil)
+        #   @param item_id [String] The id of the item (i.e. `product_id` or `addon_id`)
+        #
+        #   @param amount [Integer, nil] The amount to refund. if None the whole item is refunded
+        #
+        #   @param tax_inclusive [Boolean] Specify if tax is inclusive of the refund. Default true.
+      end
     end
   end
 end

data/lib/dodopayments/models/refund_list_params.rb

@@ -11,52 +11,65 @@ module Dodopayments
       #   Get events after this created time
       #
       #   @return [Time, nil]
-      optional :created_at_gte, Time, nil?: true
+      optional :created_at_gte, Time
 
       # @!attribute created_at_lte
       #   Get events created before this time
       #
       #   @return [Time, nil]
-      optional :created_at_lte, Time, nil?: true
+      optional :created_at_lte, Time
 
       # @!attribute customer_id
       #   Filter by customer_id
       #
       #   @return [String, nil]
-      optional :customer_id, String, nil?: true
+      optional :customer_id, String
 
       # @!attribute page_number
       #   Page number default is 0
       #
       #   @return [Integer, nil]
-      optional :page_number, Integer, nil?: true
+      optional :page_number, Integer
 
       # @!attribute page_size
       #   Page size default is 10 max is 100
       #
       #   @return [Integer, nil]
-      optional :page_size, Integer, nil?: true
+      optional :page_size, Integer
 
       # @!attribute status
       #   Filter by status
       #
-      #   @return [Symbol, Dodopayments::Models::RefundStatus, nil]
-      optional :status, enum: -> { Dodopayments::Models::RefundStatus }, nil?: true
+      #   @return [Symbol, Dodopayments::Models::RefundListParams::Status, nil]
+      optional :status, enum: -> { Dodopayments::RefundListParams::Status }
 
       # @!method initialize(created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
-      #   @param created_at_gte [Time, nil] Get events after this created time
+      #   @param created_at_gte [Time] Get events after this created time
       #
-      #   @param created_at_lte [Time, nil] Get events created before this time
+      #   @param created_at_lte [Time] Get events created before this time
       #
-      #   @param customer_id [String, nil] Filter by customer_id
+      #   @param customer_id [String] Filter by customer_id
       #
-      #   @param page_number [Integer, nil] Page number default is 0
+      #   @param page_number [Integer] Page number default is 0
       #
-      #   @param page_size [Integer, nil] Page size default is 10 max is 100
+      #   @param page_size [Integer] Page size default is 10 max is 100
       #
-      #   @param status [Symbol, Dodopayments::Models::RefundStatus, nil] Filter by status
+      #   @param status [Symbol, Dodopayments::Models::RefundListParams::Status] Filter by status
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter by status
+      module Status
+        extend Dodopayments::Internal::Type::Enum
+
+        SUCCEEDED = :succeeded
+        FAILED = :failed
+        PENDING = :pending
+        REVIEW = :review
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/dodopayments/models/subscription.rb

@@ -8,13 +8,19 @@ module Dodopayments
       #   Addons associated with this subscription
       #
       #   @return [Array<Dodopayments::Models::AddonCartResponseItem>]
-      required :addons,
-               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::AddonCartResponseItem] }
+      required :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AddonCartResponseItem] }
 
       # @!attribute billing
+      #   Billing address details for payments
       #
       #   @return [Dodopayments::Models::BillingAddress]
-      required :billing, -> { Dodopayments::Models::BillingAddress }
+      required :billing, -> { Dodopayments::BillingAddress }
+
+      # @!attribute cancel_at_next_billing_date
+      #   Indicates if the subscription will cancel at the next billing date
+      #
+      #   @return [Boolean]
+      required :cancel_at_next_billing_date, Dodopayments::Internal::Type::Boolean
 
       # @!attribute created_at
       #   Timestamp when the subscription was created
@@ -23,16 +29,19 @@ module Dodopayments
       required :created_at, Time
 
       # @!attribute currency
+      #   Currency used for the subscription payments
       #
       #   @return [Symbol, Dodopayments::Models::Currency]
-      required :currency, enum: -> { Dodopayments::Models::Currency }
+      required :currency, enum: -> { Dodopayments::Currency }
 
       # @!attribute customer
+      #   Customer details associated with the subscription
       #
       #   @return [Dodopayments::Models::CustomerLimitedDetails]
-      required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
+      required :customer, -> { Dodopayments::CustomerLimitedDetails }
 
       # @!attribute metadata
+      #   Additional custom data associated with the subscription
       #
       #   @return [Hash{Symbol=>String}]
       required :metadata, Dodopayments::Internal::Type::HashOf[String]
@@ -57,9 +66,10 @@ module Dodopayments
       required :payment_frequency_count, Integer
 
       # @!attribute payment_frequency_interval
+      #   Time interval for payment frequency (e.g. month, year)
       #
       #   @return [Symbol, Dodopayments::Models::TimeInterval]
-      required :payment_frequency_interval, enum: -> { Dodopayments::Models::TimeInterval }
+      required :payment_frequency_interval, enum: -> { Dodopayments::TimeInterval }
 
       # @!attribute previous_billing_date
       #   Timestamp of the last payment. Indicates the start of current billing period
@@ -87,9 +97,10 @@ module Dodopayments
       required :recurring_pre_tax_amount, Integer
 
       # @!attribute status
+      #   Current status of the subscription
       #
       #   @return [Symbol, Dodopayments::Models::SubscriptionStatus]
-      required :status, enum: -> { Dodopayments::Models::SubscriptionStatus }
+      required :status, enum: -> { Dodopayments::SubscriptionStatus }
 
       # @!attribute subscription_id
       #   Unique identifier for the subscription
@@ -104,9 +115,10 @@ module Dodopayments
       required :subscription_period_count, Integer
 
       # @!attribute subscription_period_interval
+      #   Time interval for the subscription period (e.g. month, year)
       #
       #   @return [Symbol, Dodopayments::Models::TimeInterval]
-      required :subscription_period_interval, enum: -> { Dodopayments::Models::TimeInterval }
+      required :subscription_period_interval, enum: -> { Dodopayments::TimeInterval }
 
       # @!attribute tax_inclusive
       #   Indicates if the recurring_pre_tax_amount is tax inclusive
@@ -126,13 +138,19 @@ module Dodopayments
       #   @return [Time, nil]
       optional :cancelled_at, Time, nil?: true
 
+      # @!attribute discount_cycles_remaining
+      #   Number of remaining discount cycles if discount is applied
+      #
+      #   @return [Integer, nil]
+      optional :discount_cycles_remaining, Integer, nil?: true
+
       # @!attribute discount_id
       #   The discount id if discount is applied
       #
       #   @return [String, nil]
       optional :discount_id, String, nil?: true
 
-      # @!method initialize(addons:, billing:, 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_id: nil)
+      # @!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)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Subscription} for more details.
       #
@@ -140,24 +158,25 @@ module Dodopayments
       #
       #   @param addons [Array<Dodopayments::Models::AddonCartResponseItem>] Addons associated with this subscription
       #
-      #   @param billing [Dodopayments::Models::BillingAddress]
+      #   @param billing [Dodopayments::Models::BillingAddress] Billing address details for payments
+      #
+      #   @param cancel_at_next_billing_date [Boolean] Indicates if the subscription will cancel at the next billing date
       #
       #   @param created_at [Time] Timestamp when the subscription was created
       #
-      #   @param currency [Symbol, Dodopayments::Models::Currency]
+      #   @param currency [Symbol, Dodopayments::Models::Currency] Currency used for the subscription payments
       #
-      #   @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #   @param customer [Dodopayments::Models::CustomerLimitedDetails] Customer details associated with the subscription
       #
-      #   @param metadata [Hash{Symbol=>String}]
+      #   @param metadata [Hash{Symbol=>String}] Additional custom data associated with the subscription
       #
       #   @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
       #
       #   @param payment_frequency_count [Integer] Number of payment frequency intervals
       #
-      #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval]
+      #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] Time interval for payment frequency (e.g. month, year)
       #
       #   @param previous_billing_date [Time] Timestamp of the last payment. Indicates the start of current billing period
       #
@@ -166,15 +185,14 @@ module Dodopayments
       #   @param quantity [Integer] Number of units/items included in the subscription
       #
       #   @param recurring_pre_tax_amount [Integer] Amount charged before tax for each recurring payment in smallest currency unit (
-      #   ...
       #
-      #   @param status [Symbol, Dodopayments::Models::SubscriptionStatus]
+      #   @param status [Symbol, Dodopayments::Models::SubscriptionStatus] Current status of the subscription
       #
       #   @param subscription_id [String] Unique identifier for the subscription
       #
       #   @param subscription_period_count [Integer] Number of subscription period intervals
       #
-      #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval]
+      #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] Time interval for the subscription period (e.g. month, year)
       #
       #   @param tax_inclusive [Boolean] Indicates if the recurring_pre_tax_amount is tax inclusive
       #
@@ -182,6 +200,8 @@ module Dodopayments
       #
       #   @param cancelled_at [Time, nil] Cancelled timestamp if the subscription is cancelled
       #
+      #   @param discount_cycles_remaining [Integer, nil] Number of remaining discount cycles if discount is applied
+      #
       #   @param discount_id [String, nil] The discount id if discount is applied
     end
   end