dodopayments 2.24.0 → 2.26.0

data/rbi/dodopayments/models/subscription_change_plan_response.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionChangePlanResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::SubscriptionChangePlanResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Client secret for an embedded checkout.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :client_secret
+
+      # When the link stops working.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :expires_on
+
+      # Id of the payment that settles the plan change.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payment_id
+
+      # Checkout page URL. Give this to the customer.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payment_link
+
+      # 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.
+      sig do
+        params(
+          client_secret: T.nilable(String),
+          expires_on: T.nilable(Time),
+          payment_id: T.nilable(String),
+          payment_link: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Client secret for an embedded checkout.
+        client_secret: nil,
+        # When the link stops working.
+        expires_on: nil,
+        # Id of the payment that settles the plan change.
+        payment_id: nil,
+        # Checkout page URL. Give this to the customer.
+        payment_link: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            client_secret: T.nilable(String),
+            expires_on: T.nilable(Time),
+            payment_id: T.nilable(String),
+            payment_link: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/subscription_update_params.rbi

@@ -98,11 +98,23 @@ module Dodopayments
       sig { returns(T.nilable(Time)) }
       attr_accessor :next_billing_date
 
-      # `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.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :pause
 
+      # 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.
       sig { returns(T.nilable(Dodopayments::SubscriptionStatus::OrSymbol)) }
       attr_accessor :status
 
@@ -182,9 +194,21 @@ module Dodopayments
         # Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
         metadata: nil,
         next_billing_date: nil,
-        # `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.
         pause: nil,
+        # 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.
         status: nil,
         # New number of `subscription_period_interval` units the subscription entitlement
         # should span. Used together with `subscription_period_interval` to extend the

data/rbi/dodopayments/models/update_subscription_plan_req.rbi

@@ -37,6 +37,38 @@ module Dodopayments
       sig { returns(T.nilable(T::Array[Dodopayments::AttachAddon])) }
       attr_accessor :addons
 
+      # 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`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :cancel_scheduled_change_plan
+
+      sig { params(cancel_scheduled_change_plan: T::Boolean).void }
+      attr_writer :cancel_scheduled_change_plan
+
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :collect_via_payment_link
+
+      sig { params(collect_via_payment_link: T::Boolean).void }
+      attr_writer :collect_via_payment_link
+
       # DEPRECATED: Use discount_codes instead. Cannot be used together with
       # discount_codes.
       sig { returns(T.nilable(String)) }
@@ -103,6 +135,8 @@ module Dodopayments
           quantity: Integer,
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          cancel_scheduled_change_plan: T::Boolean,
+          collect_via_payment_link: T::Boolean,
           discount_code: T.nilable(String),
           discount_codes: T.nilable(T::Array[String]),
           effective_at:
@@ -128,6 +162,28 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # 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`.
+        cancel_scheduled_change_plan: nil,
+        # 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.
+        collect_via_payment_link: nil,
         # DEPRECATED: Use discount_codes instead. Cannot be used together with
         # discount_codes.
         discount_code: nil,
@@ -164,6 +220,8 @@ module Dodopayments
             quantity: Integer,
             adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
             addons: T.nilable(T::Array[Dodopayments::AttachAddon]),
+            cancel_scheduled_change_plan: T::Boolean,
+            collect_via_payment_link: T::Boolean,
             discount_code: T.nilable(String),
             discount_codes: T.nilable(T::Array[String]),
             effective_at:

data/rbi/dodopayments/models.rbi

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

data/rbi/dodopayments/resources/brands.rbi

@@ -64,11 +64,37 @@ module Dodopayments
       end
 
       sig do
-        params(request_options: Dodopayments::RequestOptions::OrHash).returns(
-          Dodopayments::Models::BrandListResponse
-        )
+        params(
+          include_archived: T::Boolean,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Models::BrandListResponse)
+      end
+      def list(
+        # Set to true to also list archived brands. Default false.
+        include_archived: nil,
+        request_options: {}
+      )
       end
-      def list(request_options: {})
+
+      # Archive a brand. Its products, live subscriptions, and product collections move
+      # to the `move_products_to` brand. Archive is permanent.
+      sig do
+        params(
+          id: String,
+          move_products_to: T.nilable(String),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Models::BrandArchiveResponse)
+      end
+      def archive(
+        # Brand Id
+        id,
+        # 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.
+        move_products_to: nil,
+        request_options: {}
+      )
       end
 
       sig do

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -187,9 +187,21 @@ module Dodopayments
         # Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
         metadata: nil,
         next_billing_date: nil,
-        # `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.
         pause: nil,
+        # 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.
         status: nil,
         # New number of `subscription_period_interval` units the subscription entitlement
         # should span. Used together with `subscription_period_interval` to extend the
@@ -268,6 +280,8 @@ module Dodopayments
           quantity: Integer,
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          cancel_scheduled_change_plan: T::Boolean,
+          collect_via_payment_link: T::Boolean,
           discount_code: T.nilable(String),
           discount_codes: T.nilable(T::Array[String]),
           effective_at:
@@ -279,7 +293,7 @@ module Dodopayments
               Dodopayments::UpdateSubscriptionPlanReq::OnPaymentFailure::OrSymbol
             ),
           request_options: Dodopayments::RequestOptions::OrHash
