dodopayments 1.22.0 → 1.47.0

data/lib/dodopayments/models/subscription_change_plan_params.rb

@@ -14,10 +14,11 @@ module Dodopayments
       required :product_id, String
 
       # @!attribute proration_billing_mode
+      #   Proration Billing Mode
       #
       #   @return [Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode]
       required :proration_billing_mode,
-               enum: -> { Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode }
+               enum: -> { Dodopayments::SubscriptionChangePlanParams::ProrationBillingMode }
 
       # @!attribute quantity
       #   Number of units to subscribe for. Must be at least 1.
@@ -29,10 +30,8 @@ module Dodopayments
       #   Addons for the new plan. Note : Leaving this empty would remove any existing
       #   addons
       #
-      #   @return [Array<Dodopayments::Models::SubscriptionChangePlanParams::Addon>, nil]
-      optional :addons,
-               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::SubscriptionChangePlanParams::Addon] },
-               nil?: true
+      #   @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: {})
       #   Some parameter documentations has been truncated, see
@@ -40,38 +39,25 @@ module Dodopayments
       #
       #   @param product_id [String] Unique identifier of the product to subscribe to
       #
-      #   @param proration_billing_mode [Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode]
+      #   @param proration_billing_mode [Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode] Proration Billing Mode
       #
       #   @param quantity [Integer] Number of units to subscribe for. Must be at least 1.
       #
-      #   @param addons [Array<Dodopayments::Models::SubscriptionChangePlanParams::Addon>, nil] Addons for the new plan. ...
+      #   @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
+      # Proration Billing Mode
       module ProrationBillingMode
         extend Dodopayments::Internal::Type::Enum
 
         PRORATED_IMMEDIATELY = :prorated_immediately
+        FULL_IMMEDIATELY = :full_immediately
+        DIFFERENCE_IMMEDIATELY = :difference_immediately
 
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      class Addon < Dodopayments::Internal::Type::BaseModel
-        # @!attribute addon_id
-        #
-        #   @return [String]
-        required :addon_id, String
-
-        # @!attribute quantity
-        #
-        #   @return [Integer]
-        required :quantity, Integer
-
-        # @!method initialize(addon_id:, quantity:)
-        #   @param addon_id [String]
-        #   @param quantity [Integer]
-      end
     end
   end
 end

data/lib/dodopayments/models/subscription_charge_params.rb

@@ -14,12 +14,48 @@ module Dodopayments
       #   @return [Integer]
       required :product_price, Integer
 
-      # @!method initialize(product_price:, request_options: {})
+      # @!attribute adaptive_currency_fees_inclusive
+      #   Whether adaptive currency fees should be included in the product_price (true) or
+      #   added on top (false). This field is ignored if adaptive pricing is not enabled
+      #   for the business.
+      #
+      #   @return [Boolean, nil]
+      optional :adaptive_currency_fees_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
+
+      # @!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
+
+      # @!attribute product_currency
+      #   Optional currency of the product price. If not specified, defaults to the
+      #   currency of the product.
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency, nil]
+      optional :product_currency, enum: -> { Dodopayments::Currency }, nil?: true
+
+      # @!attribute product_description
+      #   Optional product description override for billing and line items. If not
+      #   specified, the stored description of the product will be used.
+      #
+      #   @return [String, nil]
+      optional :product_description, String, nil?: true
+
+      # @!method initialize(product_price:, adaptive_currency_fees_inclusive: nil, metadata: nil, product_currency: nil, product_description: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionChargeParams} for more details.
       #
       #   @param product_price [Integer] The product price. Represented in the lowest denomination of the currency (e.g.,
-      #   ...
+      #
+      #   @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the product_price (true) or
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Metadata for the payment. If not passed, the metadata of the subscription will b
+      #
+      #   @param product_currency [Symbol, Dodopayments::Models::Currency, nil] Optional currency of the product price. If not specified, defaults to the curren
+      #
+      #   @param product_description [String, nil] Optional product description override for billing and line items.
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/dodopayments/models/subscription_create_params.rb

@@ -8,14 +8,16 @@ module Dodopayments
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute billing
+      #   Billing address information for the subscription
       #
       #   @return [Dodopayments::Models::BillingAddress]
-      required :billing, -> { Dodopayments::Models::BillingAddress }
+      required :billing, -> { Dodopayments::BillingAddress }
 
       # @!attribute customer
