dodopayments 2.33.0 → 2.35.0

data/lib/dodopayments/models/meter_retrieve_params.rb

@@ -12,8 +12,25 @@ module Dodopayments
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute locale
+      #   Shows the translated name, description and unit of the catalog entities in this
+      #   locale. The value must be a code from `GET /locales`, for example `fr`. A field
+      #   with no translation, an unknown code, or no code shows the base text.
+      #
+      #   Do not send a text from a localized response back in a create or update request.
+      #   The base text then changes to the translated text.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!method initialize(id:, locale: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::MeterRetrieveParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param locale [String] Shows the translated name, description and unit of the catalog entities in this
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/meter_update_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Meters#update
+    class MeterUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute description
+      #   Description of the meter. Send `null` to remove the description. Omit it to keep
+      #   it.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute measurement_unit
+      #   Measurement unit
+      #
+      #   @return [String, nil]
+      optional :measurement_unit, String, nil?: true
+
+      # @!attribute name
+      #   Name of the meter
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!method initialize(id:, description: nil, measurement_unit: nil, name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::MeterUpdateParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param description [String, nil] Description of the meter. Send `null` to remove the description. Omit it to keep
+      #
+      #   @param measurement_unit [String, nil] Measurement unit
+      #
+      #   @param name [String, nil] Name of the meter
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/meters/translation_delete_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Meters
+      # @see Dodopayments::Resources::Meters::Translations#delete
+      class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!method initialize(id:, locale:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Meters::TranslationDeleteParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/meters/translation_list_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Meters
+      # @see Dodopayments::Resources::Meters::Translations#list
+      class TranslationListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   Returns only these locales, for example `?locale=fr&locale=de`. With no value,
+        #   the response has all the locales.
+        #
+        #   @return [Array<String>, nil]
+        optional :locale, Dodopayments::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, locale: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Meters::TranslationListParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Array<String>] Returns only these locales, for example `?locale=fr&locale=de`. With no value, t
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/meters/translation_update_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Meters
+      # @see Dodopayments::Resources::Meters::Translations#update
+      class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute locale
+        #   A locale that the checkout and the customer portal can show.
+        #
+        #   The codes are a copy of the checkout locales. `GET /locales` lists them.
+        #
+        #   @return [Symbol, Dodopayments::Models::Locale]
+        required :locale, enum: -> { Dodopayments::Locale }
+
+        # @!attribute description
+        #   The translated description.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   The translated name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(id:, locale:, description: nil, name: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Meters::TranslationUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
+        #
+        #   @param description [String, nil] The translated description.
+        #
+        #   @param name [String, nil] The translated name.
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/misc_list_locales_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Misc#list_locales
+    class MiscListLocalesParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/misc_list_locales_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @type [Dodopayments::Internal::Type::Converter]
+    MiscListLocalesResponse = Dodopayments::Internal::Type::ArrayOf[-> { Dodopayments::LocaleInfo }]
+  end
+end

data/lib/dodopayments/models/payment.rb

@@ -52,6 +52,14 @@ module Dodopayments
       #   @return [Array<Dodopayments::Models::Dispute>]
       required :disputes, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Dispute] }
 
+      # @!attribute includes_usage
+      #   True when this payment also bills metered usage or credit overage. The usage is
+      #   for the billing cycle before the service period, not for the service period. The
+      #   value is set for each payment status. It is false when `charge_type` is null.
+      #
+      #   @return [Boolean]
+      required :includes_usage, Dodopayments::Internal::Type::Boolean
+
       # @!attribute is_multi_subscription
       #   True when one payment starts more than one subscription. Read this field to find
       #   the payment type. Do not read the length of `subscription_ids`. Do not read
@@ -105,7 +113,10 @@ module Dodopayments
       #   the same as `subscription_ids`. For a plan change charge, the period starts at
       #   the plan change and ends at the next billing date. The list is empty unless the
       #   payment status is `succeeded`. The list is also empty for a one-time payment, an
-      #   on-demand charge, or a payment method update.
+      #   on-demand charge, or a payment method update. The list is set for `new`,
+      #   `renewal` and `plan_change` charges that succeeded. It can be empty for some
+      #   zero-amount payments. A `renewal` with no entry for its subscription bills usage
+      #   only. That payment does not extend the service period.
       #
       #   @return [Array<Dodopayments::Models::SubscriptionServicePeriod>]
       required :service_periods,
