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, OptionalItem, 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, 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, shipping_options: nil, submit_type: nil, subscription_data: nil, tax_id_collection: nil, transfer_data: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
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
 
# File 'lib/stripe/services/payment_link_service.rb', line 660

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,
  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,
  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
  @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
  @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.



594
595
596
 
# File 'lib/stripe/services/payment_link_service.rb', line 594

def after_completion
  @after_completion
end

#allow_promotion_codes ⇒ Object

Enables user redeemable promotion codes.



596
597
598
 
# File 'lib/stripe/services/payment_link_service.rb', line 596

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.



598
599
600
 
# File 'lib/stripe/services/payment_link_service.rb', line 598

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.



600
601
602
 
# File 'lib/stripe/services/payment_link_service.rb', line 600

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object

Configuration for automatic tax collection.



602
603
604
 
# File 'lib/stripe/services/payment_link_service.rb', line 602

def automatic_tax
  @automatic_tax
end

#billing_address_collection ⇒ Object

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



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

def billing_address_collection
  @billing_address_collection
end

#consent_collection ⇒ Object

Configure fields to gather active consent from customers.



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

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.



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

def currency
  @currency
end

#custom_fields ⇒ Object

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



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

def custom_fields
  @custom_fields
end

#custom_text ⇒ Object

Display additional text for your customers using custom text.



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

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



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

def customer_creation
  @customer_creation
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



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

def expand
  @expand
end

#inactive_message ⇒ Object

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



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

def inactive_message
  @inactive_message
end

#invoice_creation ⇒ Object

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



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

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.



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

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.



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

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The account on behalf of which to charge.



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

def on_behalf_of
  @on_behalf_of
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](stripe.com/docs/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.



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

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.



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

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



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

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



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

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.



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

def phone_number_collection
  @phone_number_collection
end

#restrictions ⇒ Object

Settings that restrict the usage of a payment link.



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

def restrictions
  @restrictions
end

#shipping_address_collection ⇒ Object

Configuration for collecting the customer’s shipping address.



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

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.



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

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



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

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



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

def subscription_data
  @subscription_data
end

#tax_id_collection ⇒ Object

Controls tax ID collection during checkout.



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

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.



658
659
660
 
# File 'lib/stripe/services/payment_link_service.rb', line 658

def transfer_data
  @transfer_data
end