+      #   Customer details for the subscription
       #
-      #   @return [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
-      required :customer, union: -> { Dodopayments::Models::CustomerRequest }
+      #   @return [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer]
+      required :customer, union: -> { Dodopayments::CustomerRequest }
 
       # @!attribute product_id
       #   Unique identifier of the product to subscribe to
@@ -32,10 +34,8 @@ module Dodopayments
       # @!attribute addons
       #   Attach addons to this subscription
       #
-      #   @return [Array<Dodopayments::Models::SubscriptionCreateParams::Addon>, nil]
-      optional :addons,
-               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::SubscriptionCreateParams::Addon] },
-               nil?: true
+      #   @return [Array<Dodopayments::Models::AttachAddon>, nil]
+      optional :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AttachAddon] }, nil?: true
 
       # @!attribute allowed_payment_method_types
       #   List of payment methods allowed during checkout.
@@ -45,15 +45,17 @@ module Dodopayments
       #   Availability still depends on other factors (e.g., customer location, merchant
       #   settings).
       #
-      #   @return [Array<Symbol, Dodopayments::Models::SubscriptionCreateParams::AllowedPaymentMethodType>, nil]
+      #   @return [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil]
       optional :allowed_payment_method_types,
-               -> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::Models::SubscriptionCreateParams::AllowedPaymentMethodType] },
+               -> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::PaymentMethodTypes] },
                nil?: true
 
       # @!attribute billing_currency
+      #   Fix the currency in which the end customer is billed. If Dodo Payments cannot
+      #   support that currency for this transaction, it will not proceed
       #
       #   @return [Symbol, Dodopayments::Models::Currency, nil]
-      optional :billing_currency, enum: -> { Dodopayments::Models::Currency }, nil?: true
+      optional :billing_currency, enum: -> { Dodopayments::Currency }, nil?: true
 
       # @!attribute discount_code
       #   Discount Code to apply to the subscription
@@ -62,6 +64,7 @@ module Dodopayments
       optional :discount_code, String, nil?: true
 
       # @!attribute metadata
+      #   Additional metadata for the subscription Defaults to empty if not specified
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, Dodopayments::Internal::Type::HashOf[String]
@@ -69,7 +72,7 @@ module Dodopayments
       # @!attribute on_demand
       #
       #   @return [Dodopayments::Models::SubscriptionCreateParams::OnDemand, nil]
-      optional :on_demand, -> { Dodopayments::Models::SubscriptionCreateParams::OnDemand }, nil?: true
+      optional :on_demand, -> { Dodopayments::SubscriptionCreateParams::OnDemand }, nil?: true
 
       # @!attribute payment_link
       #   If true, generates a payment link. Defaults to false if not specified.
@@ -107,81 +110,38 @@ module Dodopayments
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionCreateParams} for more details.
       #
-      #   @param billing [Dodopayments::Models::BillingAddress]
+      #   @param billing [Dodopayments::Models::BillingAddress] Billing address information for the subscription
       #
-      #   @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
+      #   @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer] Customer details for the subscription
       #
       #   @param product_id [String] Unique identifier of the product to subscribe to
       #
       #   @param quantity [Integer] Number of units to subscribe for. Must be at least 1.
       #
-      #   @param addons [Array<Dodopayments::Models::SubscriptionCreateParams::Addon>, nil] Attach addons to this subscription
+      #   @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Attach addons to this subscription
       #
-      #   @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::SubscriptionCreateParams::AllowedPaymentMethodType>, nil] List of payment methods allowed during checkout. ...
+      #   @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil] List of payment methods allowed during checkout.
       #
-      #   @param billing_currency [Symbol, Dodopayments::Models::Currency, nil]
+      #   @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] Fix the currency in which the end customer is billed.
       #
       #   @param discount_code [String, nil] Discount Code to apply to the subscription
       #
-      #   @param metadata [Hash{Symbol=>String}]
+      #   @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
       #
       #   @param on_demand [Dodopayments::Models::SubscriptionCreateParams::OnDemand, nil]
       #
-      #   @param payment_link [Boolean, nil] If true, generates a payment link. ...
+      #   @param payment_link [Boolean, nil] If true, generates a payment link.
       #
       #   @param return_url [String, nil] Optional URL to redirect after successful subscription creation
       #
-      #   @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer ...
+      #   @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer
       #
       #   @param tax_id [String, nil] Tax ID in case the payment is B2B. If tax id validation fails the payment creati
