dodopayments 1.61.6 → 1.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b50d70de55f74c1199d1aac9de0ffec719fadaeebe3b911ff9cd818e7a886e
-  data.tar.gz: 47fd55446620af48ba520be1043cfd2fa23556968ca1e31d7afd8e04574fe440
+  metadata.gz: '0941dd898c79a72b7f81f3d3f5aa8527a390fc143e7e724491f47cadbb166bdb'
+  data.tar.gz: 8dd29cb14f5a2bf600175bcc087cb81d2ba777f02fae0bc87454f1080e486a3b
 SHA512:
-  metadata.gz: d37605eddd2d912f7acda7253674a6e442799d6087fb145a43ca03c932db3cc6ff8503781280571db15ad605c93bb48d759bf763ae89c6a265e759570397954e
-  data.tar.gz: 3c88746c7e69d59780bf748361dc18d032019a5f56e1e8289a8844cb751c7a6fcda76b33854534020e8e95e70da40cae28eaa14654fd3ba524a7cdda151724ed
+  metadata.gz: d0eed93cc1ac1e28912bb8c9b0050db1984b87de08c39fda3231858663f7dabb46b74d9765a42deee8f2835e09662ba6221f7cf986b1a5b9b1ff222166d7fa4f
+  data.tar.gz: c3a221873724e7bd198d94675eaeda38538a30d6fdc9a987adb469ed8c056e3491c9cfdffb6ff3ca26a2a41f1200c7534d0df76c7e26f3f92b939edc212755e0

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.66.0 (2025-12-08)
+
+Full Changelog: [v1.61.7...v1.66.0](https://github.com/dodopayments/dodopayments-ruby/compare/v1.61.7...v1.66.0)
+
+### Features
+
+* **api:** updated openapi spec to v1.66.1 ([b7f15c5](https://github.com/dodopayments/dodopayments-ruby/commit/b7f15c5801d7d6e2523a11e5ca2d0c807c202e89))
+
+## 1.61.7 (2025-12-03)
+
+Full Changelog: [v1.61.6...v1.61.7](https://github.com/dodopayments/dodopayments-ruby/compare/v1.61.6...v1.61.7)
+
+### Chores
+
+* **internal:** codegen related update ([bb2f57b](https://github.com/dodopayments/dodopayments-ruby/commit/bb2f57bef749534bcbe159f2e5bf351510c7c4f7))
+
 ## 1.61.6 (2025-11-21)
 
 Full Changelog: [v1.61.5...v1.61.6](https://github.com/dodopayments/dodopayments-ruby/compare/v1.61.5...v1.61.6)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "dodopayments", "~> 1.61.6"
+gem "dodopayments", "~> 1.66.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/dodopayments/internal/type/union.rb

@@ -6,16 +6,14 @@ module Dodopayments
       # @api private
       #
       # @example
-      #   # `unsafe_unwrap_webhook_event` is a `Dodopayments::UnsafeUnwrapWebhookEvent`
-      #   case unsafe_unwrap_webhook_event
-      #   when Dodopayments::DisputeAcceptedWebhookEvent
-      #     puts(unsafe_unwrap_webhook_event.business_id)
-      #   when Dodopayments::DisputeCancelledWebhookEvent
-      #     puts(unsafe_unwrap_webhook_event.data)
-      #   when Dodopayments::DisputeChallengedWebhookEvent
-      #     puts(unsafe_unwrap_webhook_event.timestamp)
+      #   # `customer_request` is a `Dodopayments::CustomerRequest`
+      #   case customer_request
+      #   when Dodopayments::AttachExistingCustomer
+      #     puts(customer_request.customer_id)
+      #   when Dodopayments::NewCustomer
+      #     puts(customer_request.email)
       #   else
-      #     puts(unsafe_unwrap_webhook_event)
+      #     puts(customer_request)
       #   end
       module Union
         include Dodopayments::Internal::Type::Converter

data/lib/dodopayments/models/billing_address.rb

@@ -3,46 +3,46 @@
 module Dodopayments
   module Models
     class BillingAddress < Dodopayments::Internal::Type::BaseModel
-      # @!attribute city
-      #   City name
-      #
-      #   @return [String]
-      required :city, String
-
       # @!attribute country
       #   Two-letter ISO country code (ISO 3166-1 alpha-2)
       #
       #   @return [Symbol, Dodopayments::Models::CountryCode]
       required :country, enum: -> { Dodopayments::CountryCode }
 
+      # @!attribute city
+      #   City name
+      #
+      #   @return [String, nil]
+      optional :city, String, nil?: true
+
       # @!attribute state
       #   State or province name
       #
-      #   @return [String]
-      required :state, String
+      #   @return [String, nil]
+      optional :state, String, nil?: true
 
       # @!attribute street
       #   Street address including house number and unit/apartment if applicable
       #
-      #   @return [String]
-      required :street, String
+      #   @return [String, nil]
+      optional :street, String, nil?: true
 
       # @!attribute zipcode
       #   Postal code or ZIP code
       #
-      #   @return [String]
-      required :zipcode, String
+      #   @return [String, nil]
+      optional :zipcode, String, nil?: true
 
-      # @!method initialize(city:, country:, state:, street:, zipcode:)
-      #   @param city [String] City name
-      #
+      # @!method initialize(country:, city: nil, state: nil, street: nil, zipcode: nil)
       #   @param country [Symbol, Dodopayments::Models::CountryCode] Two-letter ISO country code (ISO 3166-1 alpha-2)
       #
-      #   @param state [String] State or province name
+      #   @param city [String, nil] City name
+      #
+      #   @param state [String, nil] State or province name
       #
-      #   @param street [String] Street address including house number and unit/apartment if applicable
+      #   @param street [String, nil] Street address including house number and unit/apartment if applicable
       #
-      #   @param zipcode [String] Postal code or ZIP code
+      #   @param zipcode [String, nil] Postal code or ZIP code
     end
   end
 end

data/lib/dodopayments/models/checkout_session_request.rb

@@ -76,6 +76,13 @@ module Dodopayments
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true
 
+      # @!attribute minimal_address
+      #   If true, only zipcode is required when confirm is true; other address fields
+      #   remain optional
+      #
+      #   @return [Boolean, nil]
+      optional :minimal_address, Dodopayments::Internal::Type::Boolean
+
       # @!attribute return_url
       #   The url to redirect after payment failure or success.
       #
@@ -93,7 +100,7 @@ module Dodopayments
       #   @return [Dodopayments::Models::CheckoutSessionRequest::SubscriptionData, nil]
       optional :subscription_data, -> { Dodopayments::CheckoutSessionRequest::SubscriptionData }, nil?: true
 
-      # @!method initialize(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, confirm: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, return_url: nil, show_saved_payment_methods: nil, subscription_data: nil)
+      # @!method initialize(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, confirm: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, minimal_address: nil, return_url: nil, show_saved_payment_methods: nil, subscription_data: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::CheckoutSessionRequest} for more details.
       #
@@ -119,6 +126,8 @@ module Dodopayments
       #
       #   @param metadata [Hash{Symbol=>String}, nil] Additional metadata associated with the payment. Defaults to empty if not provid
       #
+      #   @param minimal_address [Boolean] If true, only zipcode is required when confirm is true; other address fields rem
+      #
       #   @param return_url [String, nil] The url to redirect after payment failure or success.
       #
       #   @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer False by default

data/lib/dodopayments/models/subscription_preview_change_plan_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Subscriptions#preview_change_plan
+    class SubscriptionPreviewChangePlanParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute product_id
+      #   Unique identifier of the product to subscribe to
+      #
+      #   @return [String]
+      required :product_id, String
+
+      # @!attribute proration_billing_mode
+      #   Proration Billing Mode
+      #
+      #   @return [Symbol, Dodopayments::Models::SubscriptionPreviewChangePlanParams::ProrationBillingMode]
+      required :proration_billing_mode,
+               enum: -> { Dodopayments::SubscriptionPreviewChangePlanParams::ProrationBillingMode }
+
+      # @!attribute quantity
+      #   Number of units to subscribe for. Must be at least 1.
+      #
+      #   @return [Integer]
+      required :quantity, Integer
+
+      # @!attribute addons
+      #   Addons for the new plan. Note : Leaving this empty would remove any existing
+      #   addons
+      #
+      #   @return [Array<Dodopayments::Models::AttachAddon>, nil]
+      optional :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AttachAddon] }, nil?: true
+
+      # @!method initialize(product_id:, proration_billing_mode:, quantity:, addons: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionPreviewChangePlanParams} for more details.
+      #
+      #   @param product_id [String] Unique identifier of the product to subscribe to
+      #
+      #   @param proration_billing_mode [Symbol, Dodopayments::Models::SubscriptionPreviewChangePlanParams::ProrationBillingMode] Proration Billing Mode
+      #
+      #   @param quantity [Integer] Number of units to subscribe for. Must be at least 1.
+      #
+      #   @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      # Proration Billing Mode
+      module ProrationBillingMode
+        extend Dodopayments::Internal::Type::Enum
+
+        PRORATED_IMMEDIATELY = :prorated_immediately
+        FULL_IMMEDIATELY = :full_immediately
+        DIFFERENCE_IMMEDIATELY = :difference_immediately
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/subscription_preview_change_plan_response.rb

@@ -0,0 +1,388 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Subscriptions#preview_change_plan
+    class SubscriptionPreviewChangePlanResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute immediate_charge
+      #
+      #   @return [Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge]
+      required :immediate_charge,
+               -> { Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge }
+
+      # @!attribute new_plan
+      #   Response struct representing subscription details
+      #
+      #   @return [Dodopayments::Models::Subscription]
+      required :new_plan, -> { Dodopayments::Subscription }
+
+      # @!method initialize(immediate_charge:, new_plan:)
+      #   @param immediate_charge [Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge]
+      #
+      #   @param new_plan [Dodopayments::Models::Subscription] Response struct representing subscription details
+
+      # @see Dodopayments::Models::SubscriptionPreviewChangePlanResponse#immediate_charge
+      class ImmediateCharge < Dodopayments::Internal::Type::BaseModel
+        # @!attribute line_items
+        #
+        #   @return [Array<Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember0, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember1, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember2>]
+        required :line_items,
+                 -> { Dodopayments::Internal::Type::ArrayOf[union: Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem] }
+
+        # @!attribute summary
+        #
+        #   @return [Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::Summary]
+        required :summary,
+                 -> { Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::Summary }
+
+        # @!method initialize(line_items:, summary:)
+        #   @param line_items [Array<Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember0, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember1, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember2>]
+        #   @param summary [Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::Summary]
+
+        module LineItem
+          extend Dodopayments::Internal::Type::Union
+
+          variant -> { Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember0 }
+
+          variant -> { Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember1 }
+
+          variant -> { Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember2 }
+
+          class UnionMember0 < Dodopayments::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute currency
+            #
+            #   @return [Symbol, Dodopayments::Models::Currency]
+            required :currency, enum: -> { Dodopayments::Currency }
+
+            # @!attribute product_id
+            #
+            #   @return [String]
+            required :product_id, String
+
+            # @!attribute proration_factor
+            #
+            #   @return [Float]
+            required :proration_factor, Float
+
+            # @!attribute quantity
+            #
+            #   @return [Integer]
+            required :quantity, Integer
+
+            # @!attribute tax_inclusive
+            #
+            #   @return [Boolean]
+            required :tax_inclusive, Dodopayments::Internal::Type::Boolean
+
+            # @!attribute type
+            #
+            #   @return [Symbol, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember0::Type]
+            required :type,
+                     enum: -> { Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember0::Type }
+
+            # @!attribute unit_price
+            #
+            #   @return [Integer]
+            required :unit_price, Integer
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String, nil?: true
+
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute tax
+            #
+            #   @return [Integer, nil]
+            optional :tax, Integer, nil?: true
+
+            # @!attribute tax_rate
+            #
+            #   @return [Float, nil]
+            optional :tax_rate, Float, nil?: true
+
+            # @!method initialize(id:, currency:, product_id:, proration_factor:, quantity:, tax_inclusive:, type:, unit_price:, description: nil, name: nil, tax: nil, tax_rate: nil)
+            #   @param id [String]
+            #   @param currency [Symbol, Dodopayments::Models::Currency]
+            #   @param product_id [String]
+            #   @param proration_factor [Float]
+            #   @param quantity [Integer]
+            #   @param tax_inclusive [Boolean]
+            #   @param type [Symbol, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember0::Type]
+            #   @param unit_price [Integer]
+            #   @param description [String, nil]
+            #   @param name [String, nil]
+            #   @param tax [Integer, nil]
+            #   @param tax_rate [Float, nil]
+
+            # @see Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember0#type
+            module Type
+              extend Dodopayments::Internal::Type::Enum
+
+              SUBSCRIPTION = :subscription
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class UnionMember1 < Dodopayments::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute currency
+            #
+            #   @return [Symbol, Dodopayments::Models::Currency]
+            required :currency, enum: -> { Dodopayments::Currency }
+
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute proration_factor
+            #
+            #   @return [Float]
+            required :proration_factor, Float
+
+            # @!attribute quantity
+            #
+            #   @return [Integer]
+            required :quantity, Integer
+
+            # @!attribute tax_category
+            #   Represents the different categories of taxation applicable to various products
+            #   and services.
+            #
+            #   @return [Symbol, Dodopayments::Models::TaxCategory]
+            required :tax_category, enum: -> { Dodopayments::TaxCategory }
+
+            # @!attribute tax_inclusive
+            #
+            #   @return [Boolean]
+            required :tax_inclusive, Dodopayments::Internal::Type::Boolean
+
+            # @!attribute tax_rate
+            #
+            #   @return [Float]
+            required :tax_rate, Float
+
+            # @!attribute type
+            #
+            #   @return [Symbol, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember1::Type]
+            required :type,
+                     enum: -> { Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember1::Type }
+
+            # @!attribute unit_price
+            #
+            #   @return [Integer]
+            required :unit_price, Integer
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String, nil?: true
+
+            # @!attribute tax
+            #
+            #   @return [Integer, nil]
+            optional :tax, Integer, nil?: true
+
+            # @!method initialize(id:, currency:, name:, proration_factor:, quantity:, tax_category:, tax_inclusive:, tax_rate:, type:, unit_price:, description: nil, tax: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember1}
+            #   for more details.
+            #
+            #   @param id [String]
+            #
+            #   @param currency [Symbol, Dodopayments::Models::Currency]
+            #
+            #   @param name [String]
+            #
+            #   @param proration_factor [Float]
+            #
+            #   @param quantity [Integer]
+            #
+            #   @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
+            #
+            #   @param tax_inclusive [Boolean]
+            #
+            #   @param tax_rate [Float]
+            #
+            #   @param type [Symbol, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember1::Type]
+            #
+            #   @param unit_price [Integer]
+            #
+            #   @param description [String, nil]
+            #
+            #   @param tax [Integer, nil]
+
+            # @see Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember1#type
+            module Type
+              extend Dodopayments::Internal::Type::Enum
+
+              ADDON = :addon
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class UnionMember2 < Dodopayments::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute chargeable_units
+            #
+            #   @return [String]
+            required :chargeable_units, String
+
+            # @!attribute currency
+            #
+            #   @return [Symbol, Dodopayments::Models::Currency]
+            required :currency, enum: -> { Dodopayments::Currency }
+
+            # @!attribute free_threshold
+            #
+            #   @return [Integer]
+            required :free_threshold, Integer
+
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute price_per_unit
+            #
+            #   @return [String]
+            required :price_per_unit, String
+
+            # @!attribute subtotal
+            #
+            #   @return [Integer]
+            required :subtotal, Integer
+
+            # @!attribute tax_inclusive
+            #
+            #   @return [Boolean]
+            required :tax_inclusive, Dodopayments::Internal::Type::Boolean
+
+            # @!attribute tax_rate
+            #
+            #   @return [Float]
+            required :tax_rate, Float
+
+            # @!attribute type
+            #
+            #   @return [Symbol, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember2::Type]
+            required :type,
+                     enum: -> { Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember2::Type }
+
+            # @!attribute units_consumed
+            #
+            #   @return [String]
+            required :units_consumed, String
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String, nil?: true
+
+            # @!attribute tax
+            #
+            #   @return [Integer, nil]
+            optional :tax, Integer, nil?: true
+
+            # @!method initialize(id:, chargeable_units:, currency:, free_threshold:, name:, price_per_unit:, subtotal:, tax_inclusive:, tax_rate:, type:, units_consumed:, description: nil, tax: nil)
+            #   @param id [String]
+            #   @param chargeable_units [String]
+            #   @param currency [Symbol, Dodopayments::Models::Currency]
+            #   @param free_threshold [Integer]
+            #   @param name [String]
+            #   @param price_per_unit [String]
+            #   @param subtotal [Integer]
+            #   @param tax_inclusive [Boolean]
+            #   @param tax_rate [Float]
+            #   @param type [Symbol, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember2::Type]
+            #   @param units_consumed [String]
+            #   @param description [String, nil]
+            #   @param tax [Integer, nil]
+
+            # @see Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember2#type
+            module Type
+              extend Dodopayments::Internal::Type::Enum
+
+              METER = :meter
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember0, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember1, Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::LineItem::UnionMember2)]
+        end
+
+        # @see Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge#summary
+        class Summary < Dodopayments::Internal::Type::BaseModel
+          # @!attribute currency
+          #
+          #   @return [Symbol, Dodopayments::Models::Currency]
+          required :currency, enum: -> { Dodopayments::Currency }
+
+          # @!attribute customer_credits
+          #
+          #   @return [Integer]
+          required :customer_credits, Integer
+
+          # @!attribute settlement_amount
+          #
+          #   @return [Integer]
+          required :settlement_amount, Integer
+
+          # @!attribute settlement_currency
+          #
+          #   @return [Symbol, Dodopayments::Models::Currency]
+          required :settlement_currency, enum: -> { Dodopayments::Currency }
+
+          # @!attribute total_amount
+          #
+          #   @return [Integer]
+          required :total_amount, Integer
+
+          # @!attribute settlement_tax
+          #
+          #   @return [Integer, nil]
+          optional :settlement_tax, Integer, nil?: true
+
+          # @!attribute tax
+          #
+          #   @return [Integer, nil]
+          optional :tax, Integer, nil?: true
+
+          # @!method initialize(currency:, customer_credits:, settlement_amount:, settlement_currency:, total_amount:, settlement_tax: nil, tax: nil)
+          #   @param currency [Symbol, Dodopayments::Models::Currency]
+          #   @param customer_credits [Integer]
+          #   @param settlement_amount [Integer]
+          #   @param settlement_currency [Symbol, Dodopayments::Models::Currency]
+          #   @param total_amount [Integer]
+          #   @param settlement_tax [Integer, nil]
+          #   @param tax [Integer, nil]
+        end
+      end
+    end
+  end
+end