dodopayments 2.30.0 → 2.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d255803850b82f08ad10d4dda6adbfc5ed6396443aa10c8bdc7c3e49af841db2
-  data.tar.gz: e73593617cf7f82d97f9e198f517531358cb32bfd0e30064a4c514757229d5fd
+  metadata.gz: 2dd4dba4996639f045859e32a5187ada5f7725cc5c7c0055f800cb2c49935c3f
+  data.tar.gz: a2e9ce7d63c520af95f73a8a4b26318f903973402375e2b7e212e29a11233030
 SHA512:
-  metadata.gz: '0949b3e69763af13e6d63dec5763e9abba82a251dcc1e1d5f4d3e771cd69b19a55d00f1c1a1f2244c54468a03c518b6a12ca0f35fbae84bba786d289ebcaa00b'
-  data.tar.gz: 1af8337dcdf57c984bdc58b3964ab384deb407705acf3a13d5f0d4171cfcb560b3b175c39f532b7791018d947022c393b4228491fe00c702fc6e74b6fd95847d
+  metadata.gz: 262e8aacde3b258e041f3d9b1ad3b6f34d16ef71a5e0c18153c2c2f15248ce381f5c04ff64aa3ee298a94790e93167e3758c7866f0f5c5ea35717243cea20901
+  data.tar.gz: babe2e389f26d85e678383f0a89457a38acd7d5222e29313a1a1117916fc5f9647bef1eb36dc0839f3f38e51b7fd06dbfe2ce69410ee3e8deb303541c9a47789

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [2.32.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.31.0...v2.32.0) (2026-10-06)
+
+
+### Features
+
+* **api:** change-plan cancel_older_payment_link and return_url ([ab42639](https://github.com/dodopayments/dodopayments-ruby/commit/ab42639341e3c3a4595df8792c706ac6cf13d9ce))
+* **api:** change-plan cancel_older_payment_link and return_url ([2b46789](https://github.com/dodopayments/dodopayments-ruby/commit/2b46789c533195890369df6a54daf324b9c689f7))
+
+## [2.31.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.30.0...v2.31.0) (2026-10-05)
+
+
+### Features
+
+* **api:** refund network references and subscription cancelled_by ([356d0ed](https://github.com/dodopayments/dodopayments-ruby/commit/356d0edaaf1e6008268bc6abefe9f2567e8f89ab))
+* **api:** refund network references and subscription cancelled_by ([565e4b2](https://github.com/dodopayments/dodopayments-ruby/commit/565e4b2b7843f206e4f327e421fc000ad7e075df))
+
 ## [2.30.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.29.0...v2.30.0) (2026-09-25)
 
 

data/README.md

@@ -23,7 +23,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "dodopayments", "~> 2.30.0"
+gem "dodopayments", "~> 2.32.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/dodopayments/models/checkout_session_flags.rb

@@ -114,8 +114,10 @@ module Dodopayments
       optional :redirect_immediately, Dodopayments::Internal::Type::Boolean
 
       # @!attribute require_cardholder_name
-      #   If true, the customer must give the name on the card to pay by card. The
-      #   checkout page enforces this. Other payment methods ignore it.
+      #   If true, the customer must give the name on the card to pay by card. Apple Pay
+      #   and Google Pay also collect the payer name, and the payment stores it as the
+      #   card holder name. The checkout page enforces this. Other payment methods ignore
+      #   it.
       #
       #   Default is false
       #

data/lib/dodopayments/models/checkout_session_request.rb

@@ -31,7 +31,14 @@ module Dodopayments
       optional :billing_address, -> { Dodopayments::CheckoutSessionBillingAddress }, nil?: true
 
       # @!attribute billing_currency
-      #   This field is ingored if adaptive pricing is disabled
+      #   The currency to charge the customer in.
+      #
+      #   Adaptive pricing must be enabled for the business. The customer then pays in
+      #   this currency. If you do not set it, the currency comes from the billing
+      #   country.
+      #
+      #   If adaptive pricing is disabled, the API discards this field. The currency then
+      #   comes from the product price, or from the billing country.
       #
       #   @return [Symbol, Dodopayments::Models::Currency, nil]
       optional :billing_currency, enum: -> { Dodopayments::Currency }, nil?: true
@@ -129,8 +136,11 @@ module Dodopayments
       #   If true, only zipcode is required when confirm is true; other address fields
       #   remain optional
       #
+      #   Default is true when `feature_flags.single_page` is true. Otherwise, default is
+      #   false.
+      #
       #   @return [Boolean, nil]
-      optional :minimal_address, Dodopayments::Internal::Type::Boolean
+      optional :minimal_address, Dodopayments::Internal::Type::Boolean, nil?: true
 
       # @!attribute payment_method_id
       #   Optional payment method ID to use for this checkout session. Only allowed when
@@ -185,7 +195,7 @@ module Dodopayments
       #
       #   @param billing_address [Dodopayments::Models::CheckoutSessionBillingAddress, nil] Billing address information for the session
       #
-      #   @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] This field is ingored if adaptive pricing is disabled
+      #   @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] The currency to charge the customer in.
       #
       #   @param cancel_url [String, nil] The URL to redirect the customer if they cancel or go back from the checkout.
       #
@@ -211,7 +221,7 @@ module Dodopayments
       #
       #   @param metadata [Hash{Symbol=>String, Float, Boolean}, nil] Additional metadata associated with the payment. Defaults to empty if not provid
       #
-      #   @param minimal_address [Boolean] If true, only zipcode is required when confirm is true; other address fields rem
+      #   @param minimal_address [Boolean, nil] If true, only zipcode is required when confirm is true; other address fields rem
       #
       #   @param payment_method_id [String, nil] Optional payment method ID to use for this checkout session.
       #

data/lib/dodopayments/models/customers/email_policies.rb

@@ -5,7 +5,8 @@ module Dodopayments
     module Customers
       class EmailPolicies < Dodopayments::Internal::Type::BaseModel
         # @!attribute requires_different_address
-        #   A permanent failure was recorded, so the same address would be a no-op.
+        #   A permanent failure was recorded, so a send to the same address delivers
+        #   nothing. It is false for a suppressed address that a resend can clear.
         #
         #   @return [Boolean]
         required :requires_different_address, Dodopayments::Internal::Type::Boolean
@@ -43,7 +44,7 @@ module Dodopayments
         #   What the merchant may do with one row. The server decides; the client never
         #   derives eligibility itself.
         #
-        #   @param requires_different_address [Boolean] A permanent failure was recorded, so the same address would be a no-op.
+        #   @param requires_different_address [Boolean] A permanent failure was recorded, so a send to the same address delivers
         #
         #   @param resend_allowed [Boolean] The row was delivered and may be sent again.
         #

data/lib/dodopayments/models/refund.rb

@@ -70,13 +70,30 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::Currency, nil]
       optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
 
+      # @!attribute network_reference
+      #   The reference number that the card network or the bank gives to the refund. The
+      #   customer can give this number to their bank to trace the refund. It is null
+      #   until the reference is available.
+      #
+      #   @return [String, nil]
+      optional :network_reference, String, nil?: true
+
+      # @!attribute network_reference_type
+      #   The kind of `network_reference`: ARN, STAN or RRN.
+      #
+      #   @return [Symbol, Dodopayments::Models::RefundNetworkReferenceType, nil]
+      optional :network_reference_type, enum: -> { Dodopayments::RefundNetworkReferenceType }, nil?: true
+
       # @!attribute reason
       #   The reason provided for the refund, if any. Optional.
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(brand_id:, business_id:, created_at:, customer:, is_partial:, metadata:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil)
+      # @!method initialize(brand_id:, business_id:, created_at:, customer:, is_partial:, metadata:, payment_id:, refund_id:, status:, amount: nil, currency: nil, network_reference: nil, network_reference_type: nil, reason: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::Refund} for more details.
+      #
       #   @param brand_id [String] Brand id this refund belongs to
       #
       #   @param business_id [String] The unique identifier of the business issuing the refund.
@@ -99,6 +116,10 @@ module Dodopayments
       #
       #   @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of the refund, represented as an ISO 4217 currency code.
       #
+      #   @param network_reference [String, nil] The reference number that the card network or the bank gives to the refund. The
+      #
+      #   @param network_reference_type [Symbol, Dodopayments::Models::RefundNetworkReferenceType, nil] The kind of `network_reference`: ARN, STAN or RRN.
+      #
       #   @param reason [String, nil] The reason provided for the refund, if any. Optional.
     end
   end

data/lib/dodopayments/models/refund_list_item.rb

@@ -51,13 +51,30 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::Currency, nil]
       optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
 
+      # @!attribute network_reference
+      #   The reference number that the card network or the bank gives to the refund. The
+      #   customer can give this number to their bank to trace the refund. It is null
+      #   until the reference is available.
+      #
+      #   @return [String, nil]
+      optional :network_reference, String, nil?: true
+
+      # @!attribute network_reference_type
+      #   The kind of `network_reference`: ARN, STAN or RRN.
+      #
+      #   @return [Symbol, Dodopayments::Models::RefundNetworkReferenceType, nil]
+      optional :network_reference_type, enum: -> { Dodopayments::RefundNetworkReferenceType }, nil?: true
+
       # @!attribute reason
       #   The reason provided for the refund, if any. Optional.
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(business_id:, created_at:, is_partial:, 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, network_reference: nil, network_reference_type: nil, reason: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::RefundListItem} for more details.
+      #
       #   @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.
@@ -74,6 +91,10 @@ module Dodopayments
       #
       #   @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of the refund, represented as an ISO 4217 currency code.
       #
+      #   @param network_reference [String, nil] The reference number that the card network or the bank gives to the refund. The
+      #
+      #   @param network_reference_type [Symbol, Dodopayments::Models::RefundNetworkReferenceType, nil] The kind of `network_reference`: ARN, STAN or RRN.
+      #
       #   @param reason [String, nil] The reason provided for the refund, if any. Optional.
     end
   end

data/lib/dodopayments/models/refund_network_reference_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # The kind of reference number that the card network or the bank gives to a
+    # refund.
+    module RefundNetworkReferenceType
+      extend Dodopayments::Internal::Type::Enum
+
+      ACQUIRER_REFERENCE_NUMBER = :acquirer_reference_number
+      SYSTEM_TRACE_AUDIT_NUMBER = :system_trace_audit_number
+      RETRIEVAL_REFERENCE_NUMBER = :retrieval_reference_number
+      OTHER = :other
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models/subscription.rb

@@ -183,6 +183,13 @@ module Dodopayments
       #   @return [Time, nil]
       optional :cancelled_at, Time, nil?: true
 
+      # @!attribute cancelled_by
+      #   The caller that cancelled the subscription or scheduled its cancel. `null` when
+      #   no caller is known, for example when the system cancelled the subscription.
+      #
+      #   @return [Dodopayments::Models::SubscriptionCancelledBy, nil]
+      optional :cancelled_by, -> { Dodopayments::SubscriptionCancelledBy }, nil?: true
+
       # @!attribute custom_field_responses
       #   Customer's responses to custom fields collected during checkout
       #
@@ -257,7 +264,7 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :trial_amount, Integer, nil?: true
 
-      # @!method initialize(addons:, billing:, brand_id:, cancel_at_next_billing_date:, created_at:, credit_entitlement_cart:, currency:, customer:, has_payment_method:, metadata:, meter_credit_entitlement_cart:, meters:, 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:, cancellation_comment: nil, cancellation_feedback: nil, cancelled_at: nil, custom_field_responses: nil, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, discounts: nil, expires_at: nil, paused_at: nil, payment_method_id: nil, scheduled_change: nil, tax_id: nil, trial_amount: nil)
+      # @!method initialize(addons:, billing:, brand_id:, cancel_at_next_billing_date:, created_at:, credit_entitlement_cart:, currency:, customer:, has_payment_method:, metadata:, meter_credit_entitlement_cart:, meters:, 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:, cancellation_comment: nil, cancellation_feedback: nil, cancelled_at: nil, cancelled_by: nil, custom_field_responses: nil, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, discounts: nil, expires_at: nil, paused_at: nil, payment_method_id: nil, scheduled_change: nil, tax_id: nil, trial_amount: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Subscription} for more details.
       #
@@ -321,6 +328,8 @@ module Dodopayments
       #
       #   @param cancelled_at [Time, nil] Cancelled timestamp if the subscription is cancelled
       #
+      #   @param cancelled_by [Dodopayments::Models::SubscriptionCancelledBy, nil] The caller that cancelled the subscription or scheduled its cancel.
+      #
       #   @param custom_field_responses [Array<Dodopayments::Models::CustomFieldResponse>, nil] Customer's responses to custom fields collected during checkout
       #
       #   @param customer_business_name [String, nil] Business / legal name associated with the tax id (B2B). When set this is

data/lib/dodopayments/models/subscription_cancelled_by.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class SubscriptionCancelledBy < Dodopayments::Internal::Type::BaseModel
+      # @!attribute actor_type
+      #   The kind of caller.
+      #
+      #   @return [Symbol, Dodopayments::Models::SubscriptionCancelledBy::ActorType]
+      required :actor_type, enum: -> { Dodopayments::SubscriptionCancelledBy::ActorType }
+
+      # @!attribute email
+      #   Email of the customer or of the dashboard user. `null` for an API key or the
+      #   Dodo Payments team.
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute name
+      #   Name of the customer or of the dashboard user. `null` for an API key or the Dodo
+      #   Payments team.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!method initialize(actor_type:, email: nil, name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionCancelledBy} for more details.
+      #
+      #   The caller that cancelled a subscription or scheduled its cancel.
+      #
+      #   @param actor_type [Symbol, Dodopayments::Models::SubscriptionCancelledBy::ActorType] The kind of caller.
+      #
+      #   @param email [String, nil] Email of the customer or of the dashboard user. `null` for an API key
+      #
+      #   @param name [String, nil] Name of the customer or of the dashboard user. `null` for an API key
+
+      # The kind of caller.
+      #
+      # @see Dodopayments::Models::SubscriptionCancelledBy#actor_type
+      module ActorType
+        extend Dodopayments::Internal::Type::Enum
+
+        CUSTOMER = :customer
+        MERCHANT_USER = :merchant_user
+        API_KEY = :api_key
+        DODO_TEAM = :dodo_team
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/subscription_list_response.rb

@@ -146,6 +146,13 @@ module Dodopayments
       #   @return [Time, nil]
       optional :cancelled_at, Time, nil?: true
 
+      # @!attribute cancelled_by
+      #   The caller that cancelled the subscription or scheduled its cancel. `null` when
+      #   no caller is known, for example when the system cancelled the subscription.
+      #
+      #   @return [Dodopayments::Models::SubscriptionCancelledBy, nil]
+      optional :cancelled_by, -> { Dodopayments::SubscriptionCancelledBy }, nil?: true
+
       # @!attribute customer_business_name
       #   Business / legal name associated with the tax id (B2B). When set this is used on
       #   the invoice in place of the customer's personal name.
@@ -204,7 +211,7 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :trial_amount, Integer, nil?: true
 
-      # @!method initialize(billing:, cancel_at_next_billing_date:, created_at:, currency:, customer:, discounts:, has_payment_method:, 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, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, paused_at: nil, payment_method_id: nil, product_name: nil, scheduled_change: nil, tax_id: nil, trial_amount: nil)
+      # @!method initialize(billing:, cancel_at_next_billing_date:, created_at:, currency:, customer:, discounts:, has_payment_method:, 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, cancelled_by: nil, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, paused_at: nil, payment_method_id: nil, product_name: nil, scheduled_change: nil, tax_id: nil, trial_amount: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::SubscriptionListResponse} for more details.
       #
@@ -256,6 +263,8 @@ module Dodopayments
       #
       #   @param cancelled_at [Time, nil] Cancelled timestamp if the subscription is cancelled
       #
+      #   @param cancelled_by [Dodopayments::Models::SubscriptionCancelledBy, nil] The caller that cancelled the subscription or scheduled its cancel.
+      #
       #   @param customer_business_name [String, nil] Business / legal name associated with the tax id (B2B). When set this is
       #
       #   @param discount_cycles_remaining [Integer, nil] DEPRECATED: Use discounts[].cycles_remaining instead.

data/lib/dodopayments/models/subscription_preview_change_plan_response.rb

@@ -325,15 +325,24 @@ module Dodopayments
           required :currency, enum: -> { Dodopayments::Currency }
 
           # @!attribute customer_credits
-          #   Net credit movement in the smallest currency unit (e.g. cents). **Negative** –
-          #   credits were deducted from the customer's balance to offset the charge (typical
-          #   on upgrades). **Positive** – credits were added to the customer's balance,
-          #   either from a downgrade proration refund or from topping-up the wallet to meet a
-          #   gateway minimum-charge threshold. **Zero** – no credit movement occurred.
+          #   Net credit movement in the smallest unit of `customer_credits_currency` (e.g.
+          #   cents). Read `customer_credits_currency` for the currency. It can differ from
+          #   `currency`. **Negative** – credits were deducted from the customer's balance to
+          #   offset the charge (typical on upgrades). **Positive** – credits were added to
+          #   the customer's balance, either from a downgrade proration refund or from
+          #   topping-up the wallet to meet a gateway minimum-charge threshold. **Zero** – no
+          #   credit movement occurred.
           #
           #   @return [Integer]
           required :customer_credits, Integer
 
+          # @!attribute customer_credits_currency
+          #   This field gives the currency of `customer_credits`. The credit wallet uses the
+          #   subscription currency.
+          #
+          #   @return [Symbol, Dodopayments::Models::Currency]
+          required :customer_credits_currency, enum: -> { Dodopayments::Currency }
+
           # @!attribute settlement_amount
           #
           #   @return [Integer]
@@ -359,14 +368,16 @@ module Dodopayments
           #   @return [Integer, nil]
           optional :tax, Integer, nil?: true
 
-          # @!method initialize(currency:, customer_credits:, settlement_amount:, settlement_currency:, total_amount:, settlement_tax: nil, tax: nil)
+          # @!method initialize(currency:, customer_credits:, customer_credits_currency:, settlement_amount:, settlement_currency:, total_amount:, settlement_tax: nil, tax: nil)
           #   Some parameter documentations has been truncated, see
           #   {Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::Summary}
           #   for more details.
           #
           #   @param currency [Symbol, Dodopayments::Models::Currency]
           #
-          #   @param customer_credits [Integer] Net credit movement in the smallest currency unit (e.g. cents).
+          #   @param customer_credits [Integer] Net credit movement in the smallest unit of `customer_credits_currency` (e.g. ce
+          #
+          #   @param customer_credits_currency [Symbol, Dodopayments::Models::Currency] This field gives the currency of `customer_credits`.
           #
           #   @param settlement_amount [Integer]
           #

data/lib/dodopayments/models/update_subscription_plan_req.rb

@@ -36,6 +36,23 @@ module Dodopayments
       #   @return [Array<Dodopayments::Models::AttachAddon>, nil]
       optional :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AttachAddon] }, nil?: true
 
+      # @!attribute cancel_older_payment_link
+      #   Cancel the payment link of a pending plan change, so that this change can
+      #   replace it.
+      #
+      #   The link is cancelled only if the customer has not started to pay. A paid or
+      #   in-progress payment gives a `409`. A failed cancel gives a `503`, and a retry is
+      #   safe.
+      #
+      #   The request is validated before the cancel. A later failure, for example an
+      #   amount below the minimum, leaves the subscription on its current plan with no
+      #   open link. A retry is safe.
+      #
+      #   The preview route shares this request body and ignores this field.
+      #
+      #   @return [Boolean, nil]
+      optional :cancel_older_payment_link, Dodopayments::Internal::Type::Boolean
+
       # @!attribute cancel_scheduled_change_plan
       #   Replace a scheduled plan change with this one.
       #
@@ -116,7 +133,22 @@ module Dodopayments
                enum: -> { Dodopayments::UpdateSubscriptionPlanReq::OnPaymentFailure },
                nil?: true
 
-      # @!method initialize(product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, cancel_scheduled_change_plan: nil, collect_via_payment_link: nil, discount_code: nil, discount_codes: nil, effective_at: nil, metadata: nil, on_payment_failure: nil)
+      # @!attribute return_url
+      #   The URL that receives the customer after they pay the payment link. Needs
+      #   `collect_via_payment_link: true`. Without it, the request gets a `422`. A change
+      #   that collects no money issues no link and does not use the URL. The preview
+      #   route validates this field but does not use it.
+      #
+      #   The redirect adds `subscription_id`, `payment_id` and `status`. The `status`
+      #   value is the status of the plan-change payment. It is not the status of the
+      #   subscription. When that payment fails, the subscription stays active on its
+      #   current plan. To try again, call this endpoint again to get a new link. The new
+      #   plan can apply after the redirect, when the payment webhook arrives.
+      #
+      #   @return [String, nil]
+      optional :return_url, String, nil?: true
+
+      # @!method initialize(product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, cancel_older_payment_link: nil, cancel_scheduled_change_plan: nil, collect_via_payment_link: nil, discount_code: nil, discount_codes: nil, effective_at: nil, metadata: nil, on_payment_failure: nil, return_url: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::UpdateSubscriptionPlanReq} for more details.
       #
@@ -130,6 +162,8 @@ module Dodopayments
       #
       #   @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
+      #   @param cancel_older_payment_link [Boolean] Cancel the payment link of a pending plan change, so that this change
+      #
       #   @param cancel_scheduled_change_plan [Boolean] Replace a scheduled plan change with this one.
       #
       #   @param collect_via_payment_link [Boolean] Collect the plan-change amount with a payment link. The customer then
@@ -143,6 +177,8 @@ module Dodopayments
       #   @param metadata [Hash{Symbol=>String, Float, Boolean}, nil] Metadata for the payment. If not passed, the metadata of the subscription will b
       #
       #   @param on_payment_failure [Symbol, Dodopayments::Models::UpdateSubscriptionPlanReq::OnPaymentFailure, nil] Controls behavior when the plan change payment fails.
+      #
+      #   @param return_url [String, nil] The URL that receives the customer after they pay the payment link.
 
       # Proration Billing Mode
       #

data/lib/dodopayments/models.rb

@@ -462,6 +462,8 @@ module Dodopayments
 
   RefundListParams = Dodopayments::Models::RefundListParams
 
+  RefundNetworkReferenceType = Dodopayments::Models::RefundNetworkReferenceType
+
   RefundRetrieveParams = Dodopayments::Models::RefundRetrieveParams
 
   RefundStatus = Dodopayments::Models::RefundStatus
@@ -476,6 +478,8 @@ module Dodopayments
 
   SubscriptionCancelChangePlanParams = Dodopayments::Models::SubscriptionCancelChangePlanParams
 
+  SubscriptionCancelledBy = Dodopayments::Models::SubscriptionCancelledBy
+
   SubscriptionCancelledWebhookEvent = Dodopayments::Models::SubscriptionCancelledWebhookEvent
 
   SubscriptionChangePlanParams = Dodopayments::Models::SubscriptionChangePlanParams

data/lib/dodopayments/resources/checkout_sessions.rb

@@ -14,7 +14,7 @@ module Dodopayments
       #
       # @param billing_address [Dodopayments::Models::CheckoutSessionBillingAddress, nil] Billing address information for the session
       #
-      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] This field is ingored if adaptive pricing is disabled
+      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] The currency to charge the customer in.
       #
       # @param cancel_url [String, nil] The URL to redirect the customer if they cancel or go back from the checkout.
       #
@@ -40,7 +40,7 @@ module Dodopayments
       #
       # @param metadata [Hash{Symbol=>String, Float, Boolean}, nil] Additional metadata associated with the payment. Defaults to empty if not provid
       #
-      # @param minimal_address [Boolean] If true, only zipcode is required when confirm is true; other address fields rem
+      # @param minimal_address [Boolean, nil] If true, only zipcode is required when confirm is true; other address fields rem
       #
       # @param payment_method_id [String, nil] Optional payment method ID to use for this checkout session.
       #
@@ -101,7 +101,7 @@ module Dodopayments
       #
       # @param billing_address [Dodopayments::Models::CheckoutSessionBillingAddress, nil] Billing address information for the session
       #
-      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] This field is ingored if adaptive pricing is disabled
+      # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] The currency to charge the customer in.
       #
       # @param cancel_url [String, nil] The URL to redirect the customer if they cancel or go back from the checkout.
       #
@@ -127,7 +127,7 @@ module Dodopayments
       #
       # @param metadata [Hash{Symbol=>String, Float, Boolean}, nil] Additional metadata associated with the payment. Defaults to empty if not provid
       #
-      # @param minimal_address [Boolean] If true, only zipcode is required when confirm is true; other address fields rem
+      # @param minimal_address [Boolean, nil] If true, only zipcode is required when confirm is true; other address fields rem
       #
       # @param payment_method_id [String, nil] Optional payment method ID to use for this checkout session.
       #

data/lib/dodopayments/resources/subscriptions.rb

@@ -209,7 +209,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionChangePlanParams} for more details.
       #
