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](stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.

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

Defined Under Namespace

Classes: AfterCompletion, AutomaticTax, ConsentCollection, CreateParams, CustomField, CustomText, InvoiceCreation, ListLineItemsParams, ListParams, OptionalItem, PaymentIntentData, PhoneNumberCollection, Restrictions, ShippingAddressCollection, ShippingOption, SubscriptionData, TaxIdCollection, TransferData, UpdateParams

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

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #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.



1584
1585
1586
 
# File 'lib/stripe/resources/payment_link.rb', line 1584

def active
  @active
end

#after_completion ⇒ Object (readonly)

Attribute for field after_completion



1586
1587
1588
 
# File 'lib/stripe/resources/payment_link.rb', line 1586

def after_completion
  @after_completion
end

#allow_promotion_codes ⇒ Object (readonly)

Whether user redeemable promotion codes are enabled.



1588
1589
1590
 
# File 'lib/stripe/resources/payment_link.rb', line 1588

def allow_promotion_codes
  @allow_promotion_codes
end

#application ⇒ Object (readonly)

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



1590
1591
1592
 
# File 'lib/stripe/resources/payment_link.rb', line 1590

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.



1592
1593
1594
 
# File 'lib/stripe/resources/payment_link.rb', line 1592

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.



1594
1595
1596
 
# File 'lib/stripe/resources/payment_link.rb', line 1594

def application_fee_percent
  @application_fee_percent
end

#automatic_tax ⇒ Object (readonly)

Attribute for field automatic_tax



1596
1597
1598
 
# File 'lib/stripe/resources/payment_link.rb', line 1596

def automatic_tax
  @automatic_tax
end

#billing_address_collection ⇒ Object (readonly)

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



1598
1599
1600
 
# File 'lib/stripe/resources/payment_link.rb', line 1598

def billing_address_collection
  @billing_address_collection
end

#consent_collection ⇒ Object (readonly)

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



1600
1601
1602
 
# File 'lib/stripe/resources/payment_link.rb', line 1600

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



1602
1603
1604
 
# File 'lib/stripe/resources/payment_link.rb', line 1602

def currency
  @currency
end

#custom_fields ⇒ Object (readonly)

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



1604
1605
1606
 
# File 'lib/stripe/resources/payment_link.rb', line 1604

def custom_fields
  @custom_fields
end

#custom_text ⇒ Object (readonly)

Attribute for field custom_text



1606
1607
1608
 
# File 'lib/stripe/resources/payment_link.rb', line 1606

def custom_text
  @custom_text
end

#customer_creation ⇒ Object (readonly)

Configuration for Customer creation during checkout.



1608
1609
1610
 
# File 'lib/stripe/resources/payment_link.rb', line 1608

def customer_creation
  @customer_creation
end

#id ⇒ Object (readonly)

Unique identifier for the object.



1610
1611
1612
 
# File 'lib/stripe/resources/payment_link.rb', line 1610

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.



1612
1613
1614
 
# File 'lib/stripe/resources/payment_link.rb', line 1612

def inactive_message
  @inactive_message
end

#invoice_creation ⇒ Object (readonly)

Configuration for creating invoice for payment mode payment links.



1614
1615
1616
 
# File 'lib/stripe/resources/payment_link.rb', line 1614

def invoice_creation
  @invoice_creation
end

#line_items ⇒ Object (readonly)

The line items representing what is being sold.



1616
1617
1618
 
# File 'lib/stripe/resources/payment_link.rb', line 1616

def line_items
  @line_items
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



1618
1619
1620
 
# File 'lib/stripe/resources/payment_link.rb', line 1618

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

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.



1620
1621
1622
 
# File 'lib/stripe/resources/payment_link.rb', line 1620

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



1622
1623
1624
 
# File 'lib/stripe/resources/payment_link.rb', line 1622

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.



1624
1625
1626
 
# File 'lib/stripe/resources/payment_link.rb', line 1624

def on_behalf_of
  @on_behalf_of
end

#optional_items ⇒ Object (readonly)

The optional items presented to the customer at checkout.



1626
1627
1628
 
# File 'lib/stripe/resources/payment_link.rb', line 1626

def optional_items
  @optional_items
end

#payment_intent_data ⇒ Object (readonly)

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



1628
1629
1630
 
# File 'lib/stripe/resources/payment_link.rb', line 1628

def payment_intent_data
  @payment_intent_data
end

#payment_method_collection ⇒ Object (readonly)

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



1630
1631
1632
 
# File 'lib/stripe/resources/payment_link.rb', line 1630

def payment_method_collection
  @payment_method_collection
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).



1632
1633
1634
 
# File 'lib/stripe/resources/payment_link.rb', line 1632

def payment_method_types
  @payment_method_types
end

#phone_number_collection ⇒ Object (readonly)

Attribute for field phone_number_collection



1634
1635
1636
 
# File 'lib/stripe/resources/payment_link.rb', line 1634

def phone_number_collection
  @phone_number_collection
end

#restrictions ⇒ Object (readonly)

Settings that restrict the usage of a payment link.



1636
1637
1638
 
# File 'lib/stripe/resources/payment_link.rb', line 1636

def restrictions
  @restrictions
end

#shipping_address_collection ⇒ Object (readonly)

Configuration for collecting the customer’s shipping address.



1638
1639
1640
 
# File 'lib/stripe/resources/payment_link.rb', line 1638

def shipping_address_collection
  @shipping_address_collection
end

#shipping_options ⇒ Object (readonly)

The shipping rate options applied to the session.



1640
1641
1642
 
# File 'lib/stripe/resources/payment_link.rb', line 1640

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.



1642
1643
1644
 
# File 'lib/stripe/resources/payment_link.rb', line 1642

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



1644
1645
1646
 
# File 'lib/stripe/resources/payment_link.rb', line 1644

def subscription_data
  @subscription_data
end

#tax_id_collection ⇒ Object (readonly)

Attribute for field tax_id_collection



1646
1647
1648
 
# File 'lib/stripe/resources/payment_link.rb', line 1646

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.



1648
1649
1650
 
# File 'lib/stripe/resources/payment_link.rb', line 1648

def transfer_data
  @transfer_data
end

#url ⇒ Object (readonly)

The public URL that can be shared with customers.



1650
1651
1652
 
# File 'lib/stripe/resources/payment_link.rb', line 1650

def url
  @url
end

Class Method Details

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

Creates a payment link.



1653
1654
1655
 
# File 'lib/stripe/resources/payment_link.rb', line 1653

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

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

Returns a list of your payment links.



1658
1659
1660
 
# File 'lib/stripe/resources/payment_link.rb', line 1658

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.



1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'lib/stripe/resources/payment_link.rb', line 1673

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.



1683
1684
1685
1686
1687
1688
1689
1690
 
# File 'lib/stripe/resources/payment_link.rb', line 1683

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.



1663
1664
1665
1666
1667
1668
1669
1670
 
# File 'lib/stripe/resources/payment_link.rb', line 1663

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