PaymentLinkCreateRequest

Request parameters for creating a new payment link.

  • amount
    Type: integerFormat: int64
    required

    Amount charged in smallest currency unit.

  • currency
    Type: CurrencyCode
    required

    ISO 4217 currency codes (alpha3) supported for payments

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

  • payment_method_types
    Type: array of PaymentMethodType | nullenum

    Payment method types that Checkout Sessions created from this Payment Link can accept.

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

  • customer
    Type: string | null
    max length:  
    100

    ID of the Customer to associate with Checkout Sessions created from this Payment Link.

  • expires_at
    Type: string | nullFormat: date-time

    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 have no expiration unless one is provided.

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

  • client_reference_id
    Type: string | null

    A free-form reference from your system, such as a customer or cart ID. Use it to reconcile Checkout Sessions created from this link with your internal records.

  • client_customer_id
    Type: string | null

    An identifier of the customer in your system. Required for SEPA payments to associate payments with the customer's virtual IBAN.

  • description
    Type: string | null

    A free-form description of the payment link.

  • livemode
    Type: boolean

    Has the value true for live mode or false for test mode.

  • after_completion
    Type: AfterCompletion

    After completion behavior for the Checkout Session.

    Properties: 3
  • mode
    Type: stringenum

    The mode of Checkout Sessions created from this Payment Link.

    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.

  • 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
  • submit_type
    Type: stringenum

    Customize Checkout text, such as the submit button, for the type of transaction. If omitted or auto, pay is used.

    values
    • auto

      Use the default payment wording.

    • pay

      Use payment wording.

    • book

      Use booking wording.

    • donate

      Use donation wording.

    • subscribe

      Use subscription wording.