@@ -143,6 +154,22 @@ module Dodopayments
       #   @return [Integer]
       required :total_amount, Integer
 
+      # @!attribute card_exp_month
+      #   Expiry month of the card, as two digits from `01` to `12`. For Apple Pay and
+      #   Google Pay, this is the expiry of the wallet token, which can differ from the
+      #   expiry of the physical card.
+      #
+      #   @return [String, nil]
+      optional :card_exp_month, String, nil?: true
+
+      # @!attribute card_exp_year
+      #   Expiry year of the card, as four digits, for example `2029`. For Apple Pay and
+      #   Google Pay, this is the expiry of the wallet token, which can differ from the
+      #   expiry of the physical card.
+      #
+      #   @return [String, nil]
+      optional :card_exp_year, String, nil?: true
+
       # @!attribute card_holder_name
       #   Cardholder name
       #
@@ -162,17 +189,27 @@ module Dodopayments
       optional :card_last_four, String, nil?: true
 
       # @!attribute card_network
-      #   Card network like VISA, MASTERCARD etc.
+      #   Card network, in lowercase, for example `visa`, `mastercard` or `amex`. Older
+      #   payments can carry other casing.
       #
       #   @return [String, nil]
       optional :card_network, String, nil?: true
 
       # @!attribute card_type
-      #   The type of card DEBIT or CREDIT
+      #   The type of card, in lowercase: `credit`, `debit` or `prepaid`. Older payments
+      #   can carry other casing.
       #
       #   @return [String, nil]
       optional :card_type, String, nil?: true
 
+      # @!attribute charge_type
+      #   The type of subscription charge that this payment is for. Refer to `ChargeType`.
+      #   The value is set for each payment status, not only for `succeeded`. The value is
+      #   null when this payment charges no subscription.
+      #
+      #   @return [Symbol, Dodopayments::Models::ChargeType, nil]
+      optional :charge_type, enum: -> { Dodopayments::ChargeType }, nil?: true
+
       # @!attribute checkout_session_id
       #   If payment is made using a checkout session, this field is set to the id of the
       #   session.
@@ -225,7 +262,11 @@ module Dodopayments
       optional :invoice_id, String, nil?: true
 
       # @!attribute invoice_url
-      #   URL to download the invoice PDF for this payment.
+      #   @deprecated Use `GET /invoices/payments/{payment_id}` with an API key.
+      #
+      #   DEPRECATED: Use `GET /invoices/payments/{payment_id}` with an API key. URL to
+      #   download the invoice PDF for this payment. The URL has no signed token. If the
+      #   business asks for a credential on its invoice links, the URL needs an API key.
       #
       #   @return [String, nil]
       optional :invoice_url, String, nil?: true
@@ -298,13 +339,35 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :tax, Integer, nil?: true
 
+      # @!attribute three_ds_flow
+      #   How the cardholder completed the 3DS authentication. The value is null when the
+      #   processor does not report it.
+      #
+      #   @return [Symbol, Dodopayments::Models::ThreeDSFlow, nil]
+      optional :three_ds_flow, enum: -> { Dodopayments::ThreeDSFlow }, nil?: true
+
+      # @!attribute three_ds_status
+      #   The result of the 3DS authentication, as the processor reports it. The value is
+      #   null when the processor reports no 3DS data, for example when the payment did
+      #   not use 3DS.
+      #
+      #   @return [Symbol, Dodopayments::Models::ThreeDSStatus, nil]
+      optional :three_ds_status, enum: -> { Dodopayments::ThreeDSStatus }, nil?: true
+
+      # @!attribute three_ds_version
+      #   The 3DS protocol version, for example `2.2.0`. The value is null when the
+      #   processor does not report it.
+      #
+      #   @return [String, nil]
+      optional :three_ds_version, String, nil?: true
+
       # @!attribute updated_at
       #   Timestamp when the payment was last updated
       #
       #   @return [Time, nil]
       optional :updated_at, Time, nil?: true
 