-      # @overload change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, cancel_scheduled_change_plan: nil, collect_via_payment_link: nil, discount_code: nil, discount_codes: nil, effective_at: nil, metadata: nil, on_payment_failure: nil, request_options: {})
+      # @overload change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, cancel_older_payment_link: nil, cancel_scheduled_change_plan: nil, collect_via_payment_link: nil, discount_code: nil, discount_codes: nil, effective_at: nil, metadata: nil, on_payment_failure: nil, return_url: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -223,6 +223,8 @@ module Dodopayments
       #
       # @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
+      # @param cancel_older_payment_link [Boolean] Cancel the payment link of a pending plan change, so that this change
+      #
       # @param cancel_scheduled_change_plan [Boolean] Replace a scheduled plan change with this one.
       #
       # @param collect_via_payment_link [Boolean] Collect the plan-change amount with a payment link. The customer then
@@ -237,6 +239,8 @@ module Dodopayments
       #
       # @param on_payment_failure [Symbol, Dodopayments::Models::UpdateSubscriptionPlanReq::OnPaymentFailure, nil] Controls behavior when the plan change payment fails.
       #
+      # @param return_url [String, nil] The URL that receives the customer after they pay the payment link.
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::SubscriptionChangePlanResponse]
@@ -291,7 +295,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionPreviewChangePlanParams} for more details.
       #
