dodopayments 2.0.0 → 2.1.1

data/rbi/dodopayments/resources/discounts.rbi

@@ -12,6 +12,7 @@ module Dodopayments
           code: T.nilable(String),
           expires_at: T.nilable(Time),
           name: T.nilable(String),
+          preserve_on_plan_change: T::Boolean,
           restricted_to: T.nilable(T::Array[String]),
           subscription_cycles: T.nilable(Integer),
           usage_limit: T.nilable(Integer),
@@ -38,6 +39,9 @@ module Dodopayments
         # When the discount expires, if ever.
         expires_at: nil,
         name: nil,
+        # Whether this discount should be preserved when a subscription changes plans.
+        # Default: false (discount is removed on plan change)
+        preserve_on_plan_change: nil,
         # List of product IDs to restrict usage (if any).
         restricted_to: nil,
         # Number of subscription billing cycles this discount is valid for. If not
@@ -72,6 +76,7 @@ module Dodopayments
           code: T.nilable(String),
           expires_at: T.nilable(Time),
           name: T.nilable(String),
+          preserve_on_plan_change: T.nilable(T::Boolean),
           restricted_to: T.nilable(T::Array[String]),
           subscription_cycles: T.nilable(Integer),
           type: T.nilable(Dodopayments::DiscountType::OrSymbol),
@@ -94,6 +99,9 @@ module Dodopayments
         code: nil,
         expires_at: nil,
         name: nil,
