Search documentation of stripe_elixir

# StripeElixir.Params.PaymentLinkUpdateParams (stripe_elixir v0.1.0)

Copy Markdown View Source

Parameters for payment link update.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.PaymentLinkUpdateParams{
      active: boolean() | nil,
      after_completion: map() | nil,
      allow_promotion_codes: boolean() | nil,
      automatic_tax: map() | nil,
      billing_address_collection: String.t() | nil,
      custom_fields: map() | nil,
      custom_text: map() | nil,
      customer_creation: String.t() | nil,
      expand: [String.t()] | nil,
      inactive_message: map() | nil,
      invoice_creation: map() | nil,
      line_items: [map()] | nil,
      metadata: map() | nil,
      name_collection: map() | nil,
      payment_intent_data: map() | nil,
      payment_method_collection: String.t() | nil,
      payment_method_types: map() | nil,
      phone_number_collection: map() | nil,
      restrictions: map() | nil,
      shipping_address_collection: map() | nil,
      submit_type: String.t() | nil,
      subscription_data: map() | nil,
      tax_id_collection: map() | nil
    }

- `active` - 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` - Behavior after the purchase is complete.
- `allow_promotion_codes` - Enables user redeemable promotion codes.
- `automatic_tax` - Configuration for automatic tax collection.
- `billing_address_collection` - Configuration for collecting the customer's billing address. Defaults to `auto`. Possible values: `auto`, `required`.
- `custom_fields` - Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`.
- `custom_text` - Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `custom`.
- `customer_creation` - Configures whether checkout sessions created by this payment link create a Customer. Possible values: `always`, `if_required`.
- `expand` - Specifies which fields in the response should be expanded.
- `inactive_message` - The custom message to be displayed to a customer when a payment link is no longer active.
- `invoice_creation` - Generate a post-purchase Invoice for one-time payments.
- `line_items` - The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.
- `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.
- `name_collection` - Controls settings applied for collecting the customer's name.
- `payment_intent_data` - A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
- `payment_method_collection` - 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. Defaults to `always`.

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. Possible values: `always`, `if_required`.

- `payment_method_types` - 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.
- `phone_number_collection` - Controls phone number collection settings during checkout.

We recommend that you review your privacy policy and check with your legal contacts.

- `restrictions` - Settings that restrict the usage of a payment link.
- `shipping_address_collection` - Configuration for collecting the customer's shipping address.
- `submit_type` - Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the url property (example: `donate.stripe.com`). Possible values: `auto`, `book`, `donate`, `pay`, `subscribe`.
- `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`.
- `tax_id_collection` - Controls tax ID collection during checkout.