-      #   ...
       #
-      #   @param trial_period_days [Integer, nil] Optional trial period in days ...
+      #   @param trial_period_days [Integer, nil] Optional trial period in days
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
-      class Addon < Dodopayments::Internal::Type::BaseModel
-        # @!attribute addon_id
-        #
-        #   @return [String]
-        required :addon_id, String
-
-        # @!attribute quantity
-        #
-        #   @return [Integer]
-        required :quantity, Integer
-
-        # @!method initialize(addon_id:, quantity:)
-        #   @param addon_id [String]
-        #   @param quantity [Integer]
-      end
-
-      module AllowedPaymentMethodType
-        extend Dodopayments::Internal::Type::Enum
-
-        CREDIT = :credit
-        DEBIT = :debit
-        UPI_COLLECT = :upi_collect
-        UPI_INTENT = :upi_intent
-        APPLE_PAY = :apple_pay
-        CASHAPP = :cashapp
-        GOOGLE_PAY = :google_pay
-        MULTIBANCO = :multibanco
-        BANCONTACT_CARD = :bancontact_card
-        EPS = :eps
-        IDEAL = :ideal
-        PRZELEWY24 = :przelewy24
-        AFFIRM = :affirm
-        KLARNA = :klarna
-        SEPA = :sepa
-        ACH = :ach
-        AMAZON_PAY = :amazon_pay
-        AFTERPAY_CLEARPAY = :afterpay_clearpay
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       class OnDemand < Dodopayments::Internal::Type::BaseModel
         # @!attribute mandate_only
         #   If set as True, does not perform any charge and only authorizes payment method
@@ -190,6 +150,28 @@ module Dodopayments
         #   @return [Boolean]
         required :mandate_only, Dodopayments::Internal::Type::Boolean
 
+        # @!attribute adaptive_currency_fees_inclusive
+        #   Whether adaptive currency fees should be included in the product_price (true) or
+        #   added on top (false). This field is ignored if adaptive pricing is not enabled
+        #   for the business.
+        #
+        #   @return [Boolean, nil]
+        optional :adaptive_currency_fees_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
+
+        # @!attribute product_currency
+        #   Optional currency of the product price. If not specified, defaults to the
+        #   currency of the product.
+        #
+        #   @return [Symbol, Dodopayments::Models::Currency, nil]
+        optional :product_currency, enum: -> { Dodopayments::Currency }, nil?: true
+
+        # @!attribute product_description
+        #   Optional product description override for billing and line items. If not
+        #   specified, the stored description of the product will be used.
+        #
+        #   @return [String, nil]
+        optional :product_description, String, nil?: true
+
         # @!attribute product_price
         #   Product price for the initial charge to customer If not specified the stored
         #   price of the product will be used Represented in the lowest denomination of the
@@ -198,14 +180,19 @@ module Dodopayments
         #   @return [Integer, nil]
         optional :product_price, Integer, nil?: true
 
-        # @!method initialize(mandate_only:, product_price: nil)
+        # @!method initialize(mandate_only:, adaptive_currency_fees_inclusive: nil, product_currency: nil, product_description: nil, product_price: nil)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::SubscriptionCreateParams::OnDemand} for more details.
         #
         #   @param mandate_only [Boolean] If set as True, does not perform any charge and only authorizes payment method d
-        #   ...
         #
-        #   @param product_price [Integer, nil] Product price for the initial charge to customer ...
+        #   @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the product_price (true) or
+        #
+        #   @param product_currency [Symbol, Dodopayments::Models::Currency, nil] Optional currency of the product price. If not specified, defaults to the curren
+        #
+        #   @param product_description [String, nil] Optional product description override for billing and line items.
+        #
+        #   @param product_price [Integer, nil] Product price for the initial charge to customer
       end
     end
   end

data/lib/dodopayments/models/subscription_create_response.rb

@@ -8,19 +8,26 @@ 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 customer
+      #   Customer details associated with this subscription
       #
       #   @return [Dodopayments::Models::CustomerLimitedDetails]
-      required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
+      required :customer, -> { Dodopayments::CustomerLimitedDetails }
 
       # @!attribute metadata
+      #   Additional metadata associated with the subscription
       #
       #   @return [Hash{Symbol=>String}]
       required :metadata, Dodopayments::Internal::Type::HashOf[String]
 
