whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/payment.rb

@@ -72,10 +72,10 @@ module WhopSDK
       required :created_at, Time
 
       # @!attribute currency
-      #   The available currencies on the platform
+      #   The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
       #
-      #   @return [Symbol, WhopSDK::Models::Currency, nil]
-      required :currency, enum: -> { WhopSDK::Currency }, nil?: true
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :currency, enum: -> { WhopSDK::Currency }
 
       # @!attribute dispute_alerted_at
       #   When an alert came in that this transaction will be disputed
@@ -205,6 +205,13 @@ module WhopSDK
       #   @return [Time, nil]
       required :refunded_at, Time, nil?: true
 
+      # @!attribute refunds
+      #   The refunds issued against this payment, newest first, including failed and
+      #   canceled refund attempts. Limited to the 100 most recent.
+      #
+      #   @return [Array<WhopSDK::Models::Payment::Refund>]
+      required :refunds, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Payment::Refund] }
+
       # @!attribute resolutions
       #   The resolution center cases opened by the customer on this payment. Null if the
       #   actor in context does not have the payment:resolution_center_case:read
@@ -221,28 +228,48 @@ module WhopSDK
       #   @return [Boolean]
       required :retryable, WhopSDK::Internal::Type::Boolean
 
+      # @!attribute risk_score
+      #   Whop's in-house fraud risk score for this payment, from 0 (lowest risk) to 100
+      #   (highest risk). Null when the payment has not been scored or scoring has not yet
+      #   completed.
+      #
+      #   @return [Integer, nil]
+      required :risk_score, Integer, nil?: true
+
+      # @!attribute risk_signals
+      #   A curated set of factors behind the risk score, grouped by category (business
+      #   transaction history, buyer, device). Each entry has a key, human-readable label,
+      #   category, and value. Null when there is no risk assessment for this payment.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :risk_signals, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
       # @!attribute settlement_amount
-      #   The payment amount in the creator's settlement currency (what the creator priced
-      #   in). Equal to final_amount for single-currency payments.
+      #   The total amount charged to the customer for this payment, including taxes and
+      #   after any discounts. In the currency specified by the currency field.
       #
       #   @return [Float]
       required :settlement_amount, Float
 
       # @!attribute settlement_currency
-      #   The currency in which the creator receives payouts and fees are charged (e.g.,
-      #   'usd', 'eur'). For multi-currency payments this differs from the payment
-      #   currency.
+      #   The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
       #
-      #   @return [String]
-      required :settlement_currency, String
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :settlement_currency, enum: -> { WhopSDK::Currency }
 
       # @!attribute settlement_exchange_rate
-      #   The locked exchange rate used to convert from the buyer's payment currency to
-      #   the creator's settlement currency. Null for single-currency payments.
+      #   Deprecated. Always returns null.
       #
       #   @return [Float, nil]
       required :settlement_exchange_rate, Float, nil?: true
 
+      # @!attribute shipping_address
+      #   The shipping address provided by the customer for physical goods. Null if no
+      #   shipping address was collected.
+      #
+      #   @return [WhopSDK::Models::Payment::ShippingAddress, nil]
+      required :shipping_address, -> { WhopSDK::Payment::ShippingAddress }, nil?: true
+
       # @!attribute status
       #   The status of a receipt
       #
@@ -280,6 +307,12 @@ module WhopSDK
       #   @return [Float, nil]
       required :tax_refunded_amount, Float, nil?: true
 
+      # @!attribute three_ds_verified
+      #   Whether 3D Secure authentication was completed for this payment.
+      #
+      #   @return [Boolean]
+      required :three_ds_verified, WhopSDK::Internal::Type::Boolean
+
       # @!attribute total
       #   The total to show to the creator (excluding buyer fees).
       #
@@ -311,7 +344,7 @@ module WhopSDK
       #   @return [Boolean]
       required :voidable, WhopSDK::Internal::Type::Boolean
 
