exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.PaymentLink (exoapi_stripe v0.1.4)

description: 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

:active :: :boolean

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 :: ExOAPI.Stripe.Schemas.PaymentLinksResourceAfterCompletion

:allow_promotion_codes :: :boolean

Whether user redeemable promotion codes are enabled.

:application_fee_amount :: :integer

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.

:application_fee_percent :: :number

This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.

:automatic_tax :: ExOAPI.Stripe.Schemas.PaymentLinksResourceAutomaticTax

:billing_address_collection :: :string

Configuration for collecting the customer's billing address.

:id :: :string

Unique identifier for the object.

::data :: ExOAPI.Stripe.Schemas.Item

:has_more :: :boolean

True if this list has another page of items after this one that can be fetched.

:object :: :string

String representing the object's type. Objects of the same type share the same value. Always has the value list.

:url :: :string

The URL where this list can be accessed.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:metadata :: :map

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.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:on_behalf_of :: ExOAPI.Stripe.Schemas.Account | :string

The account on behalf of which to charge. See the Connect documentation for details.

::payment_method_types :: :string

:phone_number_collection :: ExOAPI.Stripe.Schemas.PaymentLinksResourcePhoneNumberCollection

:shipping_address_collection :: ExOAPI.Stripe.Schemas.PaymentLinksResourceShippingAddressCollection

Configuration for collecting the customer's shipping address.

:subscription_data :: ExOAPI.Stripe.Schemas.PaymentLinksResourceSubscriptionData

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.

:transfer_data :: ExOAPI.Stripe.Schemas.PaymentLinksResourceTransferData

The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.

:url :: :string

The public URL that can be shared with customers.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.PaymentLink{
  active: boolean() | nil,
  after_completion:
    ExOAPI.Stripe.Schemas.PaymentLinksResourceAfterCompletion.t() | nil,
  allow_promotion_codes: boolean() | nil,
  application_fee_amount: integer() | nil,
  application_fee_percent: float() | nil,
  automatic_tax:
    ExOAPI.Stripe.Schemas.PaymentLinksResourceAutomaticTax.t() | nil,
  billing_address_collection: (:required | :auto) | nil,
  id: String.t() | nil,
  line_items: map() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  object: :payment_link | nil,
  on_behalf_of: ExOAPI.EctoTypes.AnyOf.t() | nil,
  payment_method_types: [String.t()] | nil,
  phone_number_collection:
    ExOAPI.Stripe.Schemas.PaymentLinksResourcePhoneNumberCollection.t() | nil,
  shipping_address_collection: ExOAPI.EctoTypes.AnyOf.t() | nil,
  subscription_data: ExOAPI.EctoTypes.AnyOf.t() | nil,
  transfer_data: ExOAPI.EctoTypes.AnyOf.t() | nil,
  url: String.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()