Class: Stripe::PaymentLinkService::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/payment_link_service.rb

Defined Under Namespace

Classes: AfterCompletion, AutomaticTax, ConsentCollection, CustomField, CustomText, InvoiceCreation, LineItem, PaymentIntentData, PhoneNumberCollection, Restrictions, ShippingAddressCollection, ShippingOption, SubscriptionData, TaxIdCollection, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(after_completion: nil, allow_promotion_codes: nil, application_fee_amount: nil, application_fee_percent: nil, automatic_tax: nil, billing_address_collection: nil, consent_collection: nil, currency: nil, custom_fields: nil, custom_text: nil, customer_creation: nil, expand: nil, inactive_message: nil, invoice_creation: nil, line_items: nil, metadata: nil, on_behalf_of: nil, payment_intent_data: nil, payment_method_collection: nil, payment_method_types: nil, phone_number_collection: nil, restrictions: nil, shipping_address_collection: nil, shipping_options: nil, submit_type: nil, subscription_data: nil, tax_id_collection: nil, transfer_data: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/stripe/services/payment_link_service.rb', line 694

def initialize(
  after_completion: nil,
  allow_promotion_codes: nil,
  application_fee_amount: nil,
  application_fee_percent: nil,
  automatic_tax: nil,
  billing_address_collection: nil,
  consent_collection: nil,
  currency: nil,
  custom_fields: nil,
  custom_text: nil,
  customer_creation: nil,
  expand: nil,
  inactive_message: nil,
  invoice_creation: nil,
  line_items: nil,
  metadata: nil,
  on_behalf_of: nil,
  payment_intent_data: nil,
  payment_method_collection: nil,
  payment_method_types: nil,
  phone_number_collection: nil,
  restrictions: nil,
  shipping_address_collection: nil,
  shipping_options: nil,
  submit_type: nil,
  subscription_data: nil,
  tax_id_collection: nil,
  transfer_data: nil
)
  @after_completion = after_completion
  @allow_promotion_codes = allow_promotion_codes
  @application_fee_amount = application_fee_amount
  @application_fee_percent = application_fee_percent
  @automatic_tax = automatic_tax
  @billing_address_collection = billing_address_collection
  @consent_collection = consent_collection
  @currency = currency
  @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
  @on_behalf_of = on_behalf_of
  @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
  @shipping_options = shipping_options
  @submit_type = submit_type
  @subscription_data = subscription_data
  @tax_id_collection = tax_id_collection
  @transfer_data = transfer_data
end

Instance Attribute Details

#after_completion ⇒ Object

Behavior after the purchase is complete.



605
606
607
 
# File 'lib/stripe/services/payment_link_service.rb', line 605

def after_completion
  @after_completion
end

#allow_promotion_codes ⇒ Object

Enables user redeemable promotion codes.



608
609
610
 
# File 'lib/stripe/services/payment_link_service.rb', line 608

def allow_promotion_codes
  @allow_promotion_codes
end

#application_fee_amount ⇒ Object

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. Can only be applied when there are no line items with recurring prices.



611
612
613
 
# File 'lib/stripe/services/payment_link_service.rb', line 611

def application_fee_amount
  @application_fee_amount
end

#application_fee_percent ⇒ Object

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account. There must be at least 1 line item with a recurring price to use this field.



614
615
616
 
# File 'lib/stripe/services/payment_link_service.rb', line 614

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Configuration for automatic tax collection.



617
618
619
 
# File 'lib/stripe/services/payment_link_service.rb', line 617

def automatic_tax
  @automatic_tax
end

#billing_address_collection ⇒ Object

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



620
621
622
 
# File 'lib/stripe/services/payment_link_service.rb', line 620

def billing_address_collection
  @billing_address_collection
end

#consent_collection ⇒ Object

Configure fields to gather active consent from customers.



623
624
625
 
# File 'lib/stripe/services/payment_link_service.rb', line 623

def consent_collection
  @consent_collection
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies) and supported by each line item’s price.



626
627
628
 
# File 'lib/stripe/services/payment_link_service.rb', line 626

def currency
  @currency
end

#custom_fields ⇒ Object

Collect additional information from your customer using custom fields. Up to 3 fields are supported.



629
630
631
 
# File 'lib/stripe/services/payment_link_service.rb', line 629

def custom_fields
  @custom_fields
end

#custom_text ⇒ Object

Display additional text for your customers using custom text.



632
633
634
 
# File 'lib/stripe/services/payment_link_service.rb', line 632

def custom_text
  @custom_text
end

#customer_creation ⇒ Object

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



635
636
637
 
# File 'lib/stripe/services/payment_link_service.rb', line 635

def customer_creation
  @customer_creation
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



638
639
640
 
# File 'lib/stripe/services/payment_link_service.rb', line 638

def expand
  @expand
end

#inactive_message ⇒ Object

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



641
642
643
 
# File 'lib/stripe/services/payment_link_service.rb', line 641

def inactive_message
  @inactive_message
end

#invoice_creation ⇒ Object

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



644
645
646
 
# File 'lib/stripe/services/payment_link_service.rb', line 644

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.



647
648
649
 
# File 'lib/stripe/services/payment_link_service.rb', line 647

def line_items
  @line_items
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/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](stripe.com/docs/api/checkout/sessions) created by this payment link.



650
651
652
 
# File 'lib/stripe/services/payment_link_service.rb', line 650

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge.



653
654
655
 
# File 'lib/stripe/services/payment_link_service.rb', line 653

def on_behalf_of
  @on_behalf_of
end

#payment_intent_data ⇒ Object

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



656
657
658
 
# File 'lib/stripe/services/payment_link_service.rb', line 656

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](stripe.com/docs/payments/checkout/free-trials).



663
664
665
 
# File 'lib/stripe/services/payment_link_service.rb', line 663

def payment_method_collection
  @payment_method_collection
end

#payment_method_types ⇒ Object

The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).



666
667
668
 
# File 'lib/stripe/services/payment_link_service.rb', line 666

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.



671
672
673
 
# File 'lib/stripe/services/payment_link_service.rb', line 671

def phone_number_collection
  @phone_number_collection
end

#restrictions ⇒ Object

Settings that restrict the usage of a payment link.



674
675
676
 
# File 'lib/stripe/services/payment_link_service.rb', line 674

def restrictions
  @restrictions
end

#shipping_address_collection ⇒ Object

Configuration for collecting the customer’s shipping address.



677
678
679
 
# File 'lib/stripe/services/payment_link_service.rb', line 677

def shipping_address_collection
  @shipping_address_collection
end

#shipping_options ⇒ Object

The shipping rate options to apply to [checkout sessions](stripe.com/docs/api/checkout/sessions) created by this payment link.



680
681
682
 
# File 'lib/stripe/services/payment_link_service.rb', line 680

def shipping_options
  @shipping_options
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](stripe.com/docs/api/payment_links/payment_links/object#url) property (example: ‘donate.stripe.com`).



683
684
685
 
# File 'lib/stripe/services/payment_link_service.rb', line 683

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`.



686
687
688
 
# File 'lib/stripe/services/payment_link_service.rb', line 686

def subscription_data
  @subscription_data
end

#tax_id_collection ⇒ Object

Controls tax ID collection during checkout.



689
690
691
 
# File 'lib/stripe/services/payment_link_service.rb', line 689

def tax_id_collection
  @tax_id_collection
end

#transfer_data ⇒ Object

The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.



692
693
694
 
# File 'lib/stripe/services/payment_link_service.rb', line 692

def transfer_data
  @transfer_data
end