-      # @!method initialize(id:, amount_after_fees:, application_fee:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, checkout_configuration_id:, company:, created_at:, currency:, dispute_alerted_at:, disputes:, failure_message:, financing_installments_count:, financing_transactions:, last_payment_attempt:, member:, membership:, metadata:, next_payment_attempt:, paid_at:, payment_method:, payment_method_type:, payments_failed:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, resolutions:, retryable:, settlement_amount:, settlement_currency:, settlement_exchange_rate:, status:, substatus:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, total:, updated_at:, usd_total:, user:, voidable:)
+      # @!method initialize(id:, amount_after_fees:, application_fee:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, checkout_configuration_id:, company:, created_at:, currency:, dispute_alerted_at:, disputes:, failure_message:, financing_installments_count:, financing_transactions:, last_payment_attempt:, member:, membership:, metadata:, next_payment_attempt:, paid_at:, payment_method:, payment_method_type:, payments_failed:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, refunds:, resolutions:, retryable:, risk_score:, risk_signals:, settlement_amount:, settlement_currency:, settlement_exchange_rate:, shipping_address:, status:, substatus:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, three_ds_verified:, total:, updated_at:, usd_total:, user:, voidable:)
       #   Some parameter documentations has been truncated, see {WhopSDK::Models::Payment}
       #   for more details.
       #
@@ -340,7 +373,7 @@ module WhopSDK
       #
       #   @param created_at [Time] The datetime the payment was created.
       #
-      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #   @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
       #
       #   @param dispute_alerted_at [Time, nil] When an alert came in that this transaction will be disputed
       #
@@ -382,15 +415,23 @@ module WhopSDK
       #
       #   @param refunded_at [Time, nil] When the payment was refunded (if applicable).
       #
+      #   @param refunds [Array<WhopSDK::Models::Payment::Refund>] The refunds issued against this payment, newest first, including failed and canc
+      #
       #   @param resolutions [Array<WhopSDK::Models::Payment::Resolution>, nil] The resolution center cases opened by the customer on this payment. Null if the
       #
       #   @param retryable [Boolean] True when the payment status is `open` and its membership is in one of the retry
       #
-      #   @param settlement_amount [Float] The payment amount in the creator's settlement currency (what the creator priced
+      #   @param risk_score [Integer, nil] Whop's in-house fraud risk score for this payment, from 0 (lowest risk) to 100 (
+      #
+      #   @param risk_signals [Hash{Symbol=>Object}, nil] A curated set of factors behind the risk score, grouped by category (business tr
       #
-      #   @param settlement_currency [String] The currency in which the creator receives payouts and fees are charged (e.g., '
+      #   @param settlement_amount [Float] The total amount charged to the customer for this payment, including taxes and a
       #
-      #   @param settlement_exchange_rate [Float, nil] The locked exchange rate used to convert from the buyer's payment currency to th
+      #   @param settlement_currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
+      #
+      #   @param settlement_exchange_rate [Float, nil] Deprecated. Always returns null.
+      #
+      #   @param shipping_address [WhopSDK::Models::Payment::ShippingAddress, nil] The shipping address provided by the customer for physical goods. Null if no shi
       #
       #   @param status [Symbol, WhopSDK::Models::ReceiptStatus, nil] The status of a receipt
       #
@@ -404,6 +445,8 @@ module WhopSDK
       #
       #   @param tax_refunded_amount [Float, nil] The amount of tax that has been refunded (if applicable).
       #
+      #   @param three_ds_verified [Boolean] Whether 3D Secure authentication was completed for this payment.
+      #
       #   @param total [Float, nil] The total to show to the creator (excluding buyer fees).
       #
       #   @param updated_at [Time] The datetime the payment was last updated.
@@ -580,8 +623,7 @@ module WhopSDK
         required :currency, enum: -> { WhopSDK::Currency }
 
         # @!attribute editable
