PaymentLink class final

PaymentLink

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

Implemented types

Constructors

PaymentLink({required bool active, required PaymentLinksResourceAfterCompletion afterCompletion, required bool allowPromotionCodes, BillingPortalConfigurationApplicationOrId? application, int? applicationFeeAmount, double? applicationFeePercent, required PaymentLinksResourceAutomaticTax automaticTax, required PaymentLinkBillingAddressCollection billingAddressCollection, CheckoutSessionConsentCollection? consentCollection, required String currency, required List<PaymentLinksResourceCustomFields> customFields, required PaymentLinksResourceCustomText customText, required PaymentLinkCustomerCreation customerCreation, required String id, String? inactiveMessage, PaymentLinkInvoiceCreation? invoiceCreation, CheckoutSessionLineItems? lineItems, required bool livemode, required Map<String, String> metadata, AccountOrId? onBehalfOf, PaymentLinkPaymentIntentData? paymentIntentData, required PaymentLinkCustomerCreation paymentMethodCollection, List<PaymentLinkPaymentMethodTypesItem>? paymentMethodTypes, required PaymentLinksResourcePhoneNumberCollection phoneNumberCollection, PaymentLinkRestrictions? restrictions, CheckoutSessionShippingAddressCollection? shippingAddressCollection, required List<PaymentLinksResourceShippingOption> shippingOptions, required PaymentLinkSubmitType submitType, PaymentLinkSubscriptionData? subscriptionData, required PaymentLinksResourceTaxIdCollection taxIdCollection, InvoiceTransferData? transferData, required String url}): PaymentLink
const
PaymentLink.fromJson(Object? json): factory

Properties

active → bool: final
afterCompletion → PaymentLinksResourceAfterCompletion: final
allowPromotionCodes → bool: final
application → BillingPortalConfigurationApplicationOrId?: final
applicationFeeAmount → int?: final
applicationFeePercent → double?: final
automaticTax → PaymentLinksResourceAutomaticTax: final
billingAddressCollection → PaymentLinkBillingAddressCollection: final
consentCollection → CheckoutSessionConsentCollection?: final
currency → String: final
customerCreation → PaymentLinkCustomerCreation: final
customFields → List<PaymentLinksResourceCustomFields>: final
customText → PaymentLinksResourceCustomText: final
hashCode → int: The hash code for this object.
no setterinherited
id → String: The ID of the PaymentLink.
final
inactiveMessage → String?: final
invoiceCreation → PaymentLinkInvoiceCreation?: Configuration for creating invoice for payment mode payment links.
final
lineItems → CheckoutSessionLineItems?: final
livemode → bool: final
metadata → Map<String, String>: final
object → String: The resource's type.
final
onBehalfOf → AccountOrId?: final
paymentIntentData → PaymentLinkPaymentIntentData?: Indicates the parameters to be passed to PaymentIntent creation during checkout.
final
paymentMethodCollection → PaymentLinkCustomerCreation: final
paymentMethodTypes → List<PaymentLinkPaymentMethodTypesItem>?: final
phoneNumberCollection → PaymentLinksResourcePhoneNumberCollection: final
restrictions → PaymentLinkRestrictions?: Settings that restrict the usage of a payment link.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shippingAddressCollection → CheckoutSessionShippingAddressCollection?: final
shippingOptions → List<PaymentLinksResourceShippingOption>: final
submitType → PaymentLinkSubmitType: final
subscriptionData → PaymentLinkSubscriptionData?: 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`.
final
taxIdCollection → PaymentLinksResourceTaxIdCollection: final
transferData → InvoiceTransferData?: final
url → String: final

Methods

encodeWith<V>(Encoder<V> encoder) → V: override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>: override
toString() → String: A string representation of this object.
override

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

encode<V>(PaymentLink instance, Encoder<V> encoder) → V: override