dodopayments 2.25.0 → 2.27.0

data/lib/dodopayments/models/subscription_list_params.rb

@@ -96,6 +96,7 @@ module Dodopayments
         CANCELLED = :cancelled
         FAILED = :failed
         EXPIRED = :expired
+        PAST_DUE = :past_due
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/dodopayments/models/subscription_on_hold_webhook_event.rb

@@ -10,10 +10,11 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
-      #   Response struct representing subscription details
+      #   Subscription payload sent on a webhook. It carries every field of
+      #   `SubscriptionResponse`, plus the grace-period deadline.
       #
-      #   @return [Dodopayments::Models::Subscription]
-      required :data, -> { Dodopayments::Subscription }
+      #   @return [Dodopayments::Models::SubscriptionOnHoldWebhookEvent::Data]
+      required :data, -> { Dodopayments::SubscriptionOnHoldWebhookEvent::Data }
 
       # @!attribute timestamp
       #   The timestamp of when the event occurred
@@ -28,13 +29,40 @@ module Dodopayments
       required :type, const: :"subscription.on_hold"
 
       # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.on_hold")
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionOnHoldWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
+      #   @param data [Dodopayments::Models::SubscriptionOnHoldWebhookEvent::Data] Subscription payload sent on a webhook. It carries every field of
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
       #   @param type [Symbol, :"subscription.on_hold"] The event type
+
+      # @see Dodopayments::Models::SubscriptionOnHoldWebhookEvent#data
+      class Data < Dodopayments::Models::Subscription
+        # @!attribute past_due_ends_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :past_due_ends_at, Time, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::SubscriptionOnHoldWebhookEvent::Data} for more details.
+        #
+        #   Subscription payload sent on a webhook. It carries every field of
+        #   `SubscriptionResponse`, plus the grace-period deadline.
+        #
+        #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+      end
     end
   end
 end

data/lib/dodopayments/models/subscription_past_due_webhook_event.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class SubscriptionPastDueWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #   The business identifier
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute data
+      #   Subscription payload sent on a webhook. It carries every field of
+      #   `SubscriptionResponse`, plus the grace-period deadline.
+      #
+      #   @return [Dodopayments::Models::SubscriptionPastDueWebhookEvent::Data]
+      required :data, -> { Dodopayments::SubscriptionPastDueWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp of when the event occurred
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The event type
+      #
+      #   @return [Symbol, :"subscription.past_due"]
+      required :type, const: :"subscription.past_due"
+
+      # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.past_due")
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionPastDueWebhookEvent} for more details.
+      #
+      #   @param business_id [String] The business identifier
+      #
+      #   @param data [Dodopayments::Models::SubscriptionPastDueWebhookEvent::Data] Subscription payload sent on a webhook. It carries every field of
+      #
+      #   @param timestamp [Time] The timestamp of when the event occurred
+      #
+      #   @param type [Symbol, :"subscription.past_due"] The event type
+
+      # @see Dodopayments::Models::SubscriptionPastDueWebhookEvent#data
+      class Data < Dodopayments::Models::Subscription
+        # @!attribute past_due_ends_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :past_due_ends_at, Time, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::SubscriptionPastDueWebhookEvent::Data} for more details.
+        #
+        #   Subscription payload sent on a webhook. It carries every field of
+        #   `SubscriptionResponse`, plus the grace-period deadline.
+        #
+        #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+      end
+    end
+  end
+end

data/lib/dodopayments/models/subscription_paused_webhook_event.rb

@@ -10,10 +10,11 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
-      #   Response struct representing subscription details
+      #   Subscription payload sent on a webhook. It carries every field of
+      #   `SubscriptionResponse`, plus the grace-period deadline.
       #
-      #   @return [Dodopayments::Models::Subscription]
-      required :data, -> { Dodopayments::Subscription }
+      #   @return [Dodopayments::Models::SubscriptionPausedWebhookEvent::Data]
+      required :data, -> { Dodopayments::SubscriptionPausedWebhookEvent::Data }
 
       # @!attribute timestamp
       #   The timestamp of when the event occurred