-      # @!method initialize(billing:, brand_id:, business_id:, created_at:, currency:, customer:, digital_products_delivered:, disputes:, is_multi_subscription:, is_update_payment_method:, metadata:, payment_id:, payment_provider:, refunds:, retry_attempt:, service_periods:, settlement_amount:, settlement_currency:, subscription_ids:, total_amount:, card_holder_name: nil, card_issuing_country: nil, card_last_four: nil, card_network: nil, card_type: nil, checkout_session_id: nil, custom_field_responses: nil, discount_id: nil, discounts: nil, error_code: nil, error_message: nil, invoice_id: nil, invoice_url: nil, payment_link: nil, payment_method: nil, payment_method_id: nil, payment_method_type: nil, product_cart: nil, refund_status: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
+      # @!method initialize(billing:, brand_id:, business_id:, created_at:, currency:, customer:, digital_products_delivered:, disputes:, includes_usage:, is_multi_subscription:, is_update_payment_method:, metadata:, payment_id:, payment_provider:, refunds:, retry_attempt:, service_periods:, settlement_amount:, settlement_currency:, subscription_ids:, total_amount:, card_exp_month: nil, card_exp_year: nil, card_holder_name: nil, card_issuing_country: nil, card_last_four: nil, card_network: nil, card_type: nil, charge_type: nil, checkout_session_id: nil, custom_field_responses: nil, discount_id: nil, discounts: nil, error_code: nil, error_message: nil, invoice_id: nil, invoice_url: nil, payment_link: nil, payment_method: nil, payment_method_id: nil, payment_method_type: nil, product_cart: nil, refund_status: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, three_ds_flow: nil, three_ds_status: nil, three_ds_version: nil, updated_at: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Payment} for more details.
       #
@@ -324,6 +387,8 @@ module Dodopayments
       #
       #   @param disputes [Array<Dodopayments::Models::Dispute>] List of disputes associated with this payment
       #
+      #   @param includes_usage [Boolean] True when this payment also bills metered usage or credit overage. The usage is
+      #
       #   @param is_multi_subscription [Boolean] True when one payment starts more than one subscription. Read this field
       #
       #   @param is_update_payment_method [Boolean] Whether this payment was created solely to update a subscription's
@@ -348,15 +413,21 @@ module Dodopayments
       #
       #   @param total_amount [Integer] Total amount charged to the customer including tax, in the currency's smallest u
       #
+      #   @param card_exp_month [String, nil] Expiry month of the card, as two digits from `01` to `12`. For Apple Pay and
+      #
+      #   @param card_exp_year [String, nil] Expiry year of the card, as four digits, for example `2029`. For Apple Pay and
+      #
       #   @param card_holder_name [String, nil] Cardholder name
       #
       #   @param card_issuing_country [Symbol, Dodopayments::Models::CountryCode, nil] ISO2 country code of the card
       #
       #   @param card_last_four [String, nil] The last four digits of the card
       #
-      #   @param card_network [String, nil] Card network like VISA, MASTERCARD etc.
+      #   @param card_network [String, nil] Card network, in lowercase, for example `visa`, `mastercard` or `amex`. Older pa
+      #
+      #   @param card_type [String, nil] The type of card, in lowercase: `credit`, `debit` or `prepaid`. Older payments c
       #
-      #   @param card_type [String, nil] The type of card DEBIT or CREDIT
+      #   @param charge_type [Symbol, Dodopayments::Models::ChargeType, nil] The type of subscription charge that this payment is for. Refer to `ChargeType`.
       #
       #   @param checkout_session_id [String, nil] If payment is made using a checkout session,
       #
@@ -372,7 +443,7 @@ module Dodopayments
       #
       #   @param invoice_id [String, nil] Invoice ID for this payment. Uses India-specific invoice ID if available.
       #
-      #   @param invoice_url [String, nil] URL to download the invoice PDF for this payment.
+      #   @param invoice_url [String, nil] DEPRECATED: Use `GET /invoices/payments/{payment_id}` with an API key.
       #
       #   @param payment_link [String, nil] Checkout URL
       #
@@ -394,6 +465,12 @@ module Dodopayments
       #
       #   @param tax [Integer, nil] Amount of tax collected in the currency's smallest unit
       #