-      # @overload preview_change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, cancel_scheduled_change_plan: nil, collect_via_payment_link: nil, discount_code: nil, discount_codes: nil, effective_at: nil, metadata: nil, on_payment_failure: nil, request_options: {})
+      # @overload preview_change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, cancel_older_payment_link: nil, cancel_scheduled_change_plan: nil, collect_via_payment_link: nil, discount_code: nil, discount_codes: nil, effective_at: nil, metadata: nil, on_payment_failure: nil, return_url: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -305,6 +309,8 @@ module Dodopayments
       #
       # @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
+      # @param cancel_older_payment_link [Boolean] Cancel the payment link of a pending plan change, so that this change
+      #
       # @param cancel_scheduled_change_plan [Boolean] Replace a scheduled plan change with this one.
       #
       # @param collect_via_payment_link [Boolean] Collect the plan-change amount with a payment link. The customer then
@@ -319,6 +325,8 @@ module Dodopayments
       #
       # @param on_payment_failure [Symbol, Dodopayments::Models::UpdateSubscriptionPlanReq::OnPaymentFailure, nil] Controls behavior when the plan change payment fails.
       #
+      # @param return_url [String, nil] The URL that receives the customer after they pay the payment link.
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::SubscriptionPreviewChangePlanResponse]

data/lib/dodopayments/version.rb

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