@@ -28,13 +29,40 @@ module Dodopayments
       required :type, const: :"subscription.paused"
 
       # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.paused")
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionPausedWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
+      #   @param data [Dodopayments::Models::SubscriptionPausedWebhookEvent::Data] Subscription payload sent on a webhook. It carries every field of
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
       #   @param type [Symbol, :"subscription.paused"] The event type
+
+      # @see Dodopayments::Models::SubscriptionPausedWebhookEvent#data
+      class Data < Dodopayments::Models::Subscription
+        # @!attribute past_due_ends_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :past_due_ends_at, Time, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::SubscriptionPausedWebhookEvent::Data} for more details.
+        #
+        #   Subscription payload sent on a webhook. It carries every field of
+        #   `SubscriptionResponse`, plus the grace-period deadline.
+        #
+        #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+      end
     end
   end
 end

data/lib/dodopayments/models/subscription_plan_changed_webhook_event.rb

@@ -10,10 +10,11 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
-      #   Response struct representing subscription details
+      #   Subscription payload sent on a webhook. It carries every field of
+      #   `SubscriptionResponse`, plus the grace-period deadline.
       #
-      #   @return [Dodopayments::Models::Subscription]
-      required :data, -> { Dodopayments::Subscription }
+      #   @return [Dodopayments::Models::SubscriptionPlanChangedWebhookEvent::Data]
+      required :data, -> { Dodopayments::SubscriptionPlanChangedWebhookEvent::Data }
 
       # @!attribute timestamp
       #   The timestamp of when the event occurred
@@ -28,13 +29,41 @@ module Dodopayments
       required :type, const: :"subscription.plan_changed"
 
       # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.plan_changed")
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionPlanChangedWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
+      #   @param data [Dodopayments::Models::SubscriptionPlanChangedWebhookEvent::Data] Subscription payload sent on a webhook. It carries every field of
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
       #   @param type [Symbol, :"subscription.plan_changed"] The event type
+
+      # @see Dodopayments::Models::SubscriptionPlanChangedWebhookEvent#data
+      class Data < Dodopayments::Models::Subscription
+        # @!attribute past_due_ends_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :past_due_ends_at, Time, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::SubscriptionPlanChangedWebhookEvent::Data} for more
+        #   details.
+        #
+        #   Subscription payload sent on a webhook. It carries every field of
+        #   `SubscriptionResponse`, plus the grace-period deadline.
+        #
+        #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+      end
     end
   end
 end

data/lib/dodopayments/models/subscription_renewed_webhook_event.rb

@@ -10,10 +10,11 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
-      #   Response struct representing subscription details
+      #   Subscription payload sent on a webhook. It carries every field of
+      #   `SubscriptionResponse`, plus the grace-period deadline.
       #
-      #   @return [Dodopayments::Models::Subscription]
-      required :data, -> { Dodopayments::Subscription }
+      #   @return [Dodopayments::Models::SubscriptionRenewedWebhookEvent::Data]
+      required :data, -> { Dodopayments::SubscriptionRenewedWebhookEvent::Data }
 
       # @!attribute timestamp
       #   The timestamp of when the event occurred
@@ -28,13 +29,40 @@ module Dodopayments
       required :type, const: :"subscription.renewed"
 
       # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.renewed")
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionRenewedWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
+      #   @param data [Dodopayments::Models::SubscriptionRenewedWebhookEvent::Data] Subscription payload sent on a webhook. It carries every field of
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
       #   @param type [Symbol, :"subscription.renewed"] The event type