+      #   @param three_ds_flow [Symbol, Dodopayments::Models::ThreeDSFlow, nil] How the cardholder completed the 3DS authentication. The value is null when the
+      #
+      #   @param three_ds_status [Symbol, Dodopayments::Models::ThreeDSStatus, nil] The result of the 3DS authentication, as the processor reports it. The value is
+      #
+      #   @param three_ds_version [String, nil] The 3DS protocol version, for example `2.2.0`. The value is null when the proces
+      #
       #   @param updated_at [Time, nil] Timestamp when the payment was last updated
 
       # Which processor handled this payment. `stripe` / `adyen` for BYOP routes (the

data/lib/dodopayments/models/payment_list_response.rb

@@ -34,6 +34,14 @@ module Dodopayments
       #   @return [Boolean]
       required :has_license_key, Dodopayments::Internal::Type::Boolean
 
+      # @!attribute includes_usage
+      #   True when this payment also bills metered usage or credit overage. The usage is
+      #   for the billing cycle before the service period, not for the service period. The
+      #   value is set for each payment status. It is false when `charge_type` is null.
+      #
+      #   @return [Boolean]
+      required :includes_usage, Dodopayments::Internal::Type::Boolean
+
       # @!attribute is_multi_subscription
       #   True when one payment starts more than one subscription. Read this field to find
       #   the payment type. Do not read the length of `subscription_ids`. Do not read
@@ -73,7 +81,10 @@ module Dodopayments
       #   the same as `subscription_ids`. For a plan change charge, the period starts at
       #   the plan change and ends at the next billing date. The list is empty unless the
       #   payment status is `succeeded`. The list is also empty for a one-time payment, an
-      #   on-demand charge, or a payment method update.
+      #   on-demand charge, or a payment method update. The list is set for `new`,
+      #   `renewal` and `plan_change` charges that succeeded. It can be empty for some
+      #   zero-amount payments. A `renewal` with no entry for its subscription bills usage
+      #   only. That payment does not extend the service period.
       #
       #   @return [Array<Dodopayments::Models::SubscriptionServicePeriod>]
       required :service_periods,
@@ -92,6 +103,22 @@ module Dodopayments
       #   @return [Integer]
       required :total_amount, Integer
 
+      # @!attribute card_exp_month
+      #   Expiry month of the card, as two digits from `01` to `12`. For Apple Pay and
+      #   Google Pay, this is the expiry of the wallet token, which can differ from the
+      #   expiry of the physical card.
+      #
+      #   @return [String, nil]
+      optional :card_exp_month, String, nil?: true
+
+      # @!attribute card_exp_year
+      #   Expiry year of the card, as four digits, for example `2029`. For Apple Pay and
+      #   Google Pay, this is the expiry of the wallet token, which can differ from the
+      #   expiry of the physical card.
+      #
+      #   @return [String, nil]
+      optional :card_exp_year, String, nil?: true
+
       # @!attribute card_last_four
       #   The last four digits of the card
       #
@@ -99,11 +126,27 @@ module Dodopayments
       optional :card_last_four, String, nil?: true
 
       # @!attribute card_network
-      #   Card network like VISA, MASTERCARD etc.
+      #   Card network, in lowercase, for example `visa`, `mastercard` or `amex`. Older
+      #   payments can carry other casing.
       #
       #   @return [String, nil]
       optional :card_network, String, nil?: true
 
+      # @!attribute card_type
+      #   The type of card, in lowercase: `credit`, `debit` or `prepaid`. Older payments
+      #   can carry other casing.
+      #
+      #   @return [String, nil]
+      optional :card_type, String, nil?: true
+
+      # @!attribute charge_type
+      #   The type of subscription charge that this payment is for. Refer to `ChargeType`.
+      #   The value is set for each payment status, not only for `succeeded`. The value is
+      #   null when this payment charges no subscription.
+      #
+      #   @return [Symbol, Dodopayments::Models::ChargeType, nil]
+      optional :charge_type, enum: -> { Dodopayments::ChargeType }, nil?: true
+
       # @!attribute checkout_session_id
       #   The ID of the checkout session for this payment. The value is null when the
       #   payment does not use a checkout session.