-        ).void
+        ).returns(Dodopayments::Models::SubscriptionChangePlanResponse)
       end
       def change_plan(
         # Subscription Id
@@ -296,6 +310,28 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # 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`.
+        cancel_scheduled_change_plan: nil,
+        # 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.
+        collect_via_payment_link: nil,
         # DEPRECATED: Use discount_codes instead. Cannot be used together with
         # discount_codes.
         discount_code: nil,
@@ -374,6 +410,8 @@ module Dodopayments
           quantity: Integer,
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          cancel_scheduled_change_plan: T::Boolean,
+          collect_via_payment_link: T::Boolean,
           discount_code: T.nilable(String),
           discount_codes: T.nilable(T::Array[String]),
           effective_at:
@@ -402,6 +440,28 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # 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`.
+        cancel_scheduled_change_plan: nil,
+        # 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.
+        collect_via_payment_link: nil,
         # DEPRECATED: Use discount_codes instead. Cannot be used together with
         # discount_codes.
         discount_code: nil,

data/sig/dodopayments/models/brand.rbs

@@ -8,6 +8,7 @@ module Dodopayments
         statement_descriptor: String,
         verification_enabled: bool,
         verification_status: Dodopayments::Models::Brand::verification_status,
+        archived_at: Time?,
         description: String?,
         image: String?,
         name: String?,
@@ -29,6 +30,8 @@ module Dodopayments
 
       attr_accessor verification_status: Dodopayments::Models::Brand::verification_status
 
+      attr_accessor archived_at: Time?
+
       attr_accessor description: String?
 
       attr_accessor image: String?
@@ -48,6 +51,7 @@ module Dodopayments
         statement_descriptor: String,
         verification_enabled: bool,
         verification_status: Dodopayments::Models::Brand::verification_status,
+        ?archived_at: Time?,
         ?description: String?,
         ?image: String?,
         ?name: String?,
@@ -63,6 +67,7 @@ module Dodopayments
         statement_descriptor: String,
         verification_enabled: bool,
         verification_status: Dodopayments::Models::Brand::verification_status,
+        archived_at: Time?,
         description: String?,
         image: String?,
         name: String?,

data/sig/dodopayments/models/brand_archive_params.rbs

@@ -0,0 +1,28 @@
+module Dodopayments
+  module Models
+    type brand_archive_params =
+      { id: String, move_products_to: String? }
+      & Dodopayments::Internal::Type::request_parameters
+
+    class BrandArchiveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_accessor move_products_to: String?
+
+      def initialize: (
+        id: String,
+        ?move_products_to: String?,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        move_products_to: String?,
+        request_options: Dodopayments::RequestOptions
+      }
+    end
+  end
+end

data/sig/dodopayments/models/brand_archive_response.rbs

@@ -0,0 +1,45 @@
+module Dodopayments
+  module Models
+    type brand_archive_response =
+      {
+        archived_at: Time,
+        brand_id: String,
+        collections_moved: Integer,
+        products_moved: Integer,
+        subscriptions_moved: Integer,
+        moved_to_brand_id: String?
+      }
+
+    class BrandArchiveResponse < Dodopayments::Internal::Type::BaseModel
+      attr_accessor archived_at: Time
+
+      attr_accessor brand_id: String
+
+      attr_accessor collections_moved: Integer
+
+      attr_accessor products_moved: Integer
+
+      attr_accessor subscriptions_moved: Integer
+
+      attr_accessor moved_to_brand_id: String?
+
+      def initialize: (
+        archived_at: Time,
+        brand_id: String,
+        collections_moved: Integer,
+        products_moved: Integer,
+        subscriptions_moved: Integer,
+        ?moved_to_brand_id: String?
+      ) -> void
+
+      def to_hash: -> {
+        archived_at: Time,
+        brand_id: String,
+        collections_moved: Integer,
+        products_moved: Integer,
+        subscriptions_moved: Integer,
+        moved_to_brand_id: String?
+      }
+    end
+  end
+end

data/sig/dodopayments/models/brand_list_params.rbs

@@ -1,15 +1,26 @@
 module Dodopayments
   module Models
     type brand_list_params =
-      {  } & Dodopayments::Internal::Type::request_parameters
+      { include_archived: bool }
+      & Dodopayments::Internal::Type::request_parameters
 
     class BrandListParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Dodopayments::request_opts) -> void
