Class: Stripe::Checkout::SessionService::CreateParams::ConsentCollection

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/checkout/session_service.rb

Defined Under Namespace

Classes: PaymentMethodReuseAgreement

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(payment_method_reuse_agreement: nil, promotions: nil, terms_of_service: nil) ⇒ ConsentCollection

Returns a new instance of ConsentCollection.



172
173
174
175
176
177
178
179
180
 
# File 'lib/stripe/services/checkout/session_service.rb', line 172

def initialize(
  payment_method_reuse_agreement: nil,
  promotions: nil,
  terms_of_service: nil
)
  @payment_method_reuse_agreement = payment_method_reuse_agreement
  @promotions = promotions
  @terms_of_service = terms_of_service
end

Instance Attribute Details

#payment_method_reuse_agreement ⇒ Object

Determines the display of payment method reuse agreement text in the UI. If set to ‘hidden`, it will hide legal text related to the reuse of a payment method.



163
164
165
 
# File 'lib/stripe/services/checkout/session_service.rb', line 163

def payment_method_reuse_agreement
  @payment_method_reuse_agreement
end

#promotions ⇒ Object

If set to ‘auto`, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer’s locale. Only available to US merchants.



167
168
169
 
# File 'lib/stripe/services/checkout/session_service.rb', line 167

def promotions
  @promotions
end

#terms_of_service ⇒ Object

If set to ‘required`, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your [Dashboard settings](dashboard.stripe.com/settings/public).



170
171
172
 
# File 'lib/stripe/services/checkout/session_service.rb', line 170

def terms_of_service
  @terms_of_service
end