@@ -124,7 +167,11 @@ module Dodopayments
       optional :invoice_id, String, nil?: true
 
       # @!attribute invoice_url
-      #   URL to download the invoice PDF for this payment.
+      #   @deprecated Use `GET /invoices/payments/{payment_id}` with an API key.
+      #
+      #   DEPRECATED: Use `GET /invoices/payments/{payment_id}` with an API key. URL to
+      #   download the invoice PDF for this payment. The URL has no signed token. If the
+      #   business asks for a credential on its invoice links, the URL needs an API key.
       #
       #   @return [String, nil]
       optional :invoice_url, String, nil?: true
@@ -156,7 +203,29 @@ module Dodopayments
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!method initialize(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, has_license_key:, is_multi_subscription:, metadata:, payment_id:, payment_provider:, retry_attempt:, service_periods:, subscription_ids:, total_amount:, card_last_four: nil, card_network: nil, checkout_session_id: nil, dispute_status: nil, invoice_id: nil, invoice_url: nil, payment_method: nil, payment_method_type: nil, refund_status: nil, status: nil, subscription_id: nil)
+      # @!attribute three_ds_flow
+      #   How the cardholder completed the 3DS authentication. The value is null when the
+      #   processor does not report it.
+      #
+      #   @return [Symbol, Dodopayments::Models::ThreeDSFlow, nil]
+      optional :three_ds_flow, enum: -> { Dodopayments::ThreeDSFlow }, nil?: true
+
+      # @!attribute three_ds_status
+      #   The result of the 3DS authentication, as the processor reports it. The value is
+      #   null when the processor reports no 3DS data, for example when the payment did
+      #   not use 3DS.
+      #
+      #   @return [Symbol, Dodopayments::Models::ThreeDSStatus, nil]
+      optional :three_ds_status, enum: -> { Dodopayments::ThreeDSStatus }, nil?: true
+
+      # @!attribute three_ds_version
+      #   The 3DS protocol version, for example `2.2.0`. The value is null when the
+      #   processor does not report it.
+      #
+      #   @return [String, nil]
+      optional :three_ds_version, String, nil?: true
+
+      # @!method initialize(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, has_license_key:, includes_usage:, is_multi_subscription:, metadata:, payment_id:, payment_provider:, retry_attempt:, service_periods:, subscription_ids:, total_amount:, card_exp_month: nil, card_exp_year: nil, card_last_four: nil, card_network: nil, card_type: nil, charge_type: nil, checkout_session_id: nil, dispute_status: nil, invoice_id: nil, invoice_url: nil, payment_method: nil, payment_method_type: nil, refund_status: nil, status: nil, subscription_id: nil, three_ds_flow: nil, three_ds_status: nil, three_ds_version: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::PaymentListResponse} for more details.
       #
@@ -172,6 +241,8 @@ module Dodopayments
       #
       #   @param has_license_key [Boolean]
       #
+      #   @param includes_usage [Boolean] True when this payment also bills metered usage or credit overage. The usage is
+      #
       #   @param is_multi_subscription [Boolean] True when one payment starts more than one subscription. Read this field
       #
       #   @param metadata [Hash{Symbol=>String, Float, Boolean}] Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
@@ -188,9 +259,17 @@ module Dodopayments
       #
       #   @param total_amount [Integer]
       #
+      #   @param card_exp_month [String, nil] Expiry month of the card, as two digits from `01` to `12`. For Apple Pay and
+      #
+      #   @param card_exp_year [String, nil] Expiry year of the card, as four digits, for example `2029`. For Apple Pay and
+      #
       #   @param card_last_four [String, nil] The last four digits of the card
       #
-      #   @param card_network [String, nil] Card network like VISA, MASTERCARD etc.
+      #   @param card_network [String, nil] Card network, in lowercase, for example `visa`, `mastercard` or `amex`. Older pa
+      #
+      #   @param card_type [String, nil] The type of card, in lowercase: `credit`, `debit` or `prepaid`. Older payments c
+      #
+      #   @param charge_type [Symbol, Dodopayments::Models::ChargeType, nil] The type of subscription charge that this payment is for. Refer to `ChargeType`.
       #
       #   @param checkout_session_id [String, nil] The ID of the checkout session for this payment. The value is null when
       #