-        #   Whether the dispute evidence can still be edited and submitted. Returns true
-        #   only when the dispute status requires a response.
+        #   Whether the dispute evidence can still be edited and submitted.
         #
         #   @return [Boolean, nil]
         required :editable, WhopSDK::Internal::Type::Boolean, nil?: true
@@ -626,7 +668,7 @@ module WhopSDK
         #
         #   @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for the disputed amount.
         #
-        #   @param editable [Boolean, nil] Whether the dispute evidence can still be edited and submitted. Returns true onl
+        #   @param editable [Boolean, nil] Whether the dispute evidence can still be edited and submitted.
         #
         #   @param needs_response_by [Time, nil] The deadline by which dispute evidence must be submitted. Null if no response de
         #
@@ -757,17 +799,25 @@ module WhopSDK
         #   @return [String]
         required :id, String
 
+        # @!attribute phone_number
+        #   The phone number associated with this membership.
+        #
+        #   @return [String, nil]
+        required :phone_number, String, nil?: true
+
         # @!attribute status
         #   The state of the membership.
         #
         #   @return [Symbol, WhopSDK::Models::MembershipStatus]
         required :status, enum: -> { WhopSDK::MembershipStatus }
 
-        # @!method initialize(id:, status:)
+        # @!method initialize(id:, phone_number:, status:)
         #   The membership attached to this payment.
         #
         #   @param id [String] The unique identifier for the membership.
         #
+        #   @param phone_number [String, nil] The phone number associated with this membership.
+        #
         #   @param status [Symbol, WhopSDK::Models::MembershipStatus] The state of the membership.
       end
 
@@ -869,12 +919,25 @@ module WhopSDK
         #   @return [String, nil]
         required :internal_notes, String, nil?: true
 
-        # @!method initialize(id:, internal_notes:)
+        # @!attribute metadata
+        #   Custom key-value pairs stored on the plan. Included in webhook payloads for
+        #   payment and membership events. Max 50 keys, 100 chars per key, 500 chars per
+        #   string value.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+        # @!method initialize(id:, internal_notes:, metadata:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Payment::Plan} for more details.
+        #
         #   The plan attached to this payment.
         #
         #   @param id [String] The unique identifier for the plan.
         #
         #   @param internal_notes [String, nil] A personal description or notes section for the business.
+        #
+        #   @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
       end
 
       # @see WhopSDK::Models::Payment#product
@@ -885,9 +948,17 @@ module WhopSDK
         #   @return [String]
         required :id, String
 
+        # @!attribute metadata
+        #   Custom key-value pairs stored on the product and included in payment and
+        #   membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+        #   per string value.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
         # @!attribute route
-        #   The URL slug used in the product's public link (e.g., 'my-product' in
-        #   whop.com/company/my-product).
+        #   URL slug in the product's public link, e.g. `pickaxe-analytics` in
+        #   whop.com/company/pickaxe-analytics.
         #
         #   @return [String]
         required :route, String
@@ -899,7 +970,7 @@ module WhopSDK
         #   @return [String]
         required :title, String
 
-        # @!method initialize(id:, route:, title:)
+        # @!method initialize(id:, metadata:, route:, title:)
         #   Some parameter documentations has been truncated, see
         #   {WhopSDK::Models::Payment::Product} for more details.
         #
@@ -907,7 +978,9 @@ module WhopSDK
         #
         #   @param id [String] The unique identifier for the product.
         #
-        #   @param route [String] The URL slug used in the product's public link (e.g., 'my-product' in whop.com/c
+        #   @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product and included in payment and members
+        #
+        #   @param route [String] URL slug in the product's public link, e.g. `pickaxe-analytics` in whop.com/comp
         #
         #   @param title [String] The display name of the product shown to customers on the product page and in se
       end
@@ -971,6 +1044,57 @@ module WhopSDK
         #   @param promo_type [Symbol, WhopSDK::Models::PromoType] The type (% or flat amount) of the promo.
       end
 