+      attr_reader include_archived: bool?
 
-      def to_hash: -> { request_options: Dodopayments::RequestOptions }
+      def include_archived=: (bool) -> bool
+
+      def initialize: (
+        ?include_archived: bool,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        include_archived: bool,
+        request_options: Dodopayments::RequestOptions
+      }
     end
   end
 end

data/sig/dodopayments/models/checkout_session_flags.rbs

@@ -18,7 +18,8 @@ module Dodopayments
         allow_tax_id: bool,
         always_create_new_customer: bool,
         redirect_immediately: bool,
-        require_phone_number: bool
+        require_phone_number: bool,
+        single_page: bool
       }
 
     class CheckoutSessionFlags < Dodopayments::Internal::Type::BaseModel
@@ -90,6 +91,10 @@ module Dodopayments
 
       def require_phone_number=: (bool) -> bool
 
+      attr_reader single_page: bool?
+
+      def single_page=: (bool) -> bool
+
       def initialize: (
         ?allow_currency_selection: bool,
         ?allow_customer_editing_business_name: bool,
@@ -107,7 +112,8 @@ module Dodopayments
         ?allow_tax_id: bool,
         ?always_create_new_customer: bool,
         ?redirect_immediately: bool,
-        ?require_phone_number: bool
+        ?require_phone_number: bool,
+        ?single_page: bool
       ) -> void
 
       def to_hash: -> {
@@ -127,7 +133,8 @@ module Dodopayments
         allow_tax_id: bool,
         always_create_new_customer: bool,
         redirect_immediately: bool,
-        require_phone_number: bool
+        require_phone_number: bool,
+        single_page: bool
       }
     end
   end

data/sig/dodopayments/models/entitlements/license_key_grant.rbs

@@ -3,31 +3,41 @@ module Dodopayments
     module Entitlements
       type license_key_grant =
         {
+          id: String,
           activations_used: Integer,
           key: String,
+          status: Dodopayments::Models::license_key_status,
           activations_limit: Integer?,
           expires_at: Time?
         }
 
       class LicenseKeyGrant < Dodopayments::Internal::Type::BaseModel
+        attr_accessor id: String
+
         attr_accessor activations_used: Integer
 
         attr_accessor key: String
 
+        attr_accessor status: Dodopayments::Models::license_key_status
+
         attr_accessor activations_limit: Integer?
 
         attr_accessor expires_at: Time?
 
         def initialize: (
+          id: String,
           activations_used: Integer,
           key: String,
+          status: Dodopayments::Models::license_key_status,
           ?activations_limit: Integer?,
           ?expires_at: Time?
         ) -> void
 
         def to_hash: -> {
+          id: String,
           activations_used: Integer,
           key: String,
+          status: Dodopayments::Models::license_key_status,
           activations_limit: Integer?,
           expires_at: Time?
         }