dodopayments 2.25.0 → 2.27.0

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/webhook_event_type.rbi

@@ -66,6 +66,11 @@ module Dodopayments
           :"subscription.on_hold",
           Dodopayments::WebhookEventType::TaggedSymbol
         )
+      SUBSCRIPTION_PAST_DUE =
+        T.let(
+          :"subscription.past_due",
+          Dodopayments::WebhookEventType::TaggedSymbol
+        )
       SUBSCRIPTION_PAUSED =
         T.let(
           :"subscription.paused",

data/rbi/dodopayments/models/webhook_payload.rbi

@@ -153,12 +153,41 @@ module Dodopayments
           sig { returns(Symbol) }
           attr_accessor :payload_type
 
+          # Time when the grace period ends. The subscription moves to `on_hold` or to
+          # `cancelled` at this time.
+          #
+          # Read in the same query as the rest of the payload, so it always comes from the
+          # row snapshot that produced `status`. It is set whenever the subscription sits in
+          # a window at that moment. A delayed event of another type therefore carries the
+          # deadline too, next to a `past_due` status.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :past_due_ends_at
+
           # Response struct representing subscription details
-          sig { params(payload_type: Symbol).returns(T.attached_class) }
-          def self.new(payload_type: :Subscription)
+          sig do
+            params(
+              past_due_ends_at: T.nilable(Time),
+              payload_type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Time when the grace period ends. The subscription moves to `on_hold` or to
+            # `cancelled` at this time.
+            #
+            # Read in the same query as the rest of the payload, so it always comes from the
+            # row snapshot that produced `status`. It is set whenever the subscription sits in
+            # a window at that moment. A delayed event of another type therefore carries the
+            # deadline too, next to a `past_due` status.
+            past_due_ends_at: nil,
+            payload_type: :Subscription
+          )
           end
 
-          sig { override.returns({ payload_type: Symbol }) }
+          sig do
+            override.returns(
+              { payload_type: Symbol, past_due_ends_at: T.nilable(Time) }
+            )
+          end
           def to_hash
           end
         end
@@ -867,6 +896,11 @@ module Dodopayments
                 :cancelled,
                 Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::TaggedSymbol
               )
