class Stripe::PaymentLink

• Stripe::PaymentLink
• Reference
• Object

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 to render the payment page. You can use checkout session events to track payments through payment links. Related guide: Payment Links API

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

ERROR_MESSAGE_FOR_BILLING_ADDRESS_COLLECTION = "invalid value for \"billing_address_collection\", must be one of [auto, required]."

ERROR_MESSAGE_FOR_CUSTOMER_CREATION = "invalid value for \"customer_creation\", must be one of [always, if_required]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [payment_link]."

ERROR_MESSAGE_FOR_PAYMENT_METHOD_COLLECTION = "invalid value for \"payment_method_collection\", must be one of [always, if_required]."

ERROR_MESSAGE_FOR_PAYMENT_METHOD_TYPES = "invalid value for \"payment_method_types\", must be one of [affirm, afterpay_clearpay, alipay, au_becs_debit, bacs_debit, bancontact, blik, boleto, card, cashapp, eps, fpx, giropay, grabpay, ideal, klarna, konbini, link, mobilepay, multibanco, oxxo, p24, paynow, paypal, pix, promptpay, sepa_debit, sofort, swish, twint, us_bank_account, wechat_pay, zip]."

ERROR_MESSAGE_FOR_SUBMIT_TYPE = "invalid value for \"submit_type\", must be one of [auto, book, donate, pay]."

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_INACTIVE_MESSAGE = 5000

MAX_LENGTH_FOR_URL = 5000

VALID_VALUES_FOR_BILLING_ADDRESS_COLLECTION = String.static_array("auto", "required")

VALID_VALUES_FOR_CUSTOMER_CREATION = String.static_array("always", "if_required")

VALID_VALUES_FOR_OBJECT = String.static_array("payment_link")

VALID_VALUES_FOR_PAYMENT_METHOD_COLLECTION = String.static_array("always", "if_required")

VALID_VALUES_FOR_PAYMENT_METHOD_TYPES = String.static_array("affirm", "afterpay_clearpay", "alipay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "cashapp", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip")

VALID_VALUES_FOR_SUBMIT_TYPE = String.static_array("auto", "book", "donate", "pay")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, active : Bool | Nil = nil, after_completion : Stripe::PaymentLinksResourceAfterCompletion | Nil = nil, allow_promotion_codes : Bool | Nil = nil, application : Stripe::PaymentLinkApplication | Nil = nil, application_fee_amount : Int64 | Nil = nil, application_fee_percent : Float64 | Nil = nil, automatic_tax : Stripe::PaymentLinksResourceAutomaticTax | Nil = nil, billing_address_collection : String | Nil = nil, consent_collection : Stripe::PaymentLinkConsentCollection | Nil = nil, currency : String | Nil = nil, custom_fields : Array(Stripe::PaymentLinksResourceCustomFields) | Nil = nil, custom_text : Stripe::PaymentLinksResourceCustomText | Nil = nil, customer_creation : String | Nil = nil, id : String | Nil = nil, inactive_message : String | Nil = nil, invoice_creation : Stripe::PaymentLinkInvoiceCreation | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, on_behalf_of : Stripe::PaymentLinkOnBehalfOf | Nil = nil, payment_intent_data : Stripe::PaymentLinkPaymentIntentData | Nil = nil, payment_method_collection : String | Nil = nil, payment_method_types : Array(String) | Nil = nil, phone_number_collection : Stripe::PaymentLinksResourcePhoneNumberCollection | Nil = nil, restrictions : Stripe::PaymentLinkRestrictions | Nil = nil, shipping_address_collection : Stripe::PaymentLinkShippingAddressCollection | Nil = nil, shipping_options : Array(Stripe::PaymentLinksResourceShippingOption) | Nil = nil, submit_type : String | Nil = nil, subscription_data : Stripe::PaymentLinkSubscriptionData | Nil = nil, tax_id_collection : Stripe::PaymentLinksResourceTaxIdCollection | Nil = nil, transfer_data : Stripe::PaymentLinkTransferData | Nil = nil, url : String | Nil = nil, line_items : Stripe::PaymentLinksResourceListLineItems | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance Method Summary