+
+      # @see Dodopayments::Models::SubscriptionRenewedWebhookEvent#data
+      class Data < Dodopayments::Models::Subscription
+        # @!attribute past_due_ends_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :past_due_ends_at, Time, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::SubscriptionRenewedWebhookEvent::Data} for more details.
+        #
+        #   Subscription payload sent on a webhook. It carries every field of
+        #   `SubscriptionResponse`, plus the grace-period deadline.
+        #
+        #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+      end
     end
   end
 end

data/lib/dodopayments/models/subscription_status.rb

@@ -12,6 +12,7 @@ module Dodopayments
       CANCELLED = :cancelled
       FAILED = :failed
       EXPIRED = :expired
+      PAST_DUE = :past_due
 
       # @!method self.values
       #   @return [Array<Symbol>]

data/lib/dodopayments/models/subscription_unpaused_webhook_event.rb

@@ -10,10 +10,11 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
-      #   Response struct representing subscription details
+      #   Subscription payload sent on a webhook. It carries every field of
+      #   `SubscriptionResponse`, plus the grace-period deadline.
       #
-      #   @return [Dodopayments::Models::Subscription]
-      required :data, -> { Dodopayments::Subscription }
+      #   @return [Dodopayments::Models::SubscriptionUnpausedWebhookEvent::Data]
+      required :data, -> { Dodopayments::SubscriptionUnpausedWebhookEvent::Data }
 
       # @!attribute timestamp
       #   The timestamp of when the event occurred
@@ -28,13 +29,40 @@ module Dodopayments
       required :type, const: :"subscription.unpaused"
 
       # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.unpaused")
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionUnpausedWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
+      #   @param data [Dodopayments::Models::SubscriptionUnpausedWebhookEvent::Data] Subscription payload sent on a webhook. It carries every field of
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
       #   @param type [Symbol, :"subscription.unpaused"] The event type
+
+      # @see Dodopayments::Models::SubscriptionUnpausedWebhookEvent#data
+      class Data < Dodopayments::Models::Subscription
+        # @!attribute past_due_ends_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :past_due_ends_at, Time, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::SubscriptionUnpausedWebhookEvent::Data} for more details.
+        #
+        #   Subscription payload sent on a webhook. It carries every field of
+        #   `SubscriptionResponse`, plus the grace-period deadline.
+        #
+        #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+      end
     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
       #
@@ -164,6 +176,7 @@ module Dodopayments
         CANCELLED_BY_CUSTOMER = :cancelled_by_customer
         CANCELLED_BY_MERCHANT = :cancelled_by_merchant
         CANCELLED_BY_MERCHANT_SEND_DUNNING = :cancelled_by_merchant_send_dunning
+        CANCELLED_BY_MERCHANT_GRACE_PERIOD_EXPIRED = :cancelled_by_merchant_grace_period_expired
         DODO_TEAM = :dodo_team
 
         # @!method self.values

data/lib/dodopayments/models/subscription_update_payment_method_webhook_event.rb

@@ -10,10 +10,11 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
-      #   Response struct representing subscription details
+      #   Subscription payload sent on a webhook. It carries every field of
+      #   `SubscriptionResponse`, plus the grace-period deadline.
       #
-      #   @return [Dodopayments::Models::Subscription]
-      required :data, -> { Dodopayments::Subscription }
+      #   @return [Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent::Data]
+      required :data, -> { Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent::Data }
 
       # @!attribute timestamp
       #   The timestamp of when the event occurred
@@ -28,13 +29,42 @@ module Dodopayments
       required :type, const: :"subscription.update_payment_method"
 
       # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.update_payment_method")
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent} for more
+      #   details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
+      #   @param data [Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent::Data] Subscription payload sent on a webhook. It carries every field of
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
       #   @param type [Symbol, :"subscription.update_payment_method"] The event type
+
+      # @see Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent#data
+      class Data < Dodopayments::Models::Subscription
+        # @!attribute past_due_ends_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :past_due_ends_at, Time, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent::Data} for
+        #   more details.
+        #
+        #   Subscription payload sent on a webhook. It carries every field of
+        #   `SubscriptionResponse`, plus the grace-period deadline.
+        #
+        #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+      end
     end
   end
 end

