dodopayments 2.23.0 → 2.25.0

data/lib/dodopayments.rb

@@ -84,6 +84,8 @@ require_relative "dodopayments/models/balance_ledger_entry"
 require_relative "dodopayments/models/balance_retrieve_ledger_params"
 require_relative "dodopayments/models/billing_address"
 require_relative "dodopayments/models/brand"
+require_relative "dodopayments/models/brand_archive_params"
+require_relative "dodopayments/models/brand_archive_response"
 require_relative "dodopayments/models/brand_create_params"
 require_relative "dodopayments/models/brand_list_params"
 require_relative "dodopayments/models/brand_list_response"
@@ -343,6 +345,7 @@ require_relative "dodopayments/models/subscription_failed_webhook_event"
 require_relative "dodopayments/models/subscription_list_params"
 require_relative "dodopayments/models/subscription_list_response"
 require_relative "dodopayments/models/subscription_on_hold_webhook_event"
+require_relative "dodopayments/models/subscription_paused_webhook_event"
 require_relative "dodopayments/models/subscription_plan_changed_webhook_event"
 require_relative "dodopayments/models/subscription_preview_change_plan_params"
 require_relative "dodopayments/models/subscription_preview_change_plan_response"
@@ -353,6 +356,7 @@ require_relative "dodopayments/models/subscription_retrieve_params"
 require_relative "dodopayments/models/subscription_retrieve_usage_history_params"
 require_relative "dodopayments/models/subscription_retrieve_usage_history_response"
 require_relative "dodopayments/models/subscription_status"
+require_relative "dodopayments/models/subscription_unpaused_webhook_event"
 require_relative "dodopayments/models/subscription_updated_webhook_event"
 require_relative "dodopayments/models/subscription_update_params"
 require_relative "dodopayments/models/subscription_update_payment_method_params"

data/rbi/dodopayments/models/brand.rbi

@@ -26,6 +26,10 @@ module Dodopayments
       sig { returns(Dodopayments::Brand::VerificationStatus::TaggedSymbol) }
       attr_accessor :verification_status
 
+      # Time the brand was archived. Null for an active brand.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :archived_at
+
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
@@ -54,6 +58,7 @@ module Dodopayments
           verification_enabled: T::Boolean,
           verification_status:
             Dodopayments::Brand::VerificationStatus::OrSymbol,
+          archived_at: T.nilable(Time),
           description: T.nilable(String),
           image: T.nilable(String),
           name: T.nilable(String),
@@ -69,6 +74,8 @@ module Dodopayments
         statement_descriptor:,
         verification_enabled:,
         verification_status:,
+        # Time the brand was archived. Null for an active brand.
+        archived_at: nil,
         description: nil,
         image: nil,
         name: nil,
@@ -89,6 +96,7 @@ module Dodopayments
             verification_enabled: T::Boolean,
             verification_status:
               Dodopayments::Brand::VerificationStatus::TaggedSymbol,
+            archived_at: T.nilable(Time),
             description: T.nilable(String),
             image: T.nilable(String),
             name: T.nilable(String),

