Class: Dodopayments::Resources::CheckoutSessions

Inherits:

Object

• Object
• Dodopayments::Resources::CheckoutSessions

Defined in:

lib/dodopayments/resources/checkout_sessions.rb

Instance Method Summary

• #create(product_cart: , allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, confirm: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, return_url: nil, show_saved_payment_methods: nil, subscription_data: nil, request_options: {}) ⇒ Dodopayments::Models::CheckoutSessionResponse

  Some parameter documentations has been truncated, see Models::CheckoutSessionCreateParams for more details.

• #initialize(client:) ⇒ CheckoutSessions constructor private

  A new instance of CheckoutSessions.

• #retrieve(id, request_options: {}) ⇒ Dodopayments::Models::CheckoutSessionStatus

Constructor Details

#initialize(client:) ⇒ CheckoutSessions

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CheckoutSessions.

Parameters:

• client (Dodopayments::Client)

# File 'lib/dodopayments/resources/checkout_sessions.rb', line 75

def initialize(client:)
  @client = client
end

Instance Method Details

#create(product_cart: , allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, confirm: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, return_url: nil, show_saved_payment_methods: nil, subscription_data: nil, request_options: {}) ⇒ Dodopayments::Models::CheckoutSessionResponse

Some parameter documentations has been truncated, see Models::CheckoutSessionCreateParams for more details.

Parameters:

• product_cart (Array<Dodopayments::Models::CheckoutSessionRequest::ProductCart>)
• allowed_payment_method_types (Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil) —

  Customers will never see payment methods that are not in this list.

• billing_address (Dodopayments::Models::CheckoutSessionRequest::BillingAddress, nil) —

  Billing address information for the session

• billing_currency (Symbol, Dodopayments::Models::Currency, nil) —

  This field is ingored if adaptive pricing is disabled

• confirm (Boolean) —

  If confirm is true, all the details will be finalized. If required data is missi

• customer (Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer, nil) —

  Customer details for the session

• customization (Dodopayments::Models::CheckoutSessionRequest::Customization) —

  Customization for the checkout session page

• discount_code (String, nil)
• feature_flags (Dodopayments::Models::CheckoutSessionRequest::FeatureFlags)
• force_3ds (Boolean, nil) —

  Override merchant default 3DS behaviour for this session

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

  Additional metadata associated with the payment. Defaults to empty if not provid

• return_url (String, nil) —

  The url to redirect after payment failure or success.

• show_saved_payment_methods (Boolean) —

  Display saved payment methods of a returning customer False by default

• subscription_data (Dodopayments::Models::CheckoutSessionRequest::SubscriptionData, nil)
• request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Dodopayments::Models::CheckoutSessionResponse)

See Also:

• Models::CheckoutSessionCreateParams

# File 'lib/dodopayments/resources/checkout_sessions.rb', line 44

def create(params)
  parsed, options = Dodopayments::CheckoutSessionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "checkouts",
    body: parsed,
    model: Dodopayments::CheckoutSessionResponse,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Dodopayments::Models::CheckoutSessionStatus

Parameters:

• id (String)
• request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Dodopayments::Models::CheckoutSessionStatus)

See Also:

• Models::CheckoutSessionRetrieveParams

# File 'lib/dodopayments/resources/checkout_sessions.rb', line 63

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["checkouts/%1$s", id],
    model: Dodopayments::CheckoutSessionStatus,
    options: params[:request_options]
  )
end