data/lib/dodopayments/models/subscription_updated_webhook_event.rb

@@ -10,10 +10,11 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute data
-      #   Response struct representing subscription details
+      #   Subscription payload sent on a webhook. It carries every field of
+      #   `SubscriptionResponse`, plus the grace-period deadline.
       #
-      #   @return [Dodopayments::Models::Subscription]
-      required :data, -> { Dodopayments::Subscription }
+      #   @return [Dodopayments::Models::SubscriptionUpdatedWebhookEvent::Data]
+      required :data, -> { Dodopayments::SubscriptionUpdatedWebhookEvent::Data }
 
       # @!attribute timestamp
       #   The timestamp of when the event occurred
@@ -28,13 +29,40 @@ module Dodopayments
       required :type, const: :"subscription.updated"
 
       # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.updated")
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionUpdatedWebhookEvent} for more details.
+      #
       #   @param business_id [String] The business identifier
       #
-      #   @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
+      #   @param data [Dodopayments::Models::SubscriptionUpdatedWebhookEvent::Data] Subscription payload sent on a webhook. It carries every field of
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
       #   @param type [Symbol, :"subscription.updated"] The event type
+
+      # @see Dodopayments::Models::SubscriptionUpdatedWebhookEvent#data
+      class Data < Dodopayments::Models::Subscription
+        # @!attribute past_due_ends_at
+        #   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.
+        #
+        #   @return [Time, nil]
+        optional :past_due_ends_at, Time, nil?: true
+
+        # @!method initialize(past_due_ends_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::SubscriptionUpdatedWebhookEvent::Data} for more details.
+        #
+        #   Subscription payload sent on a webhook. It carries every field of
+        #   `SubscriptionResponse`, plus the grace-period deadline.
+        #
+        #   @param past_due_ends_at [Time, nil] Time when the grace period ends. The subscription moves to `on_hold` or
+      end
     end
   end
 end

data/lib/dodopayments/models/unsafe_unwrap_webhook_event.rb

@@ -89,6 +89,8 @@ module Dodopayments
 
       variant :"subscription.on_hold", -> { Dodopayments::SubscriptionOnHoldWebhookEvent }
 
+      variant :"subscription.past_due", -> { Dodopayments::SubscriptionPastDueWebhookEvent }
+
       variant :"subscription.paused", -> { Dodopayments::SubscriptionPausedWebhookEvent }
 
       variant :"subscription.plan_changed", -> { Dodopayments::SubscriptionPlanChangedWebhookEvent }
@@ -103,7 +105,7 @@ module Dodopayments
       variant :"subscription.updated", -> { Dodopayments::SubscriptionUpdatedWebhookEvent }
 
       # @!method self.variants
-      #   @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPausedWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUnpausedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
+      #   @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPastDueWebhookEvent, Dodopayments::Models::SubscriptionPausedWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUnpausedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
     end
   end
 end

data/lib/dodopayments/models/unwrap_webhook_event.rb

@@ -89,6 +89,8 @@ module Dodopayments
 
       variant :"subscription.on_hold", -> { Dodopayments::SubscriptionOnHoldWebhookEvent }
 
+      variant :"subscription.past_due", -> { Dodopayments::SubscriptionPastDueWebhookEvent }
+
       variant :"subscription.paused", -> { Dodopayments::SubscriptionPausedWebhookEvent }
 
       variant :"subscription.plan_changed", -> { Dodopayments::SubscriptionPlanChangedWebhookEvent }
@@ -103,7 +105,7 @@ module Dodopayments
       variant :"subscription.updated", -> { Dodopayments::SubscriptionUpdatedWebhookEvent }
 
       # @!method self.variants
-      #   @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPausedWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUnpausedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
+      #   @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPastDueWebhookEvent, Dodopayments::Models::SubscriptionPausedWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUnpausedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
     end
   end
 end

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.