dodopayments 1.81.1 → 1.84.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a887610b73292cc2ac89a288ad023df611aaf2a1757adfeab11ad0b08ecf3fa0
-  data.tar.gz: 568b8078505602e40c66d20db148de71cb16acf508d87fb82167773a8c4326f3
+  metadata.gz: '09c3a3f5b6ec355c27adb82a29968a5a1f77a9b5c64ecdd557eb5c435a964182'
+  data.tar.gz: ad01a317caf09f01e0dccebbe453d927ff5677b0a0a349731193c630942a68c0
 SHA512:
-  metadata.gz: 890ad56a9600a773c462fa6263e3c06d701167f6b4cbfd6534a481f0ae19d845897a2b68740a0eb7676d5fa55e1afd707238692e61d6f4abded5daa4927745e1
-  data.tar.gz: 045770e781bdf35663c8bfca689d49b7ab9e453cfdb01afb6d9e523f4c26c65d010b724418f70141f33c344c05f6128841f2a651bd45fc22ad0ee87308c2d11c
+  metadata.gz: 1578c6bddac804c5b7de88a8f0842ce83ce5239472dc0029b189c2b805dbdbdbd32d3aa9c4d608b4052cf8c0ccfde6e1e1538fdbd3c3a3809b323bd67600d54f
+  data.tar.gz: b984224d1b7862a61e38f368c436ee6309e02b9ae80bd79c2da2469af3150b0b44bf2594a16224264ba32ea41ea083993e988960c127e18ab163b35a8c75d625

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.84.0 (2026-02-20)
+
+Full Changelog: [v1.81.1...v1.84.0](https://github.com/dodopayments/dodopayments-ruby/compare/v1.81.1...v1.84.0)
+
+### Features
+
+* **api:** updated openapi spec to v1.84.0 ([8090496](https://github.com/dodopayments/dodopayments-ruby/commit/8090496dbdf1f5f637069e829e212308f9ecfae7))
+
+
+### Chores
+
+* update mock server docs ([c8d153d](https://github.com/dodopayments/dodopayments-ruby/commit/c8d153dffd723e3a43c5b04e534599a316ceee84))
+
 ## 1.81.1 (2026-02-07)
 
 Full Changelog: [v1.81.0...v1.81.1](https://github.com/dodopayments/dodopayments-ruby/compare/v1.81.0...v1.81.1)

data/README.md

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

data/lib/dodopayments/models/add_meter_to_price.rb

@@ -15,6 +15,12 @@ module Dodopayments
       #   @return [String]
       required :price_per_unit, String
 
+      # @!attribute credit_entitlement_id
+      #   Optional credit entitlement ID to link this meter to for credit-based billing
+      #
+      #   @return [String, nil]
+      optional :credit_entitlement_id, String, nil?: true
+
       # @!attribute description
       #   Meter description. Will ignored on Request, but will be shown in response
       #
@@ -32,13 +38,20 @@ module Dodopayments
       #   @return [String, nil]
       optional :measurement_unit, String, nil?: true
 
+      # @!attribute meter_units_per_credit
+      #   Number of meter units that equal one credit. Required when credit_entitlement_id
+      #   is set.
+      #
+      #   @return [String, nil]
+      optional :meter_units_per_credit, String, nil?: true
+
       # @!attribute name
       #   Meter name. Will ignored on Request, but will be shown in response
       #
       #   @return [String, nil]
       optional :name, String, nil?: true
 
-      # @!method initialize(meter_id:, price_per_unit:, description: nil, free_threshold: nil, measurement_unit: nil, name: nil)
+      # @!method initialize(meter_id:, price_per_unit:, credit_entitlement_id: nil, description: nil, free_threshold: nil, measurement_unit: nil, meter_units_per_credit: nil, name: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::AddMeterToPrice} for more details.
       #
@@ -46,12 +59,16 @@ module Dodopayments
       #
       #   @param price_per_unit [String] The price per unit in lowest denomination. Must be greater than zero. Supports u
       #
+      #   @param credit_entitlement_id [String, nil] Optional credit entitlement ID to link this meter to for credit-based billing
+      #
       #   @param description [String, nil] Meter description. Will ignored on Request, but will be shown in response
       #
       #   @param free_threshold [Integer, nil]
       #
       #   @param measurement_unit [String, nil] Meter measurement unit. Will ignored on Request, but will be shown in response
       #
+      #   @param meter_units_per_credit [String, nil] Number of meter units that equal one credit. Required when credit_entitlement_id
+      #
       #   @param name [String, nil] Meter name. Will ignored on Request, but will be shown in response
     end
   end

data/lib/dodopayments/models/checkout_session_flags.rb

@@ -41,6 +41,11 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :allow_customer_editing_street, Dodopayments::Internal::Type::Boolean
 
+      # @!attribute allow_customer_editing_tax_id
+      #
+      #   @return [Boolean, nil]
+      optional :allow_customer_editing_tax_id, Dodopayments::Internal::Type::Boolean
+
       # @!attribute allow_customer_editing_zipcode
       #
       #   @return [Boolean, nil]
@@ -87,7 +92,7 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :redirect_immediately, Dodopayments::Internal::Type::Boolean
 
-      # @!method initialize(allow_currency_selection: nil, allow_customer_editing_city: nil, allow_customer_editing_country: nil, allow_customer_editing_email: nil, allow_customer_editing_name: nil, allow_customer_editing_state: nil, allow_customer_editing_street: nil, allow_customer_editing_zipcode: nil, allow_discount_code: nil, allow_phone_number_collection: nil, allow_tax_id: nil, always_create_new_customer: nil, redirect_immediately: nil)
+      # @!method initialize(allow_currency_selection: nil, allow_customer_editing_city: nil, allow_customer_editing_country: nil, allow_customer_editing_email: nil, allow_customer_editing_name: nil, allow_customer_editing_state: nil, allow_customer_editing_street: nil, allow_customer_editing_tax_id: nil, allow_customer_editing_zipcode: nil, allow_discount_code: nil, allow_phone_number_collection: nil, allow_tax_id: nil, always_create_new_customer: nil, redirect_immediately: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::CheckoutSessionFlags} for more details.
       #
@@ -105,6 +110,8 @@ module Dodopayments
       #
       #   @param allow_customer_editing_street [Boolean]
       #
+      #   @param allow_customer_editing_tax_id [Boolean]
+      #
       #   @param allow_customer_editing_zipcode [Boolean]
       #
       #   @param allow_discount_code [Boolean] If the customer is allowed to apply discount code, set it to true.

data/lib/dodopayments/models/checkout_session_preview_response.rb

@@ -43,13 +43,19 @@ module Dodopayments
                -> { Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup },
                nil?: true
 
+      # @!attribute tax_id_err_msg
+      #   Error message if tax ID validation failed
+      #
+      #   @return [String, nil]
+      optional :tax_id_err_msg, String, nil?: true
+
       # @!attribute total_tax
       #   Total tax
       #
       #   @return [Integer, nil]
       optional :total_tax, Integer, nil?: true
 
-      # @!method initialize(billing_country:, currency:, current_breakup:, product_cart:, total_price:, recurring_breakup: nil, total_tax: nil)
+      # @!method initialize(billing_country:, currency:, current_breakup:, product_cart:, total_price:, recurring_breakup: nil, tax_id_err_msg: nil, total_tax: nil)
       #   Data returned by the calculate checkout session API
       #
       #   @param billing_country [Symbol, Dodopayments::Models::CountryCode] Billing country
@@ -64,6 +70,8 @@ module Dodopayments
       #
       #   @param recurring_breakup [Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup, nil] Breakup of recurring payments (None for one-time only)
       #
+      #   @param tax_id_err_msg [String, nil] Error message if tax ID validation failed
+      #
       #   @param total_tax [Integer, nil] Total tax
 
       # @see Dodopayments::Models::CheckoutSessionPreviewResponse#current_breakup
@@ -105,6 +113,13 @@ module Dodopayments
       end
 
       class ProductCart < Dodopayments::Internal::Type::BaseModel
+        # @!attribute credit_entitlements
+        #   Credit entitlements that will be granted upon purchase
+        #
+        #   @return [Array<Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::CreditEntitlement>]
+        required :credit_entitlements,
+                 -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::CreditEntitlement] }
+
         # @!attribute currency
         #   the currency in which the calculatiosn were made
         #
@@ -212,7 +227,9 @@ module Dodopayments
         #   @return [Integer, nil]
         optional :tax, Integer, nil?: true
 
-        # @!method initialize(currency:, discounted_price:, is_subscription:, is_usage_based:, meters:, og_currency:, og_price:, product_id:, quantity:, tax_category:, tax_inclusive:, tax_rate:, addons: nil, description: nil, discount_amount: nil, discount_cycle: nil, name: nil, tax: nil)
+        # @!method initialize(credit_entitlements:, currency:, discounted_price:, is_subscription:, is_usage_based:, meters:, og_currency:, og_price:, product_id:, quantity:, tax_category:, tax_inclusive:, tax_rate:, addons: nil, description: nil, discount_amount: nil, discount_cycle: nil, name: nil, tax: nil)
+        #   @param credit_entitlements [Array<Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::CreditEntitlement>] Credit entitlements that will be granted upon purchase
+        #
         #   @param currency [Symbol, Dodopayments::Models::Currency] the currency in which the calculatiosn were made
         #
         #   @param discounted_price [Integer] discounted price
@@ -249,6 +266,44 @@ module Dodopayments
         #
         #   @param tax [Integer, nil] total tax
 
+        class CreditEntitlement < Dodopayments::Internal::Type::BaseModel
+          # @!attribute credit_entitlement_id
+          #   ID of the credit entitlement
+          #
+          #   @return [String]
+          required :credit_entitlement_id, String
+
+          # @!attribute credit_entitlement_name
+          #   Name of the credit entitlement
+          #
+          #   @return [String]
+          required :credit_entitlement_name, String
+
+          # @!attribute credit_entitlement_unit
+          #   Unit label (e.g. "API Calls", "Tokens")
+          #
+          #   @return [String]
+          required :credit_entitlement_unit, String
+
+          # @!attribute credits_amount
+          #   Number of credits granted
+          #
+          #   @return [String]
+          required :credits_amount, String
+
+          # @!method initialize(credit_entitlement_id:, credit_entitlement_name:, credit_entitlement_unit:, credits_amount:)
+          #   Minimal credit entitlement info shown at checkout — what credits the customer
+          #   will receive
+          #
+          #   @param credit_entitlement_id [String] ID of the credit entitlement
+          #
+          #   @param credit_entitlement_name [String] Name of the credit entitlement
+          #
+          #   @param credit_entitlement_unit [String] Unit label (e.g. "API Calls", "Tokens")
+          #
+          #   @param credits_amount [String] Number of credits granted
+        end
+
         class Meter < Dodopayments::Internal::Type::BaseModel
           # @!attribute measurement_unit
           #

data/lib/dodopayments/models/checkout_session_request.rb

@@ -126,7 +126,14 @@ module Dodopayments
       #   @return [Dodopayments::Models::SubscriptionData, nil]
       optional :subscription_data, -> { Dodopayments::SubscriptionData }, nil?: true
 
-      # @!method initialize(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, confirm: nil, custom_fields: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil)
+      # @!attribute tax_id
+      #   Tax ID for the customer (e.g. VAT number). Requires billing_address with
+      #   country.
+      #
+      #   @return [String, nil]
+      optional :tax_id, String, nil?: true
+
+      # @!method initialize(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, confirm: nil, custom_fields: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, tax_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::CheckoutSessionRequest} for more details.
       #
@@ -167,6 +174,8 @@ module Dodopayments
       #   @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer False by default
       #
       #   @param subscription_data [Dodopayments::Models::SubscriptionData, nil]
+      #
+      #   @param tax_id [String, nil] Tax ID for the customer (e.g. VAT number). Requires billing_address with country
     end
   end
 end

data/lib/dodopayments/models/customer_update_params.rb

@@ -7,6 +7,11 @@ module Dodopayments
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 
+      # @!attribute email
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
       # @!attribute metadata
       #   Additional metadata for the customer
       #
@@ -23,7 +28,9 @@ module Dodopayments
       #   @return [String, nil]
       optional :phone_number, String, nil?: true
 
-      # @!method initialize(metadata: nil, name: nil, phone_number: nil, request_options: {})
+      # @!method initialize(email: nil, metadata: nil, name: nil, phone_number: nil, request_options: {})
+      #   @param email [String, nil]
+      #
       #   @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the customer
       #
       #   @param name [String, nil]

data/lib/dodopayments/models/payment_list_params.rb

@@ -43,6 +43,12 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :page_size, Integer
 
+      # @!attribute product_id
+      #   Filter by product id
+      #
+      #   @return [String, nil]
+      optional :product_id, String
+
       # @!attribute status
       #   Filter by status
       #
@@ -55,7 +61,7 @@ module Dodopayments
       #   @return [String, nil]
       optional :subscription_id, String
 
-      # @!method initialize(brand_id: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, subscription_id: nil, request_options: {})
+      # @!method initialize(brand_id: nil, created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, subscription_id: nil, request_options: {})
       #   @param brand_id [String] filter by Brand id
       #
       #   @param created_at_gte [Time] Get events after this created time
@@ -68,6 +74,8 @@ module Dodopayments
       #
       #   @param page_size [Integer] Page size default is 10 max is 100
       #
+      #   @param product_id [String] Filter by product id
+      #
       #   @param status [Symbol, Dodopayments::Models::PaymentListParams::Status] Filter by status
       #
       #   @param subscription_id [String] Filter by subscription id

data/lib/dodopayments/models/payment_list_response.rb

@@ -29,6 +29,11 @@ module Dodopayments
       #   @return [Boolean]
       required :digital_products_delivered, Dodopayments::Internal::Type::Boolean
 
+      # @!attribute has_license_key
+      #
+      #   @return [Boolean]
+      required :has_license_key, Dodopayments::Internal::Type::Boolean
+
       # @!attribute metadata
       #
       #   @return [Hash{Symbol=>String}]
@@ -76,7 +81,7 @@ module Dodopayments
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!method initialize(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, metadata:, payment_id:, total_amount:, invoice_id: nil, invoice_url: nil, payment_method: nil, payment_method_type: nil, status: nil, subscription_id: nil)
+      # @!method initialize(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, has_license_key:, metadata:, payment_id:, total_amount:, invoice_id: nil, invoice_url: nil, payment_method: nil, payment_method_type: nil, status: nil, subscription_id: nil)
       #   @param brand_id [String]
       #
       #   @param created_at [Time]
@@ -87,6 +92,8 @@ module Dodopayments
       #
       #   @param digital_products_delivered [Boolean]
       #
+      #   @param has_license_key [Boolean]
+      #
       #   @param metadata [Hash{Symbol=>String}]
       #
       #   @param payment_id [String]

data/lib/dodopayments/models/product.rb

@@ -21,6 +21,13 @@ module Dodopayments
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute credit_entitlements
+      #   Attached credit entitlements with settings
+      #
+      #   @return [Array<Dodopayments::Models::Product::CreditEntitlement>]
+      required :credit_entitlements,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Product::CreditEntitlement] }
+
       # @!attribute is_recurring
       #   Indicates if the product is recurring (e.g., subscriptions).
       #
@@ -116,13 +123,15 @@ module Dodopayments
       #   @return [String, nil]
       optional :product_collection_id, String, nil?: true
 
-      # @!method initialize(brand_id:, business_id:, created_at:, is_recurring:, license_key_enabled:, metadata:, price:, product_id:, tax_category:, updated_at:, addons: nil, description: nil, digital_product_delivery: nil, image: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, name: nil, product_collection_id: nil)
+      # @!method initialize(brand_id:, business_id:, created_at:, credit_entitlements:, is_recurring:, license_key_enabled:, metadata:, price:, product_id:, tax_category:, updated_at:, addons: nil, description: nil, digital_product_delivery: nil, image: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, name: nil, product_collection_id: nil)
       #   @param brand_id [String]
       #
       #   @param business_id [String] Unique identifier for the business to which the product belongs.
       #
       #   @param created_at [Time] Timestamp when the product was created.
       #
+      #   @param credit_entitlements [Array<Dodopayments::Models::Product::CreditEntitlement>] Attached credit entitlements with settings
+      #
       #   @param is_recurring [Boolean] Indicates if the product is recurring (e.g., subscriptions).
       #
       #   @param license_key_enabled [Boolean] Indicates whether the product requires a license key.
@@ -155,6 +164,200 @@ module Dodopayments
       #
       #   @param product_collection_id [String, nil] The product collection ID this product belongs to, if any
 
+      class CreditEntitlement < Dodopayments::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique ID of this mapping
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute credit_entitlement_id
+        #   ID of the credit entitlement
+        #
+        #   @return [String]
+        required :credit_entitlement_id, String
+
+        # @!attribute credit_entitlement_name
+        #   Name of the credit entitlement
+        #
+        #   @return [String]
+        required :credit_entitlement_name, String
+
+        # @!attribute credit_entitlement_unit
+        #   Unit label for the credit entitlement
+        #
+        #   @return [String]
+        required :credit_entitlement_unit, String
+
+        # @!attribute credits_amount
+        #   Number of credits granted
+        #
+        #   @return [String]
+        required :credits_amount, String
+
+        # @!attribute credits_reduce_overage
+        #   Whether new credit grants reduce existing overage
+        #
+        #   @return [Boolean]
+        required :credits_reduce_overage, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute overage_charge_at_billing
+        #   Whether overage is charged at billing
+        #
+        #   @return [Boolean]
+        required :overage_charge_at_billing, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute overage_enabled
+        #   Whether overage is enabled
+        #
+        #   @return [Boolean]
+        required :overage_enabled, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute preserve_overage_at_reset
+        #   Whether to preserve overage balance when credits reset
+        #
+        #   @return [Boolean]
+        required :preserve_overage_at_reset, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute proration_behavior
+        #   Proration behavior for credit grants during plan changes
+        #
+        #   @return [Symbol, Dodopayments::Models::Product::CreditEntitlement::ProrationBehavior]
+        required :proration_behavior, enum: -> { Dodopayments::Product::CreditEntitlement::ProrationBehavior }
+
+        # @!attribute rollover_enabled
+        #   Whether rollover is enabled
+        #
+        #   @return [Boolean]
+        required :rollover_enabled, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute trial_credits_expire_after_trial
+        #   Whether trial credits expire after trial
+        #
+        #   @return [Boolean]
+        required :trial_credits_expire_after_trial, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute currency
+        #   Currency
+        #
+        #   @return [Symbol, Dodopayments::Models::Currency, nil]
+        optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
+
+        # @!attribute expires_after_days
+        #   Days until credits expire
+        #
+        #   @return [Integer, nil]
+        optional :expires_after_days, Integer, nil?: true
+
+        # @!attribute low_balance_threshold_percent
+        #   Low balance threshold percentage
+        #
+        #   @return [Integer, nil]
+        optional :low_balance_threshold_percent, Integer, nil?: true
+
+        # @!attribute max_rollover_count
+        #   Maximum rollover cycles
+        #
+        #   @return [Integer, nil]
+        optional :max_rollover_count, Integer, nil?: true
+
+        # @!attribute overage_limit
+        #   Overage limit
+        #
+        #   @return [String, nil]
+        optional :overage_limit, String, nil?: true
+
+        # @!attribute price_per_unit
+        #   Price per unit
+        #
+        #   @return [String, nil]
+        optional :price_per_unit, String, nil?: true
+
+        # @!attribute rollover_percentage
+        #   Rollover percentage
+        #
+        #   @return [Integer, nil]
+        optional :rollover_percentage, Integer, nil?: true
+
+        # @!attribute rollover_timeframe_count
+        #   Rollover timeframe count
+        #
+        #   @return [Integer, nil]
+        optional :rollover_timeframe_count, Integer, nil?: true
+
+        # @!attribute rollover_timeframe_interval
+        #   Rollover timeframe interval
+        #
+        #   @return [Symbol, Dodopayments::Models::TimeInterval, nil]
+        optional :rollover_timeframe_interval, enum: -> { Dodopayments::TimeInterval }, nil?: true
+
+        # @!attribute trial_credits
+        #   Trial credits
+        #
+        #   @return [String, nil]
+        optional :trial_credits, String, nil?: true
+
+        # @!method initialize(id:, credit_entitlement_id:, credit_entitlement_name:, credit_entitlement_unit:, credits_amount:, credits_reduce_overage:, overage_charge_at_billing:, overage_enabled:, preserve_overage_at_reset:, proration_behavior:, rollover_enabled:, trial_credits_expire_after_trial:, currency: nil, expires_after_days: nil, low_balance_threshold_percent: nil, max_rollover_count: nil, overage_limit: nil, price_per_unit: nil, rollover_percentage: nil, rollover_timeframe_count: nil, rollover_timeframe_interval: nil, trial_credits: nil)
+        #   Response struct for credit entitlement mapping
+        #
+        #   @param id [String] Unique ID of this mapping
+        #
+        #   @param credit_entitlement_id [String] ID of the credit entitlement
+        #
+        #   @param credit_entitlement_name [String] Name of the credit entitlement
+        #
+        #   @param credit_entitlement_unit [String] Unit label for the credit entitlement
+        #
+        #   @param credits_amount [String] Number of credits granted
+        #
+        #   @param credits_reduce_overage [Boolean] Whether new credit grants reduce existing overage
+        #
+        #   @param overage_charge_at_billing [Boolean] Whether overage is charged at billing
+        #
+        #   @param overage_enabled [Boolean] Whether overage is enabled
+        #
+        #   @param preserve_overage_at_reset [Boolean] Whether to preserve overage balance when credits reset
+        #
+        #   @param proration_behavior [Symbol, Dodopayments::Models::Product::CreditEntitlement::ProrationBehavior] Proration behavior for credit grants during plan changes
+        #
+        #   @param rollover_enabled [Boolean] Whether rollover is enabled
+        #
+        #   @param trial_credits_expire_after_trial [Boolean] Whether trial credits expire after trial
+        #
+        #   @param currency [Symbol, Dodopayments::Models::Currency, nil] Currency
+        #
+        #   @param expires_after_days [Integer, nil] Days until credits expire
+        #
+        #   @param low_balance_threshold_percent [Integer, nil] Low balance threshold percentage
+        #
+        #   @param max_rollover_count [Integer, nil] Maximum rollover cycles
+        #
+        #   @param overage_limit [String, nil] Overage limit
+        #
+        #   @param price_per_unit [String, nil] Price per unit
+        #
+        #   @param rollover_percentage [Integer, nil] Rollover percentage
+        #
+        #   @param rollover_timeframe_count [Integer, nil] Rollover timeframe count
+        #
+        #   @param rollover_timeframe_interval [Symbol, Dodopayments::Models::TimeInterval, nil] Rollover timeframe interval
+        #
+        #   @param trial_credits [String, nil] Trial credits
+
+        # Proration behavior for credit grants during plan changes
+        #
+        # @see Dodopayments::Models::Product::CreditEntitlement#proration_behavior
+        module ProrationBehavior
+          extend Dodopayments::Internal::Type::Enum
+
+          PRORATE = :prorate
+          NO_PRORATE = :no_prorate
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see Dodopayments::Models::Product#digital_product_delivery
       class DigitalProductDelivery < Dodopayments::Internal::Type::BaseModel
         # @!attribute external_url