@@ -198,7 +277,7 @@ module Dodopayments
       #
       #   @param invoice_id [String, nil] Invoice ID for this payment. Uses India-specific invoice ID if available.
       #
-      #   @param invoice_url [String, nil] URL to download the invoice PDF for this payment.
+      #   @param invoice_url [String, nil] DEPRECATED: Use `GET /invoices/payments/{payment_id}` with an API key.
       #
       #   @param payment_method [String, nil]
       #
@@ -209,6 +288,12 @@ module Dodopayments
       #   @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
       #
       #   @param subscription_id [String, nil]
+      #
+      #   @param three_ds_flow [Symbol, Dodopayments::Models::ThreeDSFlow, nil] How the cardholder completed the 3DS authentication. The value is null when the
+      #
+      #   @param three_ds_status [Symbol, Dodopayments::Models::ThreeDSStatus, nil] The result of the 3DS authentication, as the processor reports it. The value is
+      #
+      #   @param three_ds_version [String, nil] The 3DS protocol version, for example `2.2.0`. The value is null when the proces
 
       # Which processor handled this payment. `stripe` / `adyen` for BYOP routes (the
       # merchant's own payment connector); `dodo` for everything Dodo processed itself.

data/lib/dodopayments/models/payment_retrieve_line_items_params.rb

@@ -12,8 +12,21 @@ module Dodopayments
       #   @return [String]
       required :payment_id, String
 
-      # @!method initialize(payment_id:, request_options: {})
+      # @!attribute currency
+      #   The currency of the amounts. It must be the currency that the customer paid in.
+      #   Without it, the amounts are in the settlement currency.
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency, nil]
+      optional :currency, enum: -> { Dodopayments::Currency }
+
+      # @!method initialize(payment_id:, currency: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::PaymentRetrieveLineItemsParams} for more details.
+      #
       #   @param payment_id [String]
+      #
+      #   @param currency [Symbol, Dodopayments::Models::Currency] The currency of the amounts. It must be the currency that the customer paid in.
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/payment_retrieve_line_items_response.rb

@@ -15,9 +15,18 @@ module Dodopayments
       required :items,
                -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::PaymentRetrieveLineItemsResponse::Item] }
 
-      # @!method initialize(currency:, items:)
+      # @!attribute partial_refund_allowed
+      #   False when the payment method does not allow a partial refund of this payment.
+      #
+      #   @return [Boolean]
+      required :partial_refund_allowed, Dodopayments::Internal::Type::Boolean
+
+      # @!method initialize(currency:, items:, partial_refund_allowed:)
       #   @param currency [Symbol, Dodopayments::Models::Currency]
+      #
       #   @param items [Array<Dodopayments::Models::PaymentRetrieveLineItemsResponse::Item>]
+      #
+      #   @param partial_refund_allowed [Boolean] False when the payment method does not allow a partial refund of this payment.
 
       class Item < Dodopayments::Internal::Type::BaseModel
         # @!attribute amount

data/lib/dodopayments/models/payouts/breakup/detail_list_response.rb

@@ -42,7 +42,9 @@ module Dodopayments
           #   Amount in the payout's currency, in that currency's smallest unit (cents for
           #   USD, yen for JPY, fils for KWD). The entry is converted at the rate the payout
           #   settled at. These amounts sum to the value of the entries, which can be less
-          #   than the payout: the grouped breakup reports the difference as `unattributed`.
+          #   than the payout: the grouped breakup reports the difference as `unattributed`. A
+          #   settlement batch payout shows the native amount of a row in the payout's
+          #   currency, and 0 for a row in a different currency.
           #
           #   @return [Integer]
           required :payout_currency_amount, Integer

data/lib/dodopayments/models/payouts/breakup_retrieve_response.rb

@@ -7,7 +7,8 @@ module Dodopayments
         # @!attribute event_type
         #   The type of balance ledger event (e.g., "payment", "refund", "dispute",
         #   "payment_fees"), or `unattributed` for the payout amount the entries do not
-        #   account for.
+        #   account for. A settlement batch payout shows `carried_over` for its opening
+        #   balance and the entries dated before that row.
         #
         #   @return [String]
         required :event_type, String