• #==(other : self)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #active : Bool | Nil
• #active=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #after_completion : Stripe::PaymentLinksResourceAfterCompletion | Nil
• #after_completion=(new_value : Stripe::PaymentLinksResourceAfterCompletion | Nil)

  Custom attribute writer method checking allowed values (enum).

• #allow_promotion_codes : Bool | Nil
• #allow_promotion_codes=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #application : Stripe::PaymentLinkApplication | Nil
• #application=(new_value : Stripe::PaymentLinkApplication | Nil)

  Custom attribute writer method checking allowed values (enum).

• #application_fee_amount : Int64 | Nil
• #application_fee_amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #application_fee_percent : Float64 | Nil
• #application_fee_percent=(new_value : Float64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #automatic_tax : Stripe::PaymentLinksResourceAutomaticTax | Nil
• #automatic_tax=(new_value : Stripe::PaymentLinksResourceAutomaticTax | Nil)

  Custom attribute writer method checking allowed values (enum).

• #billing_address_collection : String | Nil
• #billing_address_collection=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #consent_collection : Stripe::PaymentLinkConsentCollection | Nil
• #consent_collection=(new_value : Stripe::PaymentLinkConsentCollection | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #custom_fields : Array(Stripe::PaymentLinksResourceCustomFields) | Nil
• #custom_fields=(new_value : Array(Stripe::PaymentLinksResourceCustomFields) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #custom_text : Stripe::PaymentLinksResourceCustomText | Nil
• #custom_text=(new_value : Stripe::PaymentLinksResourceCustomText | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer_creation : String | Nil
• #customer_creation=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #inactive_message : String | Nil
• #inactive_message=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #invoice_creation : Stripe::PaymentLinkInvoiceCreation | Nil
• #invoice_creation=(new_value : Stripe::PaymentLinkInvoiceCreation | Nil)

  Custom attribute writer method checking allowed values (enum).

• #line_items : Stripe::PaymentLinksResourceListLineItems | Nil
• #line_items=(new_value : Stripe::PaymentLinksResourceListLineItems | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #on_behalf_of : Stripe::PaymentLinkOnBehalfOf | Nil
• #on_behalf_of=(new_value : Stripe::PaymentLinkOnBehalfOf | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_intent_data : Stripe::PaymentLinkPaymentIntentData | Nil
• #payment_intent_data=(new_value : Stripe::PaymentLinkPaymentIntentData | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_collection : String | Nil
• #payment_method_collection=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payment_method_types : Array(String) | Nil
• #payment_method_types=(new_value : Array(String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #phone_number_collection : Stripe::PaymentLinksResourcePhoneNumberCollection | Nil
• #phone_number_collection=(new_value : Stripe::PaymentLinksResourcePhoneNumberCollection | Nil)

  Custom attribute writer method checking allowed values (enum).

• #restrictions : Stripe::PaymentLinkRestrictions | Nil
• #restrictions=(new_value : Stripe::PaymentLinkRestrictions | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shipping_address_collection : Stripe::PaymentLinkShippingAddressCollection | Nil
• #shipping_address_collection=(new_value : Stripe::PaymentLinkShippingAddressCollection | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shipping_options : Array(Stripe::PaymentLinksResourceShippingOption) | Nil
• #shipping_options=(new_value : Array(Stripe::PaymentLinksResourceShippingOption) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #submit_type : String | Nil
• #submit_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #subscription_data : Stripe::PaymentLinkSubscriptionData | Nil
• #subscription_data=(new_value : Stripe::PaymentLinkSubscriptionData | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tax_id_collection : Stripe::PaymentLinksResourceTaxIdCollection | Nil
• #tax_id_collection=(new_value : Stripe::PaymentLinksResourceTaxIdCollection | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transfer_data : Stripe::PaymentLinkTransferData | Nil
• #transfer_data=(new_value : Stripe::PaymentLinkTransferData | Nil)

  Custom attribute writer method checking allowed values (enum).

• #url : String | Nil
• #url=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

  Check to see if the all the properties in the model are valid @return true if the model is valid

Constructor Detail

Instance Method Detail