data/rbi/dodopayments/models/brand_archive_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class BrandArchiveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::BrandArchiveParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :move_products_to
+
+      sig do
+        params(
+          id: String,
+          move_products_to: T.nilable(String),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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
+        override.returns(
+          {
+            id: String,
+            move_products_to: T.nilable(String),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/brand_archive_response.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class BrandArchiveResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::BrandArchiveResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Time the brand was archived.
+      sig { returns(Time) }
+      attr_accessor :archived_at
+
+      # The archived brand.
+      sig { returns(String) }
+      attr_accessor :brand_id
+
+      # Count of product collections moved to the target brand.
+      sig { returns(Integer) }
+      attr_accessor :collections_moved
+
+      # Count of products moved to the target brand.
+      sig { returns(Integer) }
+      attr_accessor :products_moved
+
+      # Count of live subscriptions moved to the target brand.
+      sig { returns(Integer) }
+      attr_accessor :subscriptions_moved
+
+      # Brand that received the moved records. Null when no target was given.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :moved_to_brand_id
+
+      sig do
+        params(
+          archived_at: Time,
+          brand_id: String,
+          collections_moved: Integer,
+          products_moved: Integer,
+          subscriptions_moved: Integer,
+          moved_to_brand_id: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Time the brand was archived.
+        archived_at:,
+        # The archived brand.
+        brand_id:,
+        # Count of product collections moved to the target brand.
+        collections_moved:,
+        # Count of products moved to the target brand.
+        products_moved:,
+        # Count of live subscriptions moved to the target brand.
+        subscriptions_moved:,
+        # Brand that received the moved records. Null when no target was given.
+        moved_to_brand_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            archived_at: Time,
+            brand_id: String,
+            collections_moved: Integer,
+            products_moved: Integer,
+            subscriptions_moved: Integer,
+            moved_to_brand_id: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/brand_list_params.rbi

@@ -11,16 +11,33 @@ module Dodopayments
           T.any(Dodopayments::BrandListParams, Dodopayments::Internal::AnyHash)
         end
 
+      # Set to true to also list archived brands. Default false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_archived
+
+      sig { params(include_archived: T::Boolean).void }
+      attr_writer :include_archived
+
       sig do
-        params(request_options: Dodopayments::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          include_archived: T::Boolean,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        # Set to true to also list archived brands. Default false.
+        include_archived: nil,
+        request_options: {}
+      )
       end
 
       sig do
-        override.returns({ request_options: Dodopayments::RequestOptions })
+        override.returns(
+          {
+            include_archived: T::Boolean,
+            request_options: Dodopayments::RequestOptions
+          }
+        )
       end
       def to_hash
       end

data/rbi/dodopayments/models/checkout_session_flags.rbi

@@ -147,6 +147,17 @@ module Dodopayments
       sig { params(require_phone_number: T::Boolean).void }
       attr_writer :require_phone_number
 
+      # 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
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :single_page
+
+      sig { params(single_page: T::Boolean).void }
+      attr_writer :single_page
+
       sig do
         params(
           allow_currency_selection: T::Boolean,
@@ -165,7 +176,8 @@ module Dodopayments
           allow_tax_id: T::Boolean,
           always_create_new_customer: T::Boolean,
           redirect_immediately: T::Boolean,
-          require_phone_number: T::Boolean
+          require_phone_number: T::Boolean,
+          single_page: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -219,7 +231,13 @@ module Dodopayments
         # `allow_phone_number_collection` to also be true.
         #
         # Default is false
-        require_phone_number: nil
+        require_phone_number: nil,
+        # 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
+        single_page: nil
       )
       end
 
@@ -242,7 +260,8 @@ module Dodopayments
             allow_tax_id: T::Boolean,
             always_create_new_customer: T::Boolean,
             redirect_immediately: T::Boolean,
-            require_phone_number: T::Boolean
+            require_phone_number: T::Boolean,
+            single_page: T::Boolean
           }
         )
       end

data/rbi/dodopayments/models/subscription.rbi

@@ -159,6 +159,11 @@ module Dodopayments
       sig { returns(T.nilable(Time)) }
       attr_accessor :expires_at
 
+      # Timestamp when the subscription was paused, if it currently is (or is `OnHold`
+      # due to an unresolved pause settlement). `null` otherwise.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :paused_at
+
       # Saved payment method id used for recurring charges
       sig { returns(T.nilable(String)) }
       attr_accessor :payment_method_id
@@ -225,6 +230,7 @@ module Dodopayments
           discount_id: T.nilable(String),
           discounts: T.nilable(T::Array[Dodopayments::DiscountDetail::OrHash]),
           expires_at: T.nilable(Time),
+          paused_at: T.nilable(Time),
           payment_method_id: T.nilable(String),
           scheduled_change:
             T.nilable(Dodopayments::ScheduledPlanChange::OrHash),
@@ -304,6 +310,9 @@ module Dodopayments
         discounts: nil,
         # Timestamp when the subscription will expire
         expires_at: nil,
+        # Timestamp when the subscription was paused, if it currently is (or is `OnHold`
+        # due to an unresolved pause settlement). `null` otherwise.
+        paused_at: nil,
         # Saved payment method id used for recurring charges
         payment_method_id: nil,
         # Scheduled plan change details, if any
@@ -360,6 +369,7 @@ module Dodopayments
             discount_id: T.nilable(String),
             discounts: T.nilable(T::Array[Dodopayments::DiscountDetail]),
             expires_at: T.nilable(Time),
+            paused_at: T.nilable(Time),
             payment_method_id: T.nilable(String),
             scheduled_change: T.nilable(Dodopayments::ScheduledPlanChange),
             tax_id: T.nilable(String),

data/rbi/dodopayments/models/subscription_list_params.rbi

@@ -166,6 +166,11 @@ module Dodopayments
             :on_hold,
             Dodopayments::SubscriptionListParams::Status::TaggedSymbol
           )
+        PAUSED =
+          T.let(
+            :paused,
+            Dodopayments::SubscriptionListParams::Status::TaggedSymbol
+          )
         CANCELLED =
           T.let(
             :cancelled,

data/rbi/dodopayments/models/subscription_list_response.rbi

@@ -126,6 +126,11 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :discount_id
 
+      # Timestamp when the subscription was paused, if it currently is (or is `OnHold`
+      # due to an unresolved pause settlement). `null` otherwise.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :paused_at
+
       # Saved payment method id used for recurring charges
       sig { returns(T.nilable(String)) }
       attr_accessor :payment_method_id
@@ -186,6 +191,7 @@ module Dodopayments
           customer_business_name: T.nilable(String),
           discount_cycles_remaining: T.nilable(Integer),
           discount_id: T.nilable(String),
+          paused_at: T.nilable(Time),
           payment_method_id: T.nilable(String),
           product_name: T.nilable(String),
           scheduled_change:
@@ -248,6 +254,9 @@ module Dodopayments
         discount_cycles_remaining: nil,
         # DEPRECATED: Use discounts instead.
         discount_id: nil,
+        # Timestamp when the subscription was paused, if it currently is (or is `OnHold`
+        # due to an unresolved pause settlement). `null` otherwise.
+        paused_at: nil,
         # Saved payment method id used for recurring charges
         payment_method_id: nil,
         # Name of the product associated with this subscription
@@ -296,6 +305,7 @@ module Dodopayments
             customer_business_name: T.nilable(String),
             discount_cycles_remaining: T.nilable(Integer),
             discount_id: T.nilable(String),
+            paused_at: T.nilable(Time),
             payment_method_id: T.nilable(String),
             product_name: T.nilable(String),
             scheduled_change: T.nilable(Dodopayments::ScheduledPlanChange),

data/rbi/dodopayments/models/subscription_paused_webhook_event.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionPausedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::SubscriptionPausedWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Response struct representing subscription details
+      sig { returns(Dodopayments::Subscription) }
+      attr_reader :data
+
+      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::Subscription::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Response struct representing subscription details
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type: :"subscription.paused"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::Subscription,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/subscription_status.rbi

@@ -12,6 +12,7 @@ module Dodopayments
       PENDING = T.let(:pending, Dodopayments::SubscriptionStatus::TaggedSymbol)
       ACTIVE = T.let(:active, Dodopayments::SubscriptionStatus::TaggedSymbol)
       ON_HOLD = T.let(:on_hold, Dodopayments::SubscriptionStatus::TaggedSymbol)
+      PAUSED = T.let(:paused, Dodopayments::SubscriptionStatus::TaggedSymbol)
       CANCELLED =
         T.let(:cancelled, Dodopayments::SubscriptionStatus::TaggedSymbol)
       FAILED = T.let(:failed, Dodopayments::SubscriptionStatus::TaggedSymbol)

data/rbi/dodopayments/models/subscription_unpaused_webhook_event.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionUnpausedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::SubscriptionUnpausedWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Response struct representing subscription details
+      sig { returns(Dodopayments::Subscription) }
+      attr_reader :data
+
+      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::Subscription::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Response struct representing subscription details
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type: :"subscription.unpaused"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::Subscription,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/subscription_update_params.rbi

@@ -98,6 +98,11 @@ 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :pause
+
       sig { returns(T.nilable(Dodopayments::SubscriptionStatus::OrSymbol)) }
       attr_accessor :status
 
@@ -144,6 +149,7 @@ module Dodopayments
           metadata:
             T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
           next_billing_date: T.nilable(Time),
+          pause: T.nilable(T::Boolean),
           status: T.nilable(Dodopayments::SubscriptionStatus::OrSymbol),
           subscription_period_count: T.nilable(Integer),
           subscription_period_interval:
@@ -176,6 +182,9 @@ 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.
+        pause: nil,
         status: nil,
         # New number of `subscription_period_interval` units the subscription entitlement
         # should span. Used together with `subscription_period_interval` to extend the
@@ -219,6 +228,7 @@ module Dodopayments
             metadata:
               T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
             next_billing_date: T.nilable(Time),
+            pause: T.nilable(T::Boolean),
             status: T.nilable(Dodopayments::SubscriptionStatus::OrSymbol),
             subscription_period_count: T.nilable(Integer),
             subscription_period_interval:

data/rbi/dodopayments/models/unsafe_unwrap_webhook_event.rbi

@@ -49,8 +49,10 @@ module Dodopayments
             Dodopayments::SubscriptionExpiredWebhookEvent,
             Dodopayments::SubscriptionFailedWebhookEvent,
             Dodopayments::SubscriptionOnHoldWebhookEvent,
+            Dodopayments::SubscriptionPausedWebhookEvent,
             Dodopayments::SubscriptionPlanChangedWebhookEvent,
             Dodopayments::SubscriptionRenewedWebhookEvent,
+            Dodopayments::SubscriptionUnpausedWebhookEvent,
             Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent,
             Dodopayments::SubscriptionUpdatedWebhookEvent
           )

data/rbi/dodopayments/models/unwrap_webhook_event.rbi

@@ -49,8 +49,10 @@ module Dodopayments
             Dodopayments::SubscriptionExpiredWebhookEvent,
             Dodopayments::SubscriptionFailedWebhookEvent,
             Dodopayments::SubscriptionOnHoldWebhookEvent,
+            Dodopayments::SubscriptionPausedWebhookEvent,
             Dodopayments::SubscriptionPlanChangedWebhookEvent,
             Dodopayments::SubscriptionRenewedWebhookEvent,
+            Dodopayments::SubscriptionUnpausedWebhookEvent,
             Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent,
             Dodopayments::SubscriptionUpdatedWebhookEvent
           )