+      class Refund < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the refund.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #   The refunded amount as a decimal in the specified currency, such as 10.43 for
+        #   $10.43 USD.
+        #
+        #   @return [Float]
+        required :amount, Float
+
+        # @!attribute created_at
+        #   The datetime the refund was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute currency
+        #   The three-letter ISO currency code for the refunded amount.
+        #
+        #   @return [Symbol, WhopSDK::Models::Currency]
+        required :currency, enum: -> { WhopSDK::Currency }
+
+        # @!attribute status
+        #   The current processing status of the refund, such as pending, succeeded, or
+        #   failed.
+        #
+        #   @return [Symbol, WhopSDK::Models::RefundStatus]
+        required :status, enum: -> { WhopSDK::RefundStatus }
+
+        # @!method initialize(id:, amount:, created_at:, currency:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Payment::Refund} for more details.
+        #
+        #   A refund represents a full or partial reversal of a payment, including the
+        #   amount, status, and payment provider.
+        #
+        #   @param id [String] The unique identifier for the refund.
+        #
+        #   @param amount [Float] The refunded amount as a decimal in the specified currency, such as 10.43 for $1
+        #
+        #   @param created_at [Time] The datetime the refund was created.
+        #
+        #   @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for the refunded amount.
+        #
+        #   @param status [Symbol, WhopSDK::Models::RefundStatus] The current processing status of the refund, such as pending, succeeded, or fail
+      end
+
       class Resolution < WhopSDK::Internal::Type::BaseModel
         # @!attribute id
         #   The unique identifier for the resolution.
@@ -1058,6 +1182,69 @@ module WhopSDK
         #   @param status [Symbol, WhopSDK::Models::ResolutionCenterCaseStatus] The current status of the resolution case, indicating which party needs to respo
       end
 
+      # @see WhopSDK::Models::Payment#shipping_address
+      class ShippingAddress < WhopSDK::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city of the address.
+        #
+        #   @return [String, nil]
+        required :city, String, nil?: true
+
+        # @!attribute country
+        #   The country of the address.
+        #
+        #   @return [String, nil]
+        required :country, String, nil?: true
+
+        # @!attribute line1
+        #   The line 1 of the address.
+        #
+        #   @return [String, nil]
+        required :line1, String, nil?: true
+
+        # @!attribute line2
+        #   The line 2 of the address.
+        #
+        #   @return [String, nil]
+        required :line2, String, nil?: true
+
+        # @!attribute name
+        #   The name of the customer.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
+
+        # @!attribute state
+        #   The state of the address.
+        #
+        #   @return [String, nil]
+        required :state, String, nil?: true
+
+        # @!method initialize(city:, country:, line1:, line2:, name:, postal_code:, state:)
+        #   The shipping address provided by the customer for physical goods. Null if no
+        #   shipping address was collected.
+        #
+        #   @param city [String, nil] The city of the address.
+        #
+        #   @param country [String, nil] The country of the address.
+        #
+        #   @param line1 [String, nil] The line 1 of the address.
+        #
+        #   @param line2 [String, nil] The line 2 of the address.
+        #
+        #   @param name [String, nil] The name of the customer.
+        #
+        #   @param postal_code [String, nil] The postal code of the address.
+        #
+        #   @param state [String, nil] The state of the address.
+      end
+
       # @see WhopSDK::Models::Payment#user
       class User < WhopSDK::Internal::Type::BaseModel
         # @!attribute id

data/lib/whop_sdk/models/payment_create_params.rb

@@ -60,7 +60,15 @@ module WhopSDK
           #   @return [Hash{Symbol=>Object}, nil]
           optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
 
