Get buyer-facing payment link

{ "public_id": "<string>", "title": "<string>", "description": "<string>", "image_url": "<string>", "amount": "25.00", "currency": "USD", "min_amount": "<string>", "max_amount": "<string>", "suggested_amounts": [ "<string>" ], "store_name": "<string>", "merchant_name": "<string>", "store_logo_url": "<string>" }

Path Parameters

public_id

string

required

Public checkout token from the Pay Link's public_id field (starts with plpub_). Share this in checkout URLs; do not confuse with the merchant plink_ ID.

Pattern: ^plpub_[0-9a-z]{20,32}$

Example:

"plpub_c9a9bb730611077574c828af5af5fed1"

Response

Buyer-safe payment link details

Buyer-safe payment link view (no store UUIDs or webhook config).

public_id

string

Public token for this Pay Link (plpub_...). Used in checkout URLs.

Pattern: ^plpub_[0-9a-z]{20,32}$

title

string

Display name shown to payers on the checkout page.

description

string | null

Optional longer description or instructions for payers.

image_url

string<uri> | null

Hero or product image URL shown on checkout.

amount_mode

enum<string>

How pricing works on this Pay Link:

fixed_amount: you set the price; the customer pays exactly that amount
customer_defined_amount: the customer chooses how much to pay (within min/max you set)

Available options:

fixed_amount,

customer_defined_amount

amount

string | null

Fixed price when amount_mode is fixed_amount (decimal string).

Example:

"25.00"

currency

string

Currency for all amounts on this link (e.g. USD).

Example:

"USD"

min_amount

string | null

Minimum amount payers can enter when amount_mode is customer_defined_amount.

max_amount

string | null

Maximum amount payers can enter when amount_mode is customer_defined_amount.

suggested_amounts

string[]

Preset amount buttons shown on checkout for variable-amount links.

usage

enum<string>

reusable: multiple payers or repeat payments allowed (subject to link settings)
single_use: one successful payment completes the link

Available options:

reusable,

single_use

status

enum<string>

Whether the Pay Link can accept payments right now:

active: open for payments
inactive: turned off by you; no new payments
expired: past its expiration date
completed: single-use link already paid, or usage limit reached

Available options:

active,

inactive,

expired,

completed

store_name

string

Store display name shown to payers.

merchant_name

string

Merchant business name shown to payers.

store_logo_url

string<uri> | null

deprecated

Omitted on buyer API; use image_url when set on the link.