data/rbi/dodopayments/models/webhook_event_type.rbi

@@ -71,6 +71,11 @@ module Dodopayments
           :"subscription.paused",
           Dodopayments::WebhookEventType::TaggedSymbol
         )
+      SUBSCRIPTION_UNPAUSED =
+        T.let(
+          :"subscription.unpaused",
+          Dodopayments::WebhookEventType::TaggedSymbol
+        )
       SUBSCRIPTION_CANCELLED =
         T.let(
           :"subscription.cancelled",

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
@@ -495,6 +497,9 @@ module Dodopayments
   SubscriptionOnHoldWebhookEvent =
     Dodopayments::Models::SubscriptionOnHoldWebhookEvent
 
+  SubscriptionPausedWebhookEvent =
+    Dodopayments::Models::SubscriptionPausedWebhookEvent
+
   SubscriptionPlanChangedWebhookEvent =
     Dodopayments::Models::SubscriptionPlanChangedWebhookEvent
 
@@ -514,6 +519,9 @@ module Dodopayments
 
   SubscriptionStatus = Dodopayments::Models::SubscriptionStatus
 
+  SubscriptionUnpausedWebhookEvent =
+    Dodopayments::Models::SubscriptionUnpausedWebhookEvent
+
   SubscriptionUpdatedWebhookEvent =
     Dodopayments::Models::SubscriptionUpdatedWebhookEvent
 

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