-          # @!method initialize(company_id:, member_id:, payment_method_id:, plan:, metadata: nil)
+          # @!attribute promo_code_id
+          #   The ID of an active promo code to apply to this payment. The promo code must
+          #   belong to the company and be valid for the plan being purchased. The plan must
+          #   be attached to a product — promo codes are not eligible for one-off purchases.
+          #
+          #   @return [String, nil]
+          optional :promo_code_id, String, nil?: true
+
+          # @!method initialize(company_id:, member_id:, payment_method_id:, plan:, metadata: nil, promo_code_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {WhopSDK::Models::PaymentCreateParams::Body::CreatePaymentInputWithPlan} for
           #   more details.
@@ -76,6 +84,8 @@ module WhopSDK
           #   @param plan [WhopSDK::Models::PaymentCreateParams::Body::CreatePaymentInputWithPlan::Plan] Pass this object to create a new plan for this payment
           #
           #   @param metadata [Hash{Symbol=>Object}, nil] Custom metadata to attach to the payment.
+          #
+          #   @param promo_code_id [String, nil] The ID of an active promo code to apply to this payment. The promo code must bel
 
           # @see WhopSDK::Models::PaymentCreateParams::Body::CreatePaymentInputWithPlan#plan
           class Plan < WhopSDK::Internal::Type::BaseModel
@@ -363,7 +373,15 @@ module WhopSDK
           #   @return [Hash{Symbol=>Object}, nil]
           optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
 
-          # @!method initialize(company_id:, member_id:, payment_method_id:, plan_id:, metadata: nil)
+          # @!attribute promo_code_id
+          #   The ID of an active promo code to apply to this payment. The promo code must
+          #   belong to the company and be valid for the plan being purchased. The plan must
+          #   be attached to a product — promo codes are not eligible for one-off purchases.
+          #
+          #   @return [String, nil]
+          optional :promo_code_id, String, nil?: true
+
+          # @!method initialize(company_id:, member_id:, payment_method_id:, plan_id:, metadata: nil, promo_code_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {WhopSDK::Models::PaymentCreateParams::Body::CreatePaymentInputWithPlanID} for
           #   more details.
@@ -379,6 +397,8 @@ module WhopSDK
           #   @param plan_id [String] An ID of an existing plan to use for the payment.
           #
           #   @param metadata [Hash{Symbol=>Object}, nil] Custom metadata to attach to the payment.
+          #
+          #   @param promo_code_id [String, nil] The ID of an active promo code to apply to this payment. The promo code must bel
         end
 
         # @!method self.variants

data/lib/whop_sdk/models/payment_list_params.rb

@@ -27,6 +27,12 @@ module WhopSDK
                -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::BillingReasons] },
                nil?: true
 
+      # @!attribute checkout_configuration_ids
+      #   Only return payments from these checkout configurations.
+      #
+      #   @return [Array<String>, nil]
+      optional :checkout_configuration_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute company_id
       #   The unique identifier of the company to list payments for.
       #
@@ -127,7 +133,7 @@ module WhopSDK
       #   @return [Time, nil]
       optional :updated_before, Time, nil?: true
 
-      # @!method initialize(after: nil, before: nil, billing_reasons: nil, company_id: nil, created_after: nil, created_before: nil, currencies: nil, direction: nil, first: nil, include_free: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, query: nil, statuses: nil, substatuses: nil, updated_after: nil, updated_before: nil, request_options: {})
+      # @!method initialize(after: nil, before: nil, billing_reasons: nil, checkout_configuration_ids: nil, company_id: nil, created_after: nil, created_before: nil, currencies: nil, direction: nil, first: nil, include_free: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, query: nil, statuses: nil, substatuses: nil, updated_after: nil, updated_before: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::PaymentListParams} for more details.
       #
@@ -137,6 +143,8 @@ module WhopSDK
       #
       #   @param billing_reasons [Array<Symbol, WhopSDK::Models::BillingReasons>, nil] Filter payments by their billing reason.
       #
+      #   @param checkout_configuration_ids [Array<String>, nil] Only return payments from these checkout configurations.
+      #
       #   @param company_id [String, nil] The unique identifier of the company to list payments for.
       #
       #   @param created_after [Time, nil] Only return payments created after this timestamp.