Class: Stripe::PaymentLink

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/payment_link.rb

Overview

A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.

When a customer opens a payment link it will open a new [checkout session](docs.stripe.com/api/checkout/sessions) to render the payment page. You can use [checkout session events](docs.stripe.com/api/events/types#event_types-checkout.session.completed) to track payments through payment links.

Related guide: [Payment Links API](docs.stripe.com/payment-links)

Defined Under Namespace

Classes: AfterCompletion, AutomaticSurcharge, AutomaticTax, ConsentCollection, CustomField, CustomText, InvoiceCreation, ManagedPayments, NameCollection, OptionalItem, PaymentIntentData, PaymentMethodOptions, PhoneNumberCollection, Restrictions, ShippingAddressCollection, ShippingOption, SubscriptionData, TaxIdCollection, TransferData

Constant Summary collapse

OBJECT_NAME = 
"payment_link"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#active ⇒ Object (readonly)

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.



727
728
729
 
# File 'lib/stripe/resources/payment_link.rb', line 727

def active
  @active
end

#after_completion ⇒ Object (readonly)

Attribute for field after_completion



729
730
731
 
# File 'lib/stripe/resources/payment_link.rb', line 729

def after_completion
  @after_completion
end

#allow_promotion_codes ⇒ Object (readonly)

Whether user redeemable promotion codes are enabled.



731
732
733
 
# File 'lib/stripe/resources/payment_link.rb', line 731

def allow_promotion_codes
  @allow_promotion_codes
end

#application ⇒ Object (readonly)

The ID of the Connect application that created the Payment Link.



733
734
735
 
# File 'lib/stripe/resources/payment_link.rb', line 733

def application
  @application
end

#application_fee_amount ⇒ Object (readonly)

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.



735
736
737
 
# File 'lib/stripe/resources/payment_link.rb', line 735

def application_fee_amount
  @application_fee_amount
end

#application_fee_percent ⇒ Object (readonly)

This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account.



737
738
739
 
# File 'lib/stripe/resources/payment_link.rb', line 737

def application_fee_percent
  @application_fee_percent
end

#automatic_surcharge ⇒ Object (readonly)

Attribute for field automatic_surcharge



739
740
741
 
# File 'lib/stripe/resources/payment_link.rb', line 739

def automatic_surcharge
  @automatic_surcharge
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



741
742
743
 
# File 'lib/stripe/resources/payment_link.rb', line 741

def automatic_tax
  @automatic_tax
end

#billing_address_collection ⇒ Object (readonly)

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



743
744
745
 
# File 'lib/stripe/resources/payment_link.rb', line 743

def billing_address_collection
  @billing_address_collection
end

#consent_collection ⇒ Object (readonly)

When set, provides configuration to gather active consent from customers.



745
746
747
 
# File 'lib/stripe/resources/payment_link.rb', line 745

def consent_collection
  @consent_collection
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



747
748
749
 
# File 'lib/stripe/resources/payment_link.rb', line 747

def currency
  @currency
end

#custom_fields ⇒ Object (readonly)

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



749
750
751
 
# File 'lib/stripe/resources/payment_link.rb', line 749

def custom_fields
  @custom_fields
end

#custom_text ⇒ Object (readonly)

Attribute for field custom_text



751
752
753
 
# File 'lib/stripe/resources/payment_link.rb', line 751

def custom_text
  @custom_text
end

#customer_creation ⇒ Object (readonly)

Configuration for Customer creation during checkout.



753
754
755
 
# File 'lib/stripe/resources/payment_link.rb', line 753

def customer_creation
  @customer_creation
end

#id ⇒ Object (readonly)

Unique identifier for the object.



755
756
757
 
# File 'lib/stripe/resources/payment_link.rb', line 755

def id
  @id
end

#inactive_message ⇒ Object (readonly)

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



757
758
759
 
# File 'lib/stripe/resources/payment_link.rb', line 757

def inactive_message
  @inactive_message
end

#invoice_creation ⇒ Object (readonly)

Configuration for creating invoice for payment mode payment links.



759
760
761
 
# File 'lib/stripe/resources/payment_link.rb', line 759

def invoice_creation
  @invoice_creation
end

#line_items ⇒ Object (readonly)

The line items representing what is being sold.



761
762
763
 
# File 'lib/stripe/resources/payment_link.rb', line 761

def line_items
  @line_items
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is ‘true`. If the object exists in test mode, the value is `false`.



763
764
765
 
# File 'lib/stripe/resources/payment_link.rb', line 763

def livemode
  @livemode
end

#managed_payments ⇒ Object (readonly)

Settings for Managed Payments for this Payment Link and resulting [CheckoutSessions](/api/checkout/sessions/object), [PaymentIntents](/api/payment_intents/object), [Invoices](/api/invoices/object), and [Subscriptions](/api/subscriptions/object).



765
766
767
 
# File 'lib/stripe/resources/payment_link.rb', line 765

def managed_payments
  @managed_payments
end

#metadata ⇒ Object (readonly)

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.



767
768
769
 
# File 'lib/stripe/resources/payment_link.rb', line 767

def metadata
  @metadata
end

#name_collection ⇒ Object (readonly)

Attribute for field name_collection



769
770
771
 
# File 'lib/stripe/resources/payment_link.rb', line 769

def name_collection
  @name_collection
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



771
772
773
 
# File 'lib/stripe/resources/payment_link.rb', line 771

def object
  @object
end

#on_behalf_of ⇒ Object (readonly)

The account on behalf of which to charge. See the [Connect documentation](support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.



773
774
775
 
# File 'lib/stripe/resources/payment_link.rb', line 773

def on_behalf_of
  @on_behalf_of
end

#optional_items ⇒ Object (readonly)

The optional items presented to the customer at checkout.



775
776
777
 
# File 'lib/stripe/resources/payment_link.rb', line 775

def optional_items
  @optional_items
end

#payment_intent_data ⇒ Object (readonly)

Indicates the parameters to be passed to PaymentIntent creation during checkout.



777
778
779
 
# File 'lib/stripe/resources/payment_link.rb', line 777

def payment_intent_data
  @payment_intent_data
end

#payment_method_collection ⇒ Object (readonly)

Configuration for collecting a payment method during checkout. Defaults to ‘always`.



779
780
781
 
# File 'lib/stripe/resources/payment_link.rb', line 779

def payment_method_collection
  @payment_method_collection
end

#payment_method_options ⇒ Object (readonly)

Payment-method-specific configuration.



781
782
783
 
# File 'lib/stripe/resources/payment_link.rb', line 781

def payment_method_options
  @payment_method_options
end

#payment_method_types ⇒ Object (readonly)

The list of payment method types that customers can use. When ‘null`, Stripe will dynamically show relevant payment methods you’ve enabled in your [payment method settings](dashboard.stripe.com/settings/payment_methods).



783
784
785
 
# File 'lib/stripe/resources/payment_link.rb', line 783

def payment_method_types
  @payment_method_types
end

#phone_number_collection ⇒ Object (readonly)

Attribute for field phone_number_collection



785
786
787
 
# File 'lib/stripe/resources/payment_link.rb', line 785

def phone_number_collection
  @phone_number_collection
end

#restrictions ⇒ Object (readonly)

Settings that restrict the usage of a payment link.



787
788
789
 
# File 'lib/stripe/resources/payment_link.rb', line 787

def restrictions
  @restrictions
end

#shipping_address_collection ⇒ Object (readonly)

Configuration for collecting the customer’s shipping address.



789
790
791
 
# File 'lib/stripe/resources/payment_link.rb', line 789

def shipping_address_collection
  @shipping_address_collection
end

#shipping_options ⇒ Object (readonly)

The shipping rate options applied to the session.



791
792
793
 
# File 'lib/stripe/resources/payment_link.rb', line 791

def shipping_options
  @shipping_options
end

#submit_type ⇒ Object (readonly)

Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.



793
794
795
 
# File 'lib/stripe/resources/payment_link.rb', line 793

def submit_type
  @submit_type
end

#subscription_data ⇒ Object (readonly)

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



795
796
797
 
# File 'lib/stripe/resources/payment_link.rb', line 795

def subscription_data
  @subscription_data
end

#tax_id_collection ⇒ Object (readonly)

Attribute for field tax_id_collection



797
798
799
 
# File 'lib/stripe/resources/payment_link.rb', line 797

def tax_id_collection
  @tax_id_collection
end

#transfer_data ⇒ Object (readonly)

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



799
800
801
 
# File 'lib/stripe/resources/payment_link.rb', line 799

def transfer_data
  @transfer_data
end

#url ⇒ Object (readonly)

The public URL that can be shared with customers.



801
802
803
 
# File 'lib/stripe/resources/payment_link.rb', line 801

def url
  @url
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates a payment link.



804
805
806
 
# File 'lib/stripe/resources/payment_link.rb', line 804

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/payment_links", params: params, opts: opts)
end

.field_remappings ⇒ Object 



867
868
869
 
# File 'lib/stripe/resources/payment_link.rb', line 867

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/stripe/resources/payment_link.rb', line 843

def self.inner_class_types
  @inner_class_types = {
    after_completion: AfterCompletion,
    automatic_surcharge: AutomaticSurcharge,
    automatic_tax: AutomaticTax,
    consent_collection: ConsentCollection,
    custom_fields: CustomField,
    custom_text: CustomText,
    invoice_creation: InvoiceCreation,
    managed_payments: ManagedPayments,
    name_collection: NameCollection,
    optional_items: OptionalItem,
    payment_intent_data: PaymentIntentData,
    payment_method_options: PaymentMethodOptions,
    phone_number_collection: PhoneNumberCollection,
    restrictions: Restrictions,
    shipping_address_collection: ShippingAddressCollection,
    shipping_options: ShippingOption,
    subscription_data: SubscriptionData,
    tax_id_collection: TaxIdCollection,
    transfer_data: TransferData,
  }
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of your payment links.



809
810
811
 
# File 'lib/stripe/resources/payment_link.rb', line 809

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/payment_links", params: params, opts: opts)
end

.list_line_items(payment_link, params = {}, opts = {}) ⇒ Object

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.



824
825
826
827
828
829
830
831
 
# File 'lib/stripe/resources/payment_link.rb', line 824

def self.list_line_items(payment_link, params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: format("/v1/payment_links/%<payment_link>s/line_items", { payment_link: CGI.escape(payment_link) }),
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



16
17
18
 
# File 'lib/stripe/resources/payment_link.rb', line 16

def self.object_name
  "payment_link"
end

.update(payment_link, params = {}, opts = {}) ⇒ Object

Updates a payment link.



834
835
836
837
838
839
840
841
 
# File 'lib/stripe/resources/payment_link.rb', line 834

def self.update(payment_link, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_links/%<payment_link>s", { payment_link: CGI.escape(payment_link) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#list_line_items(params = {}, opts = {}) ⇒ Object

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.



814
815
816
817
818
819
820
821
 
# File 'lib/stripe/resources/payment_link.rb', line 814

def list_line_items(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: format("/v1/payment_links/%<payment_link>s/line_items", { payment_link: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end