Class: WhopSDK::Models::RefundRetrieveResponse::Payment

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/refund_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Classes: Member, Membership, Plan, Product, User

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, metadata:) ⇒ Object

Some parameter documentations has been truncated, see Product for more details.

The product this payment was made for

Parameters:

  • id (String) —

    The unique identifier for the product.

  • metadata (Hash{Symbol=>Object}, nil) —

    Custom key-value pairs stored on the product. Included in webhook payloads for p




# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 239

Instance Attribute Details

#billing_reason ⇒ Symbol, ...

The reason why a specific payment was billed

Returns:



119
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 119

required :billing_reason, enum: -> { WhopSDK::BillingReasons }, nil?: true

#card_brand ⇒ Symbol, ...

Possible card brands that a payment token can have

Returns:



125
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 125

required :card_brand, enum: -> { WhopSDK::CardBrands }, nil?: true

#card_last4 ⇒ String?

The last four digits of the card used to make this payment. Null if the payment was not made with a card.

Returns:

  • (String, nil) 


132
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 132

required :card_last4, String, nil?: true

#created_at ⇒ Time

The datetime the payment was created.

Returns:

  • (Time) 


138
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 138

required :created_at, Time

#currency ⇒ Symbol, WhopSDK::Models::Currency

The three-letter ISO currency code for this payment (e.g., ‘usd’, ‘eur’).

Returns:



144
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 144

required :currency, enum: -> { WhopSDK::Currency }

#dispute_alerted_at ⇒ Time?

When an alert came in that this transaction will be disputed

Returns:

  • (Time, nil) 


150
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 150

required :dispute_alerted_at, Time, nil?: true

#id ⇒ String

The unique identifier for the payment.

Returns:

  • (String) 


113
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 113

required :id, String

#member ⇒ WhopSDK::Models::RefundRetrieveResponse::Payment::Member?

The member attached to this payment.

Returns:



156
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 156

required :member, -> { WhopSDK::Models::RefundRetrieveResponse::Payment::Member }, nil?: true

#membership ⇒ WhopSDK::Models::RefundRetrieveResponse::Payment::Membership?

The membership attached to this payment.

Returns:



162
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 162

required :membership, -> { WhopSDK::Models::RefundRetrieveResponse::Payment::Membership }, nil?: true

#metadata ⇒ Hash{Symbol=>Object}?

The custom metadata stored on this payment. This will be copied over to the checkout configuration for which this payment was made

Returns:

  • (Hash{Symbol=>Object}, nil) 


169
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 169

required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true

The time at which this payment was successfully collected. Null if the payment has not yet succeeded. As a Unix timestamp.

Returns:

  • (Time, nil) 


176
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 176

required :paid_at, Time, nil?: true

#payment_method_type ⇒ Symbol, ...

The different types of payment methods that can be used.

Returns:



182
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 182

required :payment_method_type, enum: -> { WhopSDK::PaymentMethodTypes }, nil?: true

#plan ⇒ WhopSDK::Models::RefundRetrieveResponse::Payment::Plan?

The plan attached to this payment.

Returns:



188
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 188

required :plan, -> { WhopSDK::Models::RefundRetrieveResponse::Payment::Plan }, nil?: true

#product ⇒ WhopSDK::Models::RefundRetrieveResponse::Payment::Product?

The product this payment was made for

Returns:



194
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 194

required :product, -> { WhopSDK::Models::RefundRetrieveResponse::Payment::Product }, nil?: true

#subtotal ⇒ Float?

The subtotal to show to the creator (excluding buyer fees).

Returns:

  • (Float, nil) 


200
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 200

required :subtotal, Float, nil?: true

#tax_amount ⇒ Float?

The calculated amount of the sales/VAT tax (if applicable).

Returns:

  • (Float, nil) 


206
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 206

required :tax_amount, Float, nil?: true

#tax_behavior ⇒ Symbol, ...

The type of tax inclusivity applied to the receipt, for determining whether the tax is included in the final price, or paid on top.

Returns:



213
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 213

required :tax_behavior, enum: -> { WhopSDK::ReceiptTaxBehavior }, nil?: true

#tax_refunded_amount ⇒ Float?

The amount of tax that has been refunded (if applicable).

Returns:

  • (Float, nil) 


219
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 219

required :tax_refunded_amount, Float, nil?: true

#total ⇒ Float?

The total to show to the creator (excluding buyer fees).

Returns:

  • (Float, nil) 


225
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 225

required :total, Float, nil?: true

#usd_total ⇒ Float?

The total in USD to show to the creator (excluding buyer fees).

Returns:

  • (Float, nil) 


231
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 231

required :usd_total, Float, nil?: true

#user ⇒ WhopSDK::Models::RefundRetrieveResponse::Payment::User?

The user that made this payment.

Returns:



237
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 237

required :user, -> { WhopSDK::Models::RefundRetrieveResponse::Payment::User }, nil?: true