+            PAST_DUE =
+              T.let(
+                :past_due,
+                Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/dodopayments/models.rbi

@@ -38,6 +38,8 @@ module Dodopayments
 
   BillingAddress = Dodopayments::Models::BillingAddress
 
+  Blocklist = Dodopayments::Models::Blocklist
+
   Brand = Dodopayments::Models::Brand
 
   BrandArchiveParams = Dodopayments::Models::BrandArchiveParams
@@ -319,6 +321,10 @@ module Dodopayments
 
   LicenseValidateParams = Dodopayments::Models::LicenseValidateParams
 
+  ManualRetry = Dodopayments::Models::ManualRetry
+
+  ManualRetryState = Dodopayments::Models::ManualRetryState
+
   Metadata =
     T.let(
       Dodopayments::Models::Metadata,
@@ -380,6 +386,11 @@ module Dodopayments
 
   PaymentRetrieveParams = Dodopayments::Models::PaymentRetrieveParams
 
+  PaymentRetrieveRetryStateParams =
+    Dodopayments::Models::PaymentRetrieveRetryStateParams
+
+  PaymentRetryParams = Dodopayments::Models::PaymentRetryParams
+
   PaymentSucceededWebhookEvent =
     Dodopayments::Models::PaymentSucceededWebhookEvent
 
@@ -497,6 +508,9 @@ module Dodopayments
   SubscriptionOnHoldWebhookEvent =
     Dodopayments::Models::SubscriptionOnHoldWebhookEvent
 
+  SubscriptionPastDueWebhookEvent =
+    Dodopayments::Models::SubscriptionPastDueWebhookEvent
+
   SubscriptionPausedWebhookEvent =
     Dodopayments::Models::SubscriptionPausedWebhookEvent
 

data/rbi/dodopayments/resources/blocklist/customers/notes.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Blocklist
+      class Customers
+        class Notes
+          sig do
+            params(
+              entry_id: String,
+              note: String,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(Dodopayments::Blocklist::Customers::BlockedCustomerNote)
+          end
+          def create(
+            # Blocklist entry id
+            entry_id,
+            note:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            params(
+              note_id: String,
+              entry_id: String,
+              note: String,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(Dodopayments::Blocklist::Customers::BlockedCustomerNote)
+          end
+          def update(
+            # Path param: Note id
+            note_id,
+            # Path param: Blocklist entry id
+            entry_id:,
+            # Body param
+            note:,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/blocklist/customers.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Blocklist
+      class Customers
+        sig { returns(Dodopayments::Resources::Blocklist::Customers::Notes) }
+        attr_reader :notes
+
+        sig do
+          params(
+            create_blocked_customer_request:
+              T.any(
+                Dodopayments::Blocklist::CreateBlockedCustomerRequest::BlocklistCustomersBlockByCustomerID::OrHash,
+                Dodopayments::Blocklist::CreateBlockedCustomerRequest::BlocklistCustomersBlockByEmail::OrHash
+              ),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Blocklist::BlockedCustomer)
+        end
+        def create(create_blocked_customer_request:, request_options: {})
+        end
+
+        sig do
+          params(
+            entry_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Blocklist::BlockedCustomer)
+        end
+        def retrieve(
+          # Blocklist entry id
+          entry_id,
+          request_options: {}
+        )
+        end
+
+        sig do
+          params(
+            blocked_by_email: T.nilable(String),
+            created_at_gte: T.nilable(Time),
+            created_at_lte: T.nilable(Time),
+            identifier: T.nilable(String),
+            page_number: T.nilable(Integer),
+            page_size: T.nilable(Integer),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(
+            Dodopayments::Internal::DefaultPageNumberPagination[
+              Dodopayments::Blocklist::BlockedCustomer
+            ]
+          )
+        end
+        def list(
+          # Filter by the dashboard user who blocked the customer.
+          blocked_by_email: nil,
+          # Blocked on or after this time.
+          created_at_gte: nil,
+          # Blocked on or before this time.
+          created_at_lte: nil,
+          # Partial, case-insensitive match on the email and on the customer id.
+          identifier: nil,
+          # Page number. Default 0.
+          page_number: nil,
+          # Page size. Default 10, maximum 100.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          params(
+            entry_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Blocklist entry id
+          entry_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/blocklist.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Blocklist
+      sig { returns(Dodopayments::Resources::Blocklist::Customers) }
+      attr_reader :customers
+
+      # @api private
+      sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/payments.rbi

@@ -165,6 +165,32 @@ module Dodopayments
       )
       end
 
+      sig do
+        params(
+          payment_id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::ManualRetryState)
+      end
+      def retrieve_retry_state(
+        # Id of the failed payment
+        payment_id,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          payment_id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::ManualRetry)
+      end
+      def retry_(
+        # Id of the failed payment
+        payment_id,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Dodopayments::Client).returns(T.attached_class) }
       def self.new(client:)

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/rbi/dodopayments/resources/webhooks.rbi

@@ -185,6 +185,7 @@ module Dodopayments
             Dodopayments::SubscriptionExpiredWebhookEvent,
             Dodopayments::SubscriptionFailedWebhookEvent,
             Dodopayments::SubscriptionOnHoldWebhookEvent,
+            Dodopayments::SubscriptionPastDueWebhookEvent,
             Dodopayments::SubscriptionPausedWebhookEvent,
             Dodopayments::SubscriptionPlanChangedWebhookEvent,
             Dodopayments::SubscriptionRenewedWebhookEvent,
@@ -248,6 +249,7 @@ module Dodopayments
             Dodopayments::SubscriptionExpiredWebhookEvent,
             Dodopayments::SubscriptionFailedWebhookEvent,
             Dodopayments::SubscriptionOnHoldWebhookEvent,
+            Dodopayments::SubscriptionPastDueWebhookEvent,
             Dodopayments::SubscriptionPausedWebhookEvent,
             Dodopayments::SubscriptionPlanChangedWebhookEvent,
             Dodopayments::SubscriptionRenewedWebhookEvent,

data/sig/dodopayments/client.rbs

@@ -33,6 +33,8 @@ module Dodopayments
 
     attr_reader customers: Dodopayments::Resources::Customers
 
+    attr_reader blocklist: Dodopayments::Resources::Blocklist
+
     attr_reader refunds: Dodopayments::Resources::Refunds
 
     attr_reader disputes: Dodopayments::Resources::Disputes

data/sig/dodopayments/models/balance_ledger_entry.rbs

@@ -13,6 +13,7 @@ module Dodopayments
         after_balance: Integer?,
         before_balance: Integer?,
         description: String?,
+        payout_id: String?,
         reference_object_id: String?
       }
 
@@ -39,6 +40,8 @@ module Dodopayments
 
       attr_accessor description: String?
 
+      attr_accessor payout_id: String?
+
       attr_accessor reference_object_id: String?
 
       def initialize: (
@@ -53,6 +56,7 @@ module Dodopayments
         ?after_balance: Integer?,
         ?before_balance: Integer?,
         ?description: String?,
+        ?payout_id: String?,
         ?reference_object_id: String?
       ) -> void
 
@@ -68,6 +72,7 @@ module Dodopayments
         after_balance: Integer?,
         before_balance: Integer?,
         description: String?,
+        payout_id: String?,
         reference_object_id: String?
       }
 

data/sig/dodopayments/models/blocklist/block_by_customer_id.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    module Blocklist
+      type block_by_customer_id = { customer_id: String }
+
+      class BlockByCustomerID < Dodopayments::Internal::Type::BaseModel
+        attr_accessor customer_id: String
+
+        def initialize: (customer_id: String) -> void
+
+        def to_hash: -> { customer_id: String }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/blocklist/block_by_email.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    module Blocklist
+      type block_by_email = { email: String }
+
+      class BlockByEmail < Dodopayments::Internal::Type::BaseModel
+        attr_accessor email: String
+
+        def initialize: (email: String) -> void
+
+        def to_hash: -> { email: String }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/blocklist/block_identifier.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    module Blocklist
+      type block_identifier =
+        Dodopayments::Blocklist::BlockByCustomerID
+        | Dodopayments::Blocklist::BlockByEmail
+
+      module BlockIdentifier
+        extend Dodopayments::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Dodopayments::Models::Blocklist::block_identifier]
+      end
+    end
+  end
+end