Struct UpdatePaymentLink 

pub struct UpdatePaymentLink<'a> {

    pub active: Option<bool>,
    pub after_completion: Option<UpdatePaymentLinkAfterCompletion>,
    pub allow_promotion_codes: Option<bool>,
    pub automatic_tax: Option<UpdatePaymentLinkAutomaticTax>,
    pub billing_address_collection: Option<PaymentLinkBillingAddressCollection>,
    pub custom_fields: Option<Vec<UpdatePaymentLinkCustomFields>>,
    pub custom_text: Option<UpdatePaymentLinkCustomText>,
    pub customer_creation: Option<PaymentLinkCustomerCreation>,
    pub expand: &'a [&'a str],
    pub inactive_message: Option<String>,
    pub invoice_creation: Option<UpdatePaymentLinkInvoiceCreation>,
    pub line_items: Option<Vec<UpdatePaymentLinkLineItems>>,
    pub metadata: Option<Metadata>,
    pub payment_intent_data: Option<UpdatePaymentLinkPaymentIntentData>,
    pub payment_method_collection: Option<PaymentLinkPaymentMethodCollection>,
    pub payment_method_types: Option<Vec<UpdatePaymentLinkPaymentMethodTypes>>,
    pub restrictions: Option<UpdatePaymentLinkRestrictions>,
    pub shipping_address_collection: Option<UpdatePaymentLinkShippingAddressCollection>,
    pub subscription_data: Option<UpdatePaymentLinkSubscriptionData>,
}

Available on crate feature checkout only.

The parameters for PaymentLink::update.

Fields

active: Option<bool>

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.

after_completion: Option<UpdatePaymentLinkAfterCompletion>

Behavior after the purchase is complete.

allow_promotion_codes: Option<bool>

Enables user redeemable promotion codes.

automatic_tax: Option<UpdatePaymentLinkAutomaticTax>

Configuration for automatic tax collection.

billing_address_collection: Option<PaymentLinkBillingAddressCollection>

Configuration for collecting the customer’s billing address.

custom_fields: Option<Vec<UpdatePaymentLinkCustomFields>>

Collect additional information from your customer using custom fields.

Up to 3 fields are supported.

custom_text: Option<UpdatePaymentLinkCustomText>

Display additional text for your customers using custom text.

customer_creation: Option<PaymentLinkCustomerCreation>

Configures whether checkout sessions created by this payment link create a Customer.

expand: &'a [&'a str]

Specifies which fields in the response should be expanded.

inactive_message: Option<String>

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

invoice_creation: Option<UpdatePaymentLinkInvoiceCreation>

Generate a post-purchase Invoice for one-time payments.

line_items: Option<Vec<UpdatePaymentLinkLineItems>>

The line items representing what is being sold.

Each line item represents an item being sold. Up to 20 line items are supported.

metadata: Option<Metadata>

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata. Metadata associated with this Payment Link will automatically be copied to checkout sessions created by this payment link.

payment_intent_data: Option<UpdatePaymentLinkPaymentIntentData>

A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.

payment_method_collection: Option<PaymentLinkPaymentMethodCollection>

Specify whether Checkout should collect a payment method.

When set to if_required, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in subscription mode. If you’d like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial.

payment_method_types: Option<Vec<UpdatePaymentLinkPaymentMethodTypes>>

The list of payment method types that customers can use.

Pass an empty string to enable dynamic payment methods that use your payment method settings.

restrictions: Option<UpdatePaymentLinkRestrictions>

Settings that restrict the usage of a payment link.

shipping_address_collection: Option<UpdatePaymentLinkShippingAddressCollection>

Configuration for collecting the customer’s shipping address.

subscription_data: Option<UpdatePaymentLinkSubscriptionData>

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.

Implementations

impl<'a> UpdatePaymentLink<'a>

pub fn new() -> Self

Trait Implementations

impl<'a> Clone for UpdatePaymentLink<'a>

fn clone(&self) -> UpdatePaymentLink<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for UpdatePaymentLink<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for UpdatePaymentLink<'a>

fn default() -> UpdatePaymentLink<'a>

Returns the “default value” for a type.

impl<'a> Serialize for UpdatePaymentLink<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.