Defines the object schema located at components.schemas.payment_link in the specification.
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
Constructors
PaymentLinkpaymentLinkActive :: Boolactive: 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.
paymentLinkAfterCompletion :: PaymentLinksResourceAfterCompletionafter_completion:
paymentLinkAllowPromotionCodes :: Boolallow_promotion_codes: Whether user redeemable promotion codes are enabled.
paymentLinkApplicationFeeAmount :: Maybe (Nullable Int)application_fee_amount: 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.
paymentLinkApplicationFeePercent :: Maybe (Nullable Double)application_fee_percent: This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.
paymentLinkAutomaticTax :: PaymentLinksResourceAutomaticTaxautomatic_tax:
paymentLinkBillingAddressCollection :: PaymentLinkBillingAddressCollection'billing_address_collection: Configuration for collecting the customer's billing address.
paymentLinkConsentCollection :: Maybe (Nullable PaymentLinkConsentCollection'NonNullable)consent_collection: When set, provides configuration to gather active consent from customers.
paymentLinkCustomerCreation :: PaymentLinkCustomerCreation'customer_creation: Configuration for Customer creation during checkout.
paymentLinkId :: Textid: Unique identifier for the object.
Constraints:
Maximum length of 5000
paymentLinkLineItems :: Maybe PaymentLinkLineItems'line_items: The line items representing what is being sold.
paymentLinkLivemode :: Boollivemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
paymentLinkMetadata :: Objectmetadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
paymentLinkOnBehalfOf :: Maybe (Nullable PaymentLinkOnBehalfOf'NonNullableVariants)on_behalf_of: The account on behalf of which to charge. See the Connect documentation for details.
paymentLinkPaymentIntentData :: Maybe (Nullable PaymentLinkPaymentIntentData'NonNullable)payment_intent_data: Indicates the parameters to be passed to PaymentIntent creation during checkout.
paymentLinkPaymentMethodTypes :: Maybe (Nullable [PaymentLinkPaymentMethodTypes'NonNullable])payment_method_types: 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.
paymentLinkPhoneNumberCollection :: PaymentLinksResourcePhoneNumberCollectionphone_number_collection:
paymentLinkShippingAddressCollection :: Maybe (Nullable PaymentLinkShippingAddressCollection'NonNullable)shipping_address_collection: Configuration for collecting the customer's shipping address.
paymentLinkShippingOptions :: [PaymentLinksResourceShippingOption]shipping_options: The shipping rate options applied to the session.
paymentLinkSubmitType :: PaymentLinkSubmitType'submit_type: Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
paymentLinkSubscriptionData :: Maybe (Nullable PaymentLinkSubscriptionData'NonNullable)subscription_data: 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`.
paymentLinkTaxIdCollection :: PaymentLinksResourceTaxIdCollectiontax_id_collection:
paymentLinkTransferData :: Maybe (Nullable PaymentLinkTransferData'NonNullable)transfer_data: The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
paymentLinkUrl :: Texturl: The public URL that can be shared with customers.
Constraints:
Maximum length of 5000
Instances4Eq, Show, FromJSON, ToJSON
Eq PaymentLinkDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PaymentLinkShow PaymentLinkDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PaymentLinkFromJSON PaymentLinkDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PaymentLinkToJSON PaymentLinkDefined in stripeapi-3.0.0.0 · StripeAPI.Types.PaymentLink