data/lib/dodopayments.rb

@@ -361,12 +361,14 @@ require_relative "dodopayments/models/refund_create_params"
 require_relative "dodopayments/models/refund_failed_webhook_event"
 require_relative "dodopayments/models/refund_list_item"
 require_relative "dodopayments/models/refund_list_params"
+require_relative "dodopayments/models/refund_network_reference_type"
 require_relative "dodopayments/models/refund_retrieve_params"
 require_relative "dodopayments/models/refund_status"
 require_relative "dodopayments/models/refund_succeeded_webhook_event"
 require_relative "dodopayments/models/scheduled_plan_change"
 require_relative "dodopayments/models/subscription_active_webhook_event"
 require_relative "dodopayments/models/subscription_cancel_change_plan_params"
+require_relative "dodopayments/models/subscription_cancelled_by"
 require_relative "dodopayments/models/subscription_cancelled_webhook_event"
 require_relative "dodopayments/models/subscription_change_plan_params"
 require_relative "dodopayments/models/subscription_change_plan_response"

data/rbi/dodopayments/models/checkout_session_flags.rbi

@@ -137,8 +137,10 @@ module Dodopayments
       sig { params(redirect_immediately: T::Boolean).void }
       attr_writer :redirect_immediately
 
-      # If true, the customer must give the name on the card to pay by card. The
-      # checkout page enforces this. Other payment methods ignore it.
+      # If true, the customer must give the name on the card to pay by card. Apple Pay
+      # and Google Pay also collect the payer name, and the payment stores it as the
+      # card holder name. The checkout page enforces this. Other payment methods ignore
+      # it.
       #
       # Default is false
       sig { returns(T.nilable(T::Boolean)) }
@@ -256,8 +258,10 @@ module Dodopayments
         #
         # Default is false
         redirect_immediately: nil,
-        # If true, the customer must give the name on the card to pay by card. The
-        # checkout page enforces this. Other payment methods ignore it.
+        # If true, the customer must give the name on the card to pay by card. Apple Pay
+        # and Google Pay also collect the payer name, and the payment stores it as the
+        # card holder name. The checkout page enforces this. Other payment methods ignore
+        # it.
         #
         # Default is false
         require_cardholder_name: nil,