PaymentLinkBase

A payment link is a shareable URL that will take your customers to a hosted payment page.

amount
Type: integerFormat: int64
required

Amount charged in smallest currency unit
after_completion
Type: object · AfterCompletion

After completion behavior for the Checkout Session.
- hosted
  Type: object · AfterCompletionHostedConfirmation
  
  After completion behavior for the Checkout Session.
- redirect
  Type: object · AfterCompletionRedirect
  
  After completion behavior for the Checkout Session.
- type
  Type: string · AfterCompletionTypeenum
  
  After completion behavior for the Checkout Session.
  
  values
  redirect
  hosted_confirmation
client_customer_id
Type: string | null

An identifier of the customer in the merchant's system. Used to associate the Checkout and corresponding payments created from the Checkout. Required for SEPA payments - this will ensure that your customer is given a virtual iban that is unique to them and will enable Paypercut to reconcile the payment.
client_reference_id
Type: string | null

A free-form reference from the merchant's system. Typically used to identify the checkout in the merchant's system. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
description
Type: string | null

A free-form reference to describe the checkout
expires_at
Type: stringFormat: date-time

Expiry time for the payment link. After this time, the payment link will no longer be available for payment. Defaults to 24h after creation.
line_items
Type: array object[] | null · LineItem[]

Details about the products sold or services provided
- quantity
  Type: integerFormat: int64
  min:
  1
  max:
  10000000000
  required
  
  Quantity of the item
- 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.
  
  propertyName
  Type: string
- price_data
  
  Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
  
  active
  Type: boolean
  
  Whether the price can be used for new purchases.
  
  billing_scheme
  Type: stringenum
  
  Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
  
  values
  per_unit
  tiered
  created
  Type: integerFormat: date-time nullable
  
  Time at which the object was created. Measured in seconds since the Unix epoch.
  
  currency
  Type: stringFormat: currency
  
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
  
  id
  Type: string
  max length:
  5000
  
  Unique identifier for the object.
  
  livemode
  Type: boolean
  
  Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  
  lookup_key
  Type: string | null
  max length:
  5000
  
  A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
  
  product
  product_data
  Type: object · Product
  
  These fields can be used to create a new product that this price will belong to.
  
  recurring
  Type: object · Recurring nullable
  type
  Type: stringenum
  
  One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
  
  values
  one_time
  recurring
  unit_amount
  Type: integer | null
  
  The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
  
  unit_amount_decimal
  Type: string | nullFormat: decimal
  
  The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.
livemode
Type: boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.
mode
Type: string · CheckoutSessionModeenum

The mode of the Checkout Session.
values
- payment
  
  Standard one-time payment.
- setup
  
  Set up a payment method for future use.
- subscription
  
  Coming soon. Not available yet.
- bnpl
  
  Buy now, pay later.
on_behalf_of
Type: string
max length:
100

The account on behalf of which to charge.
payment_method_configuration
Type: string | null

Reference to the payment method configuration for the types that customers can use.
redirect_url
Type: string | null
max length:
1000

URL to which the customer should be sent after the payment. Any payment results will use this URL.
restrictions
Type: object · PaymentLinkRestrictions

Settings that restrict the usage of a payment link.
- completed_sessions
  Type: object · CompletedSessionsRestriction
  required
  
  Settings that restrict the usage of a payment link.