+        # Whether this discount should be preserved when a subscription changes plans. If
+        # not provided, the existing value is kept.
+        preserve_on_plan_change: nil,
         # If present, replaces all restricted product IDs with this new set. To remove all
         # restrictions, send empty array
         restricted_to: nil,

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -194,6 +194,7 @@ module Dodopayments
             Dodopayments::UpdateSubscriptionPlanReq::ProrationBillingMode::OrSymbol,
           quantity: Integer,
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          discount_code: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, String]),
           on_payment_failure:
             T.nilable(
@@ -214,6 +215,11 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # Optional discount code to apply to the new plan. If provided, validates and
+        # applies the discount to the plan change. If not provided and the subscription
+        # has an existing discount with `preserve_on_plan_change=true`, the existing
+        # discount will be preserved (if applicable to the new product).
+        discount_code: nil,
         # Metadata for the payment. If not passed, the metadata of the subscription will
         # be taken
         metadata: nil,
@@ -277,6 +283,7 @@ module Dodopayments
             Dodopayments::UpdateSubscriptionPlanReq::ProrationBillingMode::OrSymbol,
           quantity: Integer,
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
+          discount_code: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, String]),
           on_payment_failure:
             T.nilable(
@@ -297,6 +304,11 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
+        # Optional discount code to apply to the new plan. If provided, validates and
+        # applies the discount to the plan change. If not provided and the subscription
+        # has an existing discount with `preserve_on_plan_change=true`, the existing
+        # discount will be preserved (if applicable to the new product).
+        discount_code: nil,
         # Metadata for the payment. If not passed, the metadata of the subscription will
         # be taken
         metadata: nil,
@@ -402,19 +414,18 @@ module Dodopayments
       sig do
         params(
           subscription_id: String,
-          type:
-            Dodopayments::SubscriptionUpdatePaymentMethodParams::Type::OrSymbol,
-          payment_method_id: String,
-          return_url: T.nilable(String),
+          body:
+            T.any(
+              Dodopayments::SubscriptionUpdatePaymentMethodParams::Body::New::OrHash,
+              Dodopayments::SubscriptionUpdatePaymentMethodParams::Body::Existing::OrHash
+            ),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Models::SubscriptionUpdatePaymentMethodResponse)
       end
       def update_payment_method(
         # Subscription Id
         subscription_id,
-        type:,
-        payment_method_id:,
-        return_url: nil,
+        body:,
         request_options: {}
       )
       end

data/sig/dodopayments/models/addon_retrieve_params.rbs

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

data/sig/dodopayments/models/addon_update_images_params.rbs

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

data/sig/dodopayments/models/addon_update_params.rbs

@@ -2,6 +2,7 @@ module Dodopayments
   module Models
     type addon_update_params =
       {
+        id: String,
         currency: Dodopayments::Models::currency?,
         description: String?,
         image_id: String?,
@@ -15,6 +16,8 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor currency: Dodopayments::Models::currency?
 
       attr_accessor description: String?
@@ -28,6 +31,7 @@ module Dodopayments
       attr_accessor tax_category: Dodopayments::Models::tax_category?
 
       def initialize: (
+        id: String,
         ?currency: Dodopayments::Models::currency?,
         ?description: String?,
         ?image_id: String?,
@@ -38,6 +42,7 @@ module Dodopayments
       ) -> void
 
       def to_hash: -> {
+        id: String,
         currency: Dodopayments::Models::currency?,
         description: String?,
         image_id: String?,

data/sig/dodopayments/models/brand_retrieve_params.rbs

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

data/sig/dodopayments/models/brand_update_images_params.rbs

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

data/sig/dodopayments/models/brand_update_params.rbs

@@ -2,6 +2,7 @@ module Dodopayments
   module Models
     type brand_update_params =
       {
+        id: String,
         description: String?,
         image_id: String?,
         name: String?,
@@ -15,6 +16,8 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor description: String?
 
       attr_accessor image_id: String?
@@ -28,6 +31,7 @@ module Dodopayments
       attr_accessor url: String?
 
       def initialize: (
+        id: String,
         ?description: String?,
         ?image_id: String?,
         ?name: String?,
@@ -38,6 +42,7 @@ module Dodopayments
       ) -> void
 
       def to_hash: -> {
+        id: String,
         description: String?,
         image_id: String?,
         name: String?,

data/sig/dodopayments/models/checkout_session_retrieve_params.rbs

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

data/sig/dodopayments/models/credit_entitlement_delete_params.rbs

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

data/sig/dodopayments/models/credit_entitlement_retrieve_params.rbs

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

data/sig/dodopayments/models/credit_entitlement_undelete_params.rbs

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

data/sig/dodopayments/models/credit_entitlement_update_params.rbs

@@ -2,6 +2,7 @@ module Dodopayments
   module Models
     type credit_entitlement_update_params =
       {
+        id: String,
         currency: Dodopayments::Models::currency?,
         description: String?,
         expires_after_days: Integer?,
@@ -23,6 +24,8 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor currency: Dodopayments::Models::currency?
 
       attr_accessor description: String?
@@ -52,6 +55,7 @@ module Dodopayments
       attr_accessor unit: String?
 
       def initialize: (
+        id: String,
         ?currency: Dodopayments::Models::currency?,
         ?description: String?,
         ?expires_after_days: Integer?,
@@ -70,6 +74,7 @@ module Dodopayments
       ) -> void
 
       def to_hash: -> {
+        id: String,
         currency: Dodopayments::Models::currency?,
         description: String?,
         expires_after_days: Integer?,

data/sig/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rbs

@@ -4,6 +4,7 @@ module Dodopayments
       type balance_create_ledger_entry_params =
         {
           credit_entitlement_id: String,
+          customer_id: String,
           amount: String,
           entry_type: Dodopayments::Models::CreditEntitlements::ledger_entry_type,
           expires_at: Time?,
@@ -19,6 +20,8 @@ module Dodopayments
 
         attr_accessor credit_entitlement_id: String
 
+        attr_accessor customer_id: String
+
         attr_accessor amount: String
 
         attr_accessor entry_type: Dodopayments::Models::CreditEntitlements::ledger_entry_type
@@ -33,6 +36,7 @@ module Dodopayments
 
         def initialize: (
           credit_entitlement_id: String,
+          customer_id: String,
           amount: String,
           entry_type: Dodopayments::Models::CreditEntitlements::ledger_entry_type,
           ?expires_at: Time?,
@@ -44,6 +48,7 @@ module Dodopayments
 
         def to_hash: -> {
           credit_entitlement_id: String,
+          customer_id: String,
           amount: String,
           entry_type: Dodopayments::Models::CreditEntitlements::ledger_entry_type,
           expires_at: Time?,

data/sig/dodopayments/models/credit_entitlements/balance_list_grants_params.rbs

@@ -4,6 +4,7 @@ module Dodopayments
       type balance_list_grants_params =
         {
           credit_entitlement_id: String,
+          customer_id: String,
           page_number: Integer,
           page_size: Integer,
           status: Dodopayments::Models::CreditEntitlements::BalanceListGrantsParams::status
@@ -16,6 +17,8 @@ module Dodopayments
 
         attr_accessor credit_entitlement_id: String
 
+        attr_accessor customer_id: String
+
         attr_reader page_number: Integer?
 
         def page_number=: (Integer) -> Integer
@@ -32,6 +35,7 @@ module Dodopayments
 
         def initialize: (
           credit_entitlement_id: String,
+          customer_id: String,
           ?page_number: Integer,
           ?page_size: Integer,
           ?status: Dodopayments::Models::CreditEntitlements::BalanceListGrantsParams::status,
@@ -40,6 +44,7 @@ module Dodopayments
 
         def to_hash: -> {
           credit_entitlement_id: String,
+          customer_id: String,
           page_number: Integer,
           page_size: Integer,
           status: Dodopayments::Models::CreditEntitlements::BalanceListGrantsParams::status,

data/sig/dodopayments/models/credit_entitlements/balance_list_ledger_params.rbs

@@ -4,6 +4,7 @@ module Dodopayments
       type balance_list_ledger_params =
         {
           credit_entitlement_id: String,
+          customer_id: String,
           end_date: Time,
           page_number: Integer,
           page_size: Integer,
@@ -18,6 +19,8 @@ module Dodopayments
 
         attr_accessor credit_entitlement_id: String
 
+        attr_accessor customer_id: String
+
         attr_reader end_date: Time?
 
         def end_date=: (Time) -> Time
@@ -40,6 +43,7 @@ module Dodopayments
 
         def initialize: (
           credit_entitlement_id: String,
+          customer_id: String,
           ?end_date: Time,
           ?page_number: Integer,
           ?page_size: Integer,
@@ -50,6 +54,7 @@ module Dodopayments
 
         def to_hash: -> {
           credit_entitlement_id: String,
+          customer_id: String,
           end_date: Time,
           page_number: Integer,
           page_size: Integer,

data/sig/dodopayments/models/credit_entitlements/balance_list_params.rbs

@@ -2,13 +2,20 @@ module Dodopayments
   module Models
     module CreditEntitlements
       type balance_list_params =
-        { customer_id: String, page_number: Integer, page_size: Integer }
+        {
+          credit_entitlement_id: String,
+          customer_id: String,
+          page_number: Integer,
+          page_size: Integer
+        }
         & Dodopayments::Internal::Type::request_parameters
 
       class BalanceListParams < Dodopayments::Internal::Type::BaseModel
         extend Dodopayments::Internal::Type::RequestParameters::Converter
         include Dodopayments::Internal::Type::RequestParameters
 
+        attr_accessor credit_entitlement_id: String
+
         attr_reader customer_id: String?
 
         def customer_id=: (String) -> String
@@ -22,6 +29,7 @@ module Dodopayments
         def page_size=: (Integer) -> Integer
 
         def initialize: (
+          credit_entitlement_id: String,
           ?customer_id: String,
           ?page_number: Integer,
           ?page_size: Integer,
@@ -29,6 +37,7 @@ module Dodopayments
         ) -> void
 
         def to_hash: -> {
+          credit_entitlement_id: String,
           customer_id: String,
           page_number: Integer,
           page_size: Integer,

data/sig/dodopayments/models/credit_entitlements/balance_retrieve_params.rbs

@@ -2,7 +2,7 @@ module Dodopayments
   module Models
     module CreditEntitlements
       type balance_retrieve_params =
-        { credit_entitlement_id: String }
+        { credit_entitlement_id: String, customer_id: String }
         & Dodopayments::Internal::Type::request_parameters
 
       class BalanceRetrieveParams < Dodopayments::Internal::Type::BaseModel
@@ -11,13 +11,17 @@ module Dodopayments
 
         attr_accessor credit_entitlement_id: String
 
+        attr_accessor customer_id: String
+
         def initialize: (
           credit_entitlement_id: String,
+          customer_id: String,
           ?request_options: Dodopayments::request_opts
         ) -> void
 
         def to_hash: -> {
           credit_entitlement_id: String,
+          customer_id: String,
           request_options: Dodopayments::RequestOptions
         }
       end

data/sig/dodopayments/models/customer_list_credit_entitlements_params.rbs

@@ -1,15 +1,23 @@
 module Dodopayments
   module Models
     type customer_list_credit_entitlements_params =
-      {  } & Dodopayments::Internal::Type::request_parameters
+      { customer_id: String } & Dodopayments::Internal::Type::request_parameters
 
     class CustomerListCreditEntitlementsParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Dodopayments::request_opts) -> void
+      attr_accessor customer_id: String
 
-      def to_hash: -> { request_options: Dodopayments::RequestOptions }
+      def initialize: (
+        customer_id: String,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        customer_id: String,
+        request_options: Dodopayments::RequestOptions
+      }
     end
   end
 end

data/sig/dodopayments/models/customer_retrieve_params.rbs

@@ -1,15 +1,23 @@
 module Dodopayments
   module Models
     type customer_retrieve_params =
-      {  } & Dodopayments::Internal::Type::request_parameters
+      { customer_id: String } & Dodopayments::Internal::Type::request_parameters
 
     class CustomerRetrieveParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Dodopayments::request_opts) -> void
+      attr_accessor customer_id: String
 
-      def to_hash: -> { request_options: Dodopayments::RequestOptions }
+      def initialize: (
+        customer_id: String,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        customer_id: String,
+        request_options: Dodopayments::RequestOptions
+      }
     end
   end
 end

data/sig/dodopayments/models/customer_retrieve_payment_methods_params.rbs

@@ -1,15 +1,23 @@
 module Dodopayments
   module Models
     type customer_retrieve_payment_methods_params =
-      {  } & Dodopayments::Internal::Type::request_parameters
+      { customer_id: String } & Dodopayments::Internal::Type::request_parameters
 
     class CustomerRetrievePaymentMethodsParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Dodopayments::request_opts) -> void
+      attr_accessor customer_id: String
 
-      def to_hash: -> { request_options: Dodopayments::RequestOptions }
+      def initialize: (
+        customer_id: String,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        customer_id: String,
+        request_options: Dodopayments::RequestOptions
+      }
     end
   end
 end