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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::RefundRetrieveResponse::Payment

Defined in:

lib/whop_sdk/models/refund_retrieve_response.rb

Overview

See Also:

• #payment

Defined Under Namespace

Classes: Member, Membership, User

Instance Attribute Summary

• #billing_reason ⇒ Symbol, ...

  The reason why a specific payment was billed.

• #card_brand ⇒ Symbol, ...

  Possible card brands that a payment token can have.

• #card_last4 ⇒ String^?

  The last four digits of the card used to make this payment.

• #created_at ⇒ Time

  The datetime the payment was created.

• #currency ⇒ Symbol, ...

  The available currencies on the platform.

• #dispute_alerted_at ⇒ Time^?

  When an alert came in that this transaction will be disputed.

• #id ⇒ String

  The unique identifier for the payment.

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

  The member attached to this payment.

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

  The membership attached to this payment.

• #paid_at ⇒ Time^?

  The time at which this payment was successfully collected.

• #payment_method_type ⇒ Symbol, ...

  The different types of payment methods that can be used.

• #subtotal ⇒ Float^?

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

• #tax_amount ⇒ Float^?

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

• #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.

• #tax_refunded_amount ⇒ Float^?

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

• #total ⇒ Float^?

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

• #usd_total ⇒ Float^?

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

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

  The user that made this payment.

Instance Method Summary

• #initialize(id:, status:) ⇒ Object constructor

  The membership attached to this payment.

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:, status:) ⇒ Object

The membership attached to this payment.

Parameters:

• id (String) —

  The unique identifier for the membership.

• status (Symbol, WhopSDK::Models::MembershipStatus) —

  The state of the membership.

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

Instance Attribute Details

#billing_reason ⇒ Symbol, ...

The reason why a specific payment was billed

Returns:

• (Symbol, WhopSDK::Models::BillingReasons, nil)

# 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:

• (Symbol, WhopSDK::Models::CardBrands, nil)

# 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)

# 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)

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

required :created_at, Time

#currency ⇒ Symbol, ...

The available currencies on the platform

Returns:

• (Symbol, WhopSDK::Models::Currency, nil)

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

required :currency, enum: -> { WhopSDK::Currency }, nil?: true

#dispute_alerted_at ⇒ Time^?

When an alert came in that this transaction will be disputed

Returns:

• (Time, nil)

# 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)

# 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:

• (WhopSDK::Models::RefundRetrieveResponse::Payment::Member, nil)

# 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:

• (WhopSDK::Models::RefundRetrieveResponse::Payment::Membership, nil)

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

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

#paid_at ⇒ Time^?

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

Returns:

• (Time, nil)

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

required :paid_at, Time, nil?: true

#payment_method_type ⇒ Symbol, ...

The different types of payment methods that can be used.

Returns:

• (Symbol, WhopSDK::Models::PaymentMethodTypes, nil)

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

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

#subtotal ⇒ Float^?

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

Returns:

• (Float, nil)

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

required :subtotal, Float, nil?: true

#tax_amount ⇒ Float^?

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

Returns:

• (Float, nil)

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

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:

• (Symbol, WhopSDK::Models::ReceiptTaxBehavior, nil)

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

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)

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

required :tax_refunded_amount, Float, nil?: true

#total ⇒ Float^?

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

Returns:

• (Float, nil)

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

required :total, Float, nil?: true

#usd_total ⇒ Float^?

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

Returns:

• (Float, nil)

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

required :usd_total, Float, nil?: true

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

The user that made this payment.

Returns:

• (WhopSDK::Models::RefundRetrieveResponse::Payment::User, nil)

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

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