Class: Stripe::PaymentLinkUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/payment_link_update_params.rb

Defined Under Namespace

Classes: AfterCompletion, AutomaticTax, CustomField, CustomText, InvoiceCreation, LineItem, NameCollection, OptionalItem, PaymentIntentData, PhoneNumberCollection, Restrictions, ShippingAddressCollection, SubscriptionData, TaxIdCollection

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, new, #to_h

Constructor Details

#initialize(active: nil, after_completion: nil, allow_promotion_codes: nil, automatic_tax: nil, billing_address_collection: nil, custom_fields: nil, custom_text: nil, customer_creation: nil, expand: nil, inactive_message: nil, invoice_creation: nil, line_items: nil, metadata: nil, name_collection: nil, optional_items: nil, payment_intent_data: nil, payment_method_collection: nil, payment_method_types: nil, phone_number_collection: nil, restrictions: nil, shipping_address_collection: nil, submit_type: nil, subscription_data: nil, tax_id_collection: nil) ⇒ PaymentLinkUpdateParams

Returns a new instance of PaymentLinkUpdateParams.



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 586

def initialize(
  active: nil,
  after_completion: nil,
  allow_promotion_codes: nil,
  automatic_tax: nil,
  billing_address_collection: nil,
  custom_fields: nil,
  custom_text: nil,
  customer_creation: nil,
  expand: nil,
  inactive_message: nil,
  invoice_creation: nil,
  line_items: nil,
  metadata: nil,
  name_collection: nil,
  optional_items: nil,
  payment_intent_data: nil,
  payment_method_collection: nil,
  payment_method_types: nil,
  phone_number_collection: nil,
  restrictions: nil,
  shipping_address_collection: nil,
  submit_type: nil,
  subscription_data: nil,
  tax_id_collection: nil
)
  @active = active
  @after_completion = after_completion
  @allow_promotion_codes = allow_promotion_codes
  @automatic_tax = automatic_tax
  @billing_address_collection = billing_address_collection
  @custom_fields = custom_fields
  @custom_text = custom_text
  @customer_creation = customer_creation
  @expand = expand
  @inactive_message = inactive_message
  @invoice_creation = invoice_creation
  @line_items = line_items
  @metadata = metadata
  @name_collection = name_collection
  @optional_items = optional_items
  @payment_intent_data = payment_intent_data
  @payment_method_collection = payment_method_collection
  @payment_method_types = payment_method_types
  @phone_number_collection = phone_number_collection
  @restrictions = restrictions
  @shipping_address_collection = shipping_address_collection
  @submit_type = submit_type
  @subscription_data = subscription_data
  @tax_id_collection = tax_id_collection
end

Instance Attribute Details

#active ⇒ Object

Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.



530
531
532
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 530

def active
  @active
end

#after_completion ⇒ Object

Behavior after the purchase is complete.



532
533
534
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 532

def after_completion
  @after_completion
end

#allow_promotion_codes ⇒ Object

Enables user redeemable promotion codes.



534
535
536
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 534

def allow_promotion_codes
  @allow_promotion_codes
end

#automatic_tax ⇒ Object

Configuration for automatic tax collection.



536
537
538
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 536

def automatic_tax
  @automatic_tax
end

#billing_address_collection ⇒ Object

Configuration for collecting the customer’s billing address. Defaults to auto.



538
539
540
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 538

def billing_address_collection
  @billing_address_collection
end

#custom_fields ⇒ Object

Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can’t set this parameter if ui_mode is custom.



540
541
542
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 540

def custom_fields
  @custom_fields
end

#custom_text ⇒ Object

Display additional text for your customers using custom text. You can’t set this parameter if ui_mode is custom.



542
543
544
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 542

def custom_text
  @custom_text
end

#customer_creation ⇒ Object

Configures whether [checkout sessions](docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](docs.stripe.com/api/customers).



544
545
546
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 544

def customer_creation
  @customer_creation
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



546
547
548
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 546

def expand
  @expand
end

#inactive_message ⇒ Object

The custom message to be displayed to a customer when a payment link is no longer active.



548
549
550
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 548

def inactive_message
  @inactive_message
end

#invoice_creation ⇒ Object

Generate a post-purchase Invoice for one-time payments.



550
551
552
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 550

def invoice_creation
  @invoice_creation
end

#line_items ⇒ Object

The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.



552
553
554
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 552

def line_items
  @line_items
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](docs.stripe.com/api/checkout/sessions) created by this payment link.



554
555
556
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 554

def metadata
  @metadata
end

#name_collection ⇒ Object

Controls settings applied for collecting the customer’s name.



556
557
558
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 556

def name_collection
  @name_collection
end

#optional_items ⇒ Object

A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](docs.stripe.com/api/prices). There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items. There is a maximum of 20 combined line items and optional items.



560
561
562
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 560

def optional_items
  @optional_items
end

#payment_intent_data ⇒ Object

A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.



562
563
564
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 562

def payment_intent_data
  @payment_intent_data
end

#payment_method_collection ⇒ Object

Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.

Can only be set in subscription mode. Defaults to always.

If you’d like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](docs.stripe.com/payments/checkout/free-trials).



568
569
570
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 568

def payment_method_collection
  @payment_method_collection
end

#payment_method_types ⇒ Object

The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](dashboard.stripe.com/settings/payment_methods).



570
571
572
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 570

def payment_method_types
  @payment_method_types
end

#phone_number_collection ⇒ Object

Controls phone number collection settings during checkout.

We recommend that you review your privacy policy and check with your legal contacts.



574
575
576
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 574

def phone_number_collection
  @phone_number_collection
end

#restrictions ⇒ Object

Settings that restrict the usage of a payment link.



576
577
578
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 576

def restrictions
  @restrictions
end

#shipping_address_collection ⇒ Object

Configuration for collecting the customer’s shipping address.



578
579
580
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 578

def shipping_address_collection
  @shipping_address_collection
end

#submit_type ⇒ Object

Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](docs.stripe.com/api/payment_links/payment_links/object#url) property (example: donate.stripe.com).



580
581
582
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 580

def submit_type
  @submit_type
end

#subscription_data ⇒ Object

When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use subscription_data.



582
583
584
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 582

def subscription_data
  @subscription_data
end

#tax_id_collection ⇒ Object

Controls tax ID collection during checkout.



584
585
586
 
# File 'lib/stripe/params/payment_link_update_params.rb', line 584

def tax_id_collection
  @tax_id_collection
end