+      # @!attribute payment_id
+      #   First payment id for the subscription
+      #
+      #   @return [String]
+      required :payment_id, String
+
       # @!attribute recurring_pre_tax_amount
       #   Tax will be added to the amount and charged to the customer on each billing
       #   cycle
@@ -47,31 +54,40 @@ module Dodopayments
       #   @return [String, nil]
       optional :discount_id, String, nil?: true
 
+      # @!attribute expires_on
+      #   Expiry timestamp of the payment link
+      #
+      #   @return [Time, nil]
+      optional :expires_on, Time, nil?: true
+
       # @!attribute payment_link
       #   URL to checkout page
       #
       #   @return [String, nil]
       optional :payment_link, String, nil?: true
 
-      # @!method initialize(addons:, customer:, metadata:, recurring_pre_tax_amount:, subscription_id:, client_secret: nil, discount_id: nil, payment_link: nil)
+      # @!method initialize(addons:, customer:, metadata:, payment_id:, recurring_pre_tax_amount:, subscription_id:, client_secret: nil, discount_id: nil, expires_on: nil, payment_link: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionCreateResponse} for more details.
       #
       #   @param addons [Array<Dodopayments::Models::AddonCartResponseItem>] Addons associated with this subscription
       #
-      #   @param customer [Dodopayments::Models::CustomerLimitedDetails]
+      #   @param customer [Dodopayments::Models::CustomerLimitedDetails] Customer details associated with this subscription
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional metadata associated with the subscription
       #
-      #   @param metadata [Hash{Symbol=>String}]
+      #   @param payment_id [String] First payment id for the subscription
       #
       #   @param recurring_pre_tax_amount [Integer] Tax will be added to the amount and charged to the customer on each billing cycl
-      #   ...
       #
       #   @param subscription_id [String] Unique identifier for the subscription
       #
-      #   @param client_secret [String, nil] Client secret used to load Dodo checkout SDK ...
+      #   @param client_secret [String, nil] Client secret used to load Dodo checkout SDK
       #
       #   @param discount_id [String, nil] The discount id if discount is applied
       #
+      #   @param expires_on [Time, nil] Expiry timestamp of the payment link
+      #
       #   @param payment_link [String, nil] URL to checkout page
     end
   end

data/lib/dodopayments/models/subscription_list_params.rb

@@ -7,56 +7,79 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute brand_id
+      #   filter by Brand id
+      #
+      #   @return [String, nil]
+      optional :brand_id, String
+
       # @!attribute created_at_gte
       #   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::SubscriptionStatus, nil]
-      optional :status, enum: -> { Dodopayments::Models::SubscriptionStatus }, nil?: true
+      #   @return [Symbol, Dodopayments::Models::SubscriptionListParams::Status, nil]
+      optional :status, enum: -> { Dodopayments::SubscriptionListParams::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
+      # @!method initialize(brand_id: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
+      #   @param brand_id [String] filter by Brand id
+      #
+      #   @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::SubscriptionStatus, nil] Filter by status
+      #   @param status [Symbol, Dodopayments::Models::SubscriptionListParams::Status] Filter by status
       #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter by status
+      module Status
+        extend Dodopayments::Internal::Type::Enum
+
+        PENDING = :pending
+        ACTIVE = :active
+        ON_HOLD = :on_hold
+        CANCELLED = :cancelled
+        FAILED = :failed
+        EXPIRED = :expired
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/dodopayments/models/subscription_list_response.rb

@@ -5,9 +5,16 @@ module Dodopayments
     # @see Dodopayments::Resources::Subscriptions#list
     class SubscriptionListResponse < Dodopayments::Internal::Type::BaseModel
       # @!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
@@ -16,16 +23,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]
@@ -50,9 +60,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
@@ -80,9 +91,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
@@ -97,9 +109,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
@@ -119,36 +132,43 @@ 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(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(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::SubscriptionListResponse} for more details.
       #
       #   Response struct representing subscription details
       #
-      #   @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
       #
@@ -157,15 +177,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
       #
@@ -173,6 +192,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

data/lib/dodopayments/models/subscription_status.rb

@@ -8,7 +8,6 @@ module Dodopayments
       PENDING = :pending
       ACTIVE = :active
       ON_HOLD = :on_hold
-      PAUSED = :paused
       CANCELLED = :cancelled
       FAILED = :failed
       EXPIRED = :expired