dodopayments 2.24.0 → 2.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54faa371ee06087dd998ac36184e28534d52955c484830b985ef33041c1be2ef
-  data.tar.gz: a3033cc80faf66427ae2dbbd42f326580702550236eeac8f672b12e85de156fd
+  metadata.gz: e8b7cafc248338a4ade0c7286d952538e01a9bf5d37c8055a00334dcadf4f704
+  data.tar.gz: f09302d55a6bb456e7be074623b1028461b3f2a06be0a473c20861ef5ee72009
 SHA512:
-  metadata.gz: 51fcd5e514a4b8042240d297815f2857357d42344a60a9b157a6226f93dc5850d421fc560386ced09ec4b351fe0ea4daa685dc7d91dbc8a781bbd1471fcd75c8
-  data.tar.gz: f55ccbebdd5c52348a75c2ff069352e5eef4b46e7898cd8401b166ffa7881ef4b387a71fa6f13902ece22d5f4dda4b20e39dfd05787ec2f4c912b7d58e8bb6ad
+  metadata.gz: e1eb4476c66201ce9fcc8f9c64604d33fa1f725f48f267683559a73657bf36f6a9572a8ae45290f3f0a92a2eb939e5fd30eecd7e6067d92d76196774cd24b3d5
+  data.tar.gz: 1a5f5a769335be408661bd207290c2c54f0cc8a93f8df439566d7cc49b2b643b2a84319f933ba7892fb0bf0f17733f7ec899c5ce0e42b3dffb289dc1c5d28475

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [2.26.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.25.0...v2.26.0) (2026-08-24)
+
+
+### Features
+
+* **api:** return checkout handles from subscription change-plan ([2214ac1](https://github.com/dodopayments/dodopayments-ruby/commit/2214ac15c534b4f0f0dd3bd99b54d7ea3a902ef1))
+* **api:** return checkout handles from subscription change-plan ([33a5304](https://github.com/dodopayments/dodopayments-ruby/commit/33a5304d28904f9cb0d6bfc3e60a4765925c308a))
+
+## [2.25.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.24.0...v2.25.0) (2026-08-17)
+
+
+### Features
+
+* **api:** add brand archive endpoint ([ccc5fc9](https://github.com/dodopayments/dodopayments-ruby/commit/ccc5fc9c61410ac28010e98cc241ab8eb471cb72))
+* **api:** add brand archive endpoint ([90fc52d](https://github.com/dodopayments/dodopayments-ruby/commit/90fc52df5e05849e2dfdd5b307ea2ff34edb050e))
+
 ## [2.24.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.23.0...v2.24.0) (2026-08-13)
 
 

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.24.0"
+gem "dodopayments", "~> 2.26.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/dodopayments/models/brand.rb

@@ -34,6 +34,12 @@ module Dodopayments
       #   @return [Symbol, Dodopayments::Models::Brand::VerificationStatus]
       required :verification_status, enum: -> { Dodopayments::Brand::VerificationStatus }
 
+      # @!attribute archived_at
+      #   Time the brand was archived. Null for an active brand.
+      #
+      #   @return [Time, nil]
+      optional :archived_at, Time, nil?: true
+
       # @!attribute description
       #
       #   @return [String, nil]
@@ -65,7 +71,7 @@ module Dodopayments
       #   @return [String, nil]
       optional :url, String, nil?: true
 
-      # @!method initialize(brand_id:, business_id:, enabled:, statement_descriptor:, verification_enabled:, verification_status:, description: nil, image: nil, name: nil, reason_for_hold: nil, support_email: nil, url: nil)
+      # @!method initialize(brand_id:, business_id:, enabled:, statement_descriptor:, verification_enabled:, verification_status:, archived_at: nil, description: nil, image: nil, name: nil, reason_for_hold: nil, support_email: nil, url: nil)
       #   @param brand_id [String]
       #
       #   @param business_id [String]
@@ -78,6 +84,8 @@ module Dodopayments
       #
       #   @param verification_status [Symbol, Dodopayments::Models::Brand::VerificationStatus]
       #
+      #   @param archived_at [Time, nil] Time the brand was archived. Null for an active brand.
+      #
       #   @param description [String, nil]
       #
       #   @param image [String, nil]

data/lib/dodopayments/models/brand_archive_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#archive
+    class BrandArchiveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute move_products_to
+      #   Brand that takes over the products and the live subscriptions of the brand you
+      #   archive. It must be a brand of the same business, and it must not be archived.
+      #   The primary brand (its brand id is the business id) is a valid target. Omit this
+      #   field only when the brand holds no products and no live subscriptions.
+      #
+      #   @return [String, nil]
+      optional :move_products_to, String, nil?: true
+
+      # @!method initialize(id:, move_products_to: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::BrandArchiveParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param move_products_to [String, nil] Brand that takes over the products and the live subscriptions of the
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/brand_archive_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#archive
+    class BrandArchiveResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute archived_at
+      #   Time the brand was archived.
+      #
+      #   @return [Time]
+      required :archived_at, Time
+
+      # @!attribute brand_id
+      #   The archived brand.
+      #
+      #   @return [String]
+      required :brand_id, String
+
+      # @!attribute collections_moved
+      #   Count of product collections moved to the target brand.
+      #
+      #   @return [Integer]
+      required :collections_moved, Integer
+
+      # @!attribute products_moved
+      #   Count of products moved to the target brand.
+      #
+      #   @return [Integer]
+      required :products_moved, Integer
+
+      # @!attribute subscriptions_moved
+      #   Count of live subscriptions moved to the target brand.
+      #
+      #   @return [Integer]
+      required :subscriptions_moved, Integer
+
+      # @!attribute moved_to_brand_id
+      #   Brand that received the moved records. Null when no target was given.
+      #
+      #   @return [String, nil]
+      optional :moved_to_brand_id, String, nil?: true
+
+      # @!method initialize(archived_at:, brand_id:, collections_moved:, products_moved:, subscriptions_moved:, moved_to_brand_id: nil)
+      #   @param archived_at [Time] Time the brand was archived.
+      #
+      #   @param brand_id [String] The archived brand.
+      #
+      #   @param collections_moved [Integer] Count of product collections moved to the target brand.
+      #
+      #   @param products_moved [Integer] Count of products moved to the target brand.
+      #
+      #   @param subscriptions_moved [Integer] Count of live subscriptions moved to the target brand.
+      #
+      #   @param moved_to_brand_id [String, nil] Brand that received the moved records. Null when no target was given.
+    end
+  end
+end

data/lib/dodopayments/models/brand_list_params.rb

@@ -7,7 +7,15 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute include_archived
+      #   Set to true to also list archived brands. Default false.
+      #
+      #   @return [Boolean, nil]
+      optional :include_archived, Dodopayments::Internal::Type::Boolean
+
+      # @!method initialize(include_archived: nil, request_options: {})
+      #   @param include_archived [Boolean] Set to true to also list archived brands. Default false.
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/checkout_session_flags.rb

@@ -122,7 +122,17 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :require_phone_number, Dodopayments::Internal::Type::Boolean
 
-      # @!method initialize(allow_currency_selection: nil, allow_customer_editing_business_name: nil, allow_customer_editing_city: nil, allow_customer_editing_country: nil, allow_customer_editing_email: nil, allow_customer_editing_name: nil, allow_customer_editing_state: nil, allow_customer_editing_street: nil, allow_customer_editing_tax_id: nil, allow_customer_editing_zipcode: nil, allow_discount_code: nil, allow_editing_addons: nil, allow_phone_number_collection: nil, allow_tax_id: nil, always_create_new_customer: nil, redirect_immediately: nil, require_phone_number: nil)
+      # @!attribute single_page
+      #   If true, the session uses the single-page checkout flow: the page initializes
+      #   the payment at load time and confirms it in place, with no separate payment
+      #   page.
+      #
+      #   Default is false
+      #
+      #   @return [Boolean, nil]
+      optional :single_page, Dodopayments::Internal::Type::Boolean
+
+      # @!method initialize(allow_currency_selection: nil, allow_customer_editing_business_name: nil, allow_customer_editing_city: nil, allow_customer_editing_country: nil, allow_customer_editing_email: nil, allow_customer_editing_name: nil, allow_customer_editing_state: nil, allow_customer_editing_street: nil, allow_customer_editing_tax_id: nil, allow_customer_editing_zipcode: nil, allow_discount_code: nil, allow_editing_addons: nil, allow_phone_number_collection: nil, allow_tax_id: nil, always_create_new_customer: nil, redirect_immediately: nil, require_phone_number: nil, single_page: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::CheckoutSessionFlags} for more details.
       #
@@ -159,6 +169,8 @@ module Dodopayments
       #   @param redirect_immediately [Boolean] If true, redirects the customer immediately after payment completion
       #
       #   @param require_phone_number [Boolean] If true, the customer must provide a phone number to complete checkout.
+      #
+      #   @param single_page [Boolean] If true, the session uses the single-page checkout flow: the page
     end
   end
 end

data/lib/dodopayments/models/entitlements/license_key_grant.rb

@@ -4,8 +4,15 @@ module Dodopayments
   module Models
     module Entitlements
       class LicenseKeyGrant < Dodopayments::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifier of the issued license key.
+        #
+        #   @return [String]
+        required :id, String
+
         # @!attribute activations_used
-        #   Number of activations consumed so far.
+        #   Number of instances currently active. Activation increments it and deactivation
+        #   decrements it, so it is a live count and not a total.
         #
         #   @return [Integer]
         required :activations_used, Integer
@@ -16,6 +23,13 @@ module Dodopayments
         #   @return [String]
         required :key, String
 
+        # @!attribute status
+        #   Current status of the license key. Activation fails unless it is `active`, so a
+        #   client can warn before the customer tries.
+        #
+        #   @return [Symbol, Dodopayments::Models::LicenseKeyStatus]
+        required :status, enum: -> { Dodopayments::LicenseKeyStatus }
+
         # @!attribute activations_limit
         #   Maximum activations allowed by the entitlement, when set.
         #
@@ -28,14 +42,21 @@ module Dodopayments
         #   @return [Time, nil]
         optional :expires_at, Time, nil?: true
 
-        # @!method initialize(activations_used:, key:, activations_limit: nil, expires_at: nil)
+        # @!method initialize(id:, activations_used:, key:, status:, activations_limit: nil, expires_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Entitlements::LicenseKeyGrant} for more details.
+        #
         #   License-key delivery payload, present on grants for `license_key` entitlements.
         #   The grant's top-level `status` is the source of truth for the grant's lifecycle.
         #
-        #   @param activations_used [Integer] Number of activations consumed so far.
+        #   @param id [String] Identifier of the issued license key.
+        #
+        #   @param activations_used [Integer] Number of instances currently active. Activation increments it and
         #
         #   @param key [String] Issued license key.
         #
+        #   @param status [Symbol, Dodopayments::Models::LicenseKeyStatus] Current status of the license key. Activation fails unless it is
+        #
         #   @param activations_limit [Integer, nil] Maximum activations allowed by the entitlement, when set.
         #
         #   @param expires_at [Time, nil] When the license key expires, when applicable.

data/lib/dodopayments/models/price.rb

@@ -40,13 +40,6 @@ module Dodopayments
         #   @return [Integer]
         required :price, Integer
 
-        # @!attribute purchasing_power_parity
-        #   Indicates if purchasing power parity adjustments are applied to the price.
-        #   Purchasing power parity feature is not available as of now.
-        #
-        #   @return [Boolean]
-        required :purchasing_power_parity, Dodopayments::Internal::Type::Boolean
-
         # @!attribute type
         #
         #   @return [Symbol, :one_time_price]
@@ -59,6 +52,14 @@ module Dodopayments
         #   @return [Boolean, nil]
         optional :pay_what_you_want, Dodopayments::Internal::Type::Boolean
 
+        # @!attribute purchasing_power_parity
+        #   Opts this price in to purchasing power parity. The business must also enable
+        #   purchasing power parity. The discount percentage per country is always
+        #   business-wide. Defaults to `false`.
+        #
+        #   @return [Boolean, nil]
+        optional :purchasing_power_parity, Dodopayments::Internal::Type::Boolean
+
         # @!attribute suggested_price
         #   A suggested price for the user to pay. This value is only considered if
         #   [`pay_what_you_want`](Self::pay_what_you_want) is `true`. Otherwise, it is
@@ -73,7 +74,7 @@ module Dodopayments
         #   @return [Boolean, nil]
         optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(currency:, discount:, price:, purchasing_power_parity:, pay_what_you_want: nil, suggested_price: nil, tax_inclusive: nil, type: :one_time_price)
+        # @!method initialize(currency:, discount:, price:, pay_what_you_want: nil, purchasing_power_parity: nil, suggested_price: nil, tax_inclusive: nil, type: :one_time_price)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Price::OneTimePrice} for more details.
         #
@@ -85,10 +86,10 @@ module Dodopayments
         #
         #   @param price [Integer] The payment amount, in the smallest denomination of the currency (e.g., cents fo
         #
-        #   @param purchasing_power_parity [Boolean] Indicates if purchasing power parity adjustments are applied to the price.
-        #
         #   @param pay_what_you_want [Boolean] Indicates whether the customer can pay any amount they choose.
         #
+        #   @param purchasing_power_parity [Boolean] Opts this price in to purchasing power parity. The business must also
+        #
         #   @param suggested_price [Integer, nil] A suggested price for the user to pay. This value is only considered if
         #
         #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive.
@@ -129,13 +130,6 @@ module Dodopayments
         #   @return [Integer]
         required :price, Integer
 
-        # @!attribute purchasing_power_parity
-        #   Indicates if purchasing power parity adjustments are applied to the price.
-        #   Purchasing power parity feature is not available as of now
-        #
-        #   @return [Boolean]
-        required :purchasing_power_parity, Dodopayments::Internal::Type::Boolean
-
         # @!attribute subscription_period_count
         #   Number of units for the subscription period. For example, a value of `12` with a
         #   `subscription_period_interval` of `month` represents a one-year subscription.
@@ -154,6 +148,14 @@ module Dodopayments
         #   @return [Symbol, :recurring_price]
         required :type, const: :recurring_price
 
+        # @!attribute purchasing_power_parity
+        #   Opts this price in to purchasing power parity. The business must also enable
+        #   purchasing power parity. The discount percentage per country is always
+        #   business-wide. Defaults to `false`.
+        #
+        #   @return [Boolean, nil]
+        optional :purchasing_power_parity, Dodopayments::Internal::Type::Boolean
+
         # @!attribute tax_inclusive
         #   Indicates if the price is tax inclusive
         #
@@ -180,7 +182,7 @@ module Dodopayments
         #   @return [Integer, nil]
         optional :trial_period_days, Integer
 
-        # @!method initialize(currency:, discount:, payment_frequency_count:, payment_frequency_interval:, price:, purchasing_power_parity:, subscription_period_count:, subscription_period_interval:, tax_inclusive: nil, trial_amount: nil, trial_apply_discounts: nil, trial_period_days: nil, type: :recurring_price)
+        # @!method initialize(currency:, discount:, payment_frequency_count:, payment_frequency_interval:, price:, subscription_period_count:, subscription_period_interval:, purchasing_power_parity: nil, tax_inclusive: nil, trial_amount: nil, trial_apply_discounts: nil, trial_period_days: nil, type: :recurring_price)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Price::RecurringPrice} for more details.
         #
@@ -196,12 +198,12 @@ module Dodopayments
         #
         #   @param price [Integer] The payment amount. Represented in the lowest denomination of the currency (e.g.
         #
-        #   @param purchasing_power_parity [Boolean] Indicates if purchasing power parity adjustments are applied to the price.
-        #
         #   @param subscription_period_count [Integer] Number of units for the subscription period.
         #
         #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
         #
+        #   @param purchasing_power_parity [Boolean] Opts this price in to purchasing power parity. The business must also
+        #
         #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive
         #
         #   @param trial_amount [Integer, nil] Amount charged today for a paid trial, in the price currency's minor units.
@@ -246,13 +248,6 @@ module Dodopayments
         #   @return [Symbol, Dodopayments::Models::TimeInterval]
         required :payment_frequency_interval, enum: -> { Dodopayments::TimeInterval }
 
-        # @!attribute purchasing_power_parity
-        #   Indicates if purchasing power parity adjustments are applied to the price.
-        #   Purchasing power parity feature is not available as of now
-        #
-        #   @return [Boolean]
-        required :purchasing_power_parity, Dodopayments::Internal::Type::Boolean
-
         # @!attribute subscription_period_count
         #   Number of units for the subscription period. For example, a value of `12` with a
         #   `subscription_period_interval` of `month` represents a one-year subscription.
@@ -280,13 +275,22 @@ module Dodopayments
                  },
                  nil?: true
 
+        # @!attribute purchasing_power_parity
+        #   Opts this price in to purchasing power parity. The business must also enable
+        #   purchasing power parity. The discount percentage per country is always
+        #   business-wide. Applies to the fixed fee only, never to metered usage. Defaults
+        #   to `false`.
+        #
+        #   @return [Boolean, nil]
+        optional :purchasing_power_parity, Dodopayments::Internal::Type::Boolean
+
         # @!attribute tax_inclusive
         #   Indicates if the price is tax inclusive
         #
         #   @return [Boolean, nil]
         optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(currency:, discount:, fixed_price:, payment_frequency_count:, payment_frequency_interval:, purchasing_power_parity:, subscription_period_count:, subscription_period_interval:, meters: nil, tax_inclusive: nil, type: :usage_based_price)
+        # @!method initialize(currency:, discount:, fixed_price:, payment_frequency_count:, payment_frequency_interval:, subscription_period_count:, subscription_period_interval:, meters: nil, purchasing_power_parity: nil, tax_inclusive: nil, type: :usage_based_price)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Price::UsageBasedPrice} for more details.
         #
@@ -302,14 +306,14 @@ module Dodopayments
         #
         #   @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the payment frequency (e.g., day, month, year).
         #
-        #   @param purchasing_power_parity [Boolean] Indicates if purchasing power parity adjustments are applied to the price.
-        #
         #   @param subscription_period_count [Integer] Number of units for the subscription period.
         #
         #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
         #
         #   @param meters [Array<Dodopayments::Models::AddMeterToPrice>, nil]
         #
+        #   @param purchasing_power_parity [Boolean] Opts this price in to purchasing power parity. The business must also
+        #
         #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive
         #
         #   @param type [Symbol, :usage_based_price]

data/lib/dodopayments/models/subscription_change_plan_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Subscriptions#change_plan
+    class SubscriptionChangePlanResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute client_secret
+      #   Client secret for an embedded checkout.
+      #
+      #   @return [String, nil]
+      optional :client_secret, String, nil?: true
+
+      # @!attribute expires_on
+      #   When the link stops working.
+      #
+      #   @return [Time, nil]
+      optional :expires_on, Time, nil?: true
+
+      # @!attribute payment_id
+      #   Id of the payment that settles the plan change.
+      #
+      #   @return [String, nil]
+      optional :payment_id, String, nil?: true
+
+      # @!attribute payment_link
+      #   Checkout page URL. Give this to the customer.
+      #
+      #   @return [String, nil]
+      optional :payment_link, String, nil?: true
+
+      # @!method initialize(client_secret: nil, expires_on: nil, payment_id: nil, payment_link: nil)
+      #   Handles for a hosted checkout page that settles a plan change.
+      #
+      #   The four fields repeat `UpdatePaymentMethodResponse` and a subset of
+      #   `CreateSubscriptionResponse`. A shared type would rename the generated SDK types
+      #   for all three routes, so each route keeps its own.
+      #
+      #   @param client_secret [String, nil] Client secret for an embedded checkout.
+      #
+      #   @param expires_on [Time, nil] When the link stops working.
+      #
+      #   @param payment_id [String, nil] Id of the payment that settles the plan change.
+      #
+      #   @param payment_link [String, nil] Checkout page URL. Give this to the customer.
+    end
+  end
+end

data/lib/dodopayments/models/subscription_update_params.rb

@@ -85,13 +85,25 @@ module Dodopayments
       optional :next_billing_date, Time, nil?: true
 
       # @!attribute pause
-      #   `Some(true)` pauses an active subscription; `Some(false)` unpauses a `Paused`
-      #   (or abandoned `OnHold`) subscription. Exclusive of every other field.
+      #   Removed. Use `status: paused` to pause and `status: active` to resume. This
+      #   field always fails with 422, so a caller still on it gets a loud error instead
+      #   of a silent no-op.
       #
       #   @return [Boolean, nil]
       optional :pause, Dodopayments::Internal::Type::Boolean, nil?: true
 
       # @!attribute status
+      #   Set to `cancelled` to cancel the subscription. See `cancel_reason`,
+      #   `cancellation_feedback`, `cancellation_comment`, and
+      #   `cancel_at_next_billing_date` for cancellation options.
+      #
+      #   Set to `paused` to pause an active subscription. Set to `active` to resume a
+      #   `paused` subscription. `active` also resumes an `on_hold` subscription that has
+      #   an unpaid pause invoice. This voids that invoice.
+      #
+      #   Send `paused` or `active` alone. A request that combines either with any other
+      #   field fails with 422. `cancelled` is not exclusive this way — see
+      #   `cancel_reason` and friends below.
       #
       #   @return [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
       optional :status, enum: -> { Dodopayments::SubscriptionStatus }, nil?: true
@@ -146,9 +158,9 @@ module Dodopayments
       #
       #   @param next_billing_date [Time, nil]
       #
-      #   @param pause [Boolean, nil] `Some(true)` pauses an active subscription; `Some(false)` unpauses a
+      #   @param pause [Boolean, nil] Removed. Use `status: paused` to pause and `status: active` to resume.
       #
-      #   @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
+      #   @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil] Set to `cancelled` to cancel the subscription. See `cancel_reason`,
       #
       #   @param subscription_period_count [Integer, nil] New number of `subscription_period_interval` units the subscription
       #

data/lib/dodopayments/models/update_subscription_plan_req.rb

@@ -36,6 +36,36 @@ module Dodopayments
       #   @return [Array<Dodopayments::Models::AttachAddon>, nil]
       optional :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AttachAddon] }, nil?: true
 
+      # @!attribute cancel_scheduled_change_plan
+      #   Replace a scheduled plan change with this one.
+      #
+      #   The scheduled change is cancelled by the transaction that applies this change. A
+      #   change that never applies leaves the schedule in place.
+      #
+      #   `effective_at: next_billing_date` is allowed. The new schedule then replaces the
+      #   old one in the request transaction.
+      #
+      #   A pending plan change still gets a `409`. This field does not affect it.
+      #
+      #   The preview route shares this request body, so a preview that sets this field
+      #   also passes the scheduled-change `409`.
+      #
+      #   @return [Boolean, nil]
+      optional :cancel_scheduled_change_plan, Dodopayments::Internal::Type::Boolean
+
+      # @!attribute collect_via_payment_link
+      #   Collect the plan-change amount with a payment link. The customer then pays on a
+      #   checkout page.
+      #
+      #   The business needs the `allow_plan_change_via_payment_link` capability. The
+      #   request needs `effective_at: immediately`. The request also needs
+      #   `on_payment_failure: prevent_change`.
+      #
+      #   The preview route shares this request body and ignores this field.
+      #
+      #   @return [Boolean, nil]
+      optional :collect_via_payment_link, Dodopayments::Internal::Type::Boolean
+
       # @!attribute discount_code
       #   @deprecated Use `discount_id` instead.
       #
@@ -86,7 +116,7 @@ module Dodopayments
                enum: -> { Dodopayments::UpdateSubscriptionPlanReq::OnPaymentFailure },
                nil?: true
 
-      # @!method initialize(product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, discount_code: nil, discount_codes: nil, effective_at: nil, metadata: nil, on_payment_failure: nil)
+      # @!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)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::UpdateSubscriptionPlanReq} for more details.
       #
@@ -100,6 +130,10 @@ module Dodopayments
       #
       #   @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
+      #   @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
+      #
       #   @param discount_code [String, nil] DEPRECATED: Use discount_codes instead. Cannot be used together with discount_co
       #
       #   @param discount_codes [Array<String>, nil] Stacked discount codes to apply to the new plan. Max 20.

data/lib/dodopayments/models.rb

@@ -75,6 +75,8 @@ module Dodopayments
 
   Brand = Dodopayments::Models::Brand
 
+  BrandArchiveParams = Dodopayments::Models::BrandArchiveParams
+
   BrandCreateParams = Dodopayments::Models::BrandCreateParams
 
   BrandListParams = Dodopayments::Models::BrandListParams

data/lib/dodopayments/resources/brands.rb

@@ -78,7 +78,9 @@ module Dodopayments
         )
       end
 
-      # @overload list(request_options: {})
+      # @overload list(include_archived: nil, request_options: {})
+      #
+      # @param include_archived [Boolean] Set to true to also list archived brands. Default false.
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -86,11 +88,42 @@ module Dodopayments
       #
       # @see Dodopayments::Models::BrandListParams
       def list(params = {})
+        parsed, options = Dodopayments::BrandListParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brands",
+          query: query,
           model: Dodopayments::Models::BrandListResponse,
-          options: params[:request_options]
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::BrandArchiveParams} for more details.
+      #
+      # Archive a brand. Its products, live subscriptions, and product collections move
+      # to the `move_products_to` brand. Archive is permanent.
+      #
+      # @overload archive(id, move_products_to: nil, request_options: {})
+      #
+      # @param id [String] Brand Id
+      #
+      # @param move_products_to [String, nil] Brand that takes over the products and the live subscriptions of the
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::BrandArchiveResponse]
+      #
+      # @see Dodopayments::Models::BrandArchiveParams
+      def archive(id, params = {})
+        parsed, options = Dodopayments::BrandArchiveParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["brands/%1$s/archive", id],
+          body: parsed,
+          model: Dodopayments::Models::BrandArchiveResponse,
+          options: options
         )
       end