Payment Link

A payment link is a shareable URL that takes your customers to a Checkout page.

  • id
    Type: string
    required

    Unique identifier for the payment link.

  • created
    Type: stringFormat: date-time
    required

    Creation time for the payment link.

  • amount
    Type: integerFormat: int64
    required

    Amount charged in smallest currency unit.

  • currency
    Type: Currency
    required

    Three-letter ISO currency code

    Properties: 2
  • status
    Type: stringenum
    required

    Current lifecycle status of the payment link.

    values
    • draft

      The link has been created but is not yet available for customers.

    • open

      The link can accept payments while active is true.

    • completed

      The link has reached its completed-session limit and cannot accept new payments.

    • expired

      The link has passed its expiration time and cannot accept new payments.

  • active
    Type: boolean
    required

    Whether the payment link's public URL is active. When false, customers cannot use the link to start a new payment.

  • url
    Type: string
    max length:  
    1000
    required

    The public URL that can be shared with customers.

  • expires_at
    Type: string | nullFormat: date-time
    required

    Expiry time for the payment link. After this time, the link is no longer available for payment. Single-use links default to 30 days after creation when no expiration is provided. Reusable links without an explicit expiration return null.

  • livemode
    Type: boolean
    required

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

  • customer
    required

    Customer associated with the payment link, or null when none is set. Pass expand=customer when retrieving or listing links to include the Customer object.

    • Type: Customer ID
      max length:  
      100

      Customer associated with the payment link, or null when none is set. Pass expand=customer when retrieving or listing links to include the Customer object.

  • on_behalf_of
    Type: string | null
    max length:  
    100
    required

    The account on behalf of which to charge, or null when none is set.

  • payment_method_configuration
    Type: string | null

    Reference to the payment method configuration for the types that customers can use.

  • payment_method_types
    Type: array of PaymentMethodType | nullenum

    Payment method types that Checkout Sessions created from this Payment Link can accept. Returns null when no explicit types are set.

  • billing_address_collection
    Type: BillingAddressCollectionenum

    Specify whether Checkout should collect the customer's billing address. Defaults to auto.

    values
    • auto

      Checkout will only collect the billing address when necessary.

    • required

      Checkout will always collect the customer's billing address.

  • line_items
    Type: array of LineItem | null

    Details about the products sold or services provided

    Properties: 4
  • 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.

  • 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.

  • 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.

  • description
    Type: string | null

    A free-form reference to describe the checkout

  • after_completion
    Type: AfterCompletion

    After completion behavior for the Checkout Session.

    Properties: 3
  • mode
    Type: CheckoutSessionModeenum

    The mode of the Checkout Session.

    values
    • payment

      Standard one-time payment.

    • setup

      Set up a payment method for future use.

    • subscription

      Create a subscription checkout that collects the first payment and stores a reusable payment method for renewal billing.

    • bnpl

      Buy now, pay later.

  • restrictions
    Type: PaymentLinkRestrictions

    Settings that restrict the usage of a payment link.

    Properties: 1
  • locale
    Type: Localeenum

    The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used.

    values
    • auto
    • bg
    • bg-BG
    • cs
    • cs-CZ
    • da
    • da-DK
    • de