Payment links
No code at all: in the dashboard, under Payment links, say what it is for and how much, and share the link you get — https://orboni.com/l/plink_… — in a message, a post, an invoice, or as the QR code its card draws (SVG for print, PNG for a post). Each buyer who opens it gets a checkout session of their own, on the same payment page; one who comes back while theirs is still open is sent to it rather than given a second.
The amount is fixed, or the buyer chooses it (a tip, a donation, an invoice of any sum): the link’s page then asks for it in the link’s currency, between the least and the most you allow, starting from the amount you suggest. A link may also stop by itself — after so many paid payments, or at the end of a day you pick.
A link is priced in US dollars or in any other currency a checkout session takes. Each payment it opens is turned into dollars at the rate of its own day (the European Central Bank’s, or the market’s for a currency the ECB does not publish): a link in euros asks the same euros every day, and what they are worth in dollars moves with the rate. While we have no current rate for its currency, the link takes no new payment.
The sessions are like any other: they are in Payments (filtered by the link from its card), in exports, in the API and in every webhook, where payment_link names the link. A link has no order number of its own, so match such payments by payment_link and customer_email. With “After payment, send to” set, the buyer goes there once paid, as with success_url.
Changing a link applies to the payments opened after; the ones already open keep what it said. A link switched off, past its date or with all its payments taken says so, and while your account cannot take live payments (email not confirmed, receiving frozen, an invoice of ours past due) it says it cannot take payments now and asks the buyer to contact you. A program reading the link — a messenger drawing its preview, a search engine — is shown what is paid for and opens no payment, and so is another page loading it as an image, a script, a frame or a prefetch: only a visit opens one. A link with all its payments taken takes no new coin choice on payments already open from it either.
A link keeps at most 100 open payments in which nobody has picked a coin; past that a new visitor closes the oldest. Such a payment — and one that runs out with no coin picked — closes without checkout.session.expired. A project has at most 200 links switched on in each mode. A change to a live link’s amount, its limits or where it sends buyers is emailed to the project’s owner.
The API
Create a payment link
POST/v1/payment_links
- descriptionstring, required
- What is paid for, up to 250 characters. The buyer sees it on the link’s page and the payment page.
- amountinteger
- In the currency’s smallest unit, worth $1.00 to $100,000 at the day’s rate — in usd, from 100 to 10000000. Required unless custom_amount; with it, the amount suggested to the buyer.
- currencystring
- The link’s currency, as on a checkout session: usd (the default), eur, gbp, jpy… Its amounts are in it. One we have no current rate for is refused with 422 on currency.
- custom_amountboolean
- The buyer types the amount. Default false.
- min_amount, max_amountinteger
- With custom_amount: the least and the most the buyer may pay, in the link’s currency. Default: worth $1.00 and $100,000 at the day’s rate; the least is raised to what the networks you take can carry at the time.
- max_paymentsinteger
- The link takes no new payment once this many are paid.
- expires_attimestamp
- Unix seconds: the link takes no new payment from then on. Up to a year ahead.
- detailsstring
- What the buyer gets, in your words, up to 500 characters; a longer one is refused (422).
- success_urlstring
- Where the buyer goes once paid.
curl https://orboni.com/v1/payment_links -u sk_live_…: -H "Idempotency-Key: link-invoice_2207" -d description="Logo design" -d amount=4900 -d max_payments=1status says whether the link takes payments: active; inactive — switched off; expired — past expires_at; completed — payments_paid reached max_payments.
List payment links
GET/v1/payment_links
Newest first; active=true or false narrows it to links switched on or off, and any other value answers 400.
Retrieve a payment link
GET/v1/payment_links/{id}
Update a payment link
POST/v1/payment_links/{id}
Send only what changes: any field of create, and active=false to switch the link off (true to switch it on again). A link is never deleted. An empty expires_at or max_payments removes the limit.
This page as Markdown, for a program or an AI assistant: /docs/payment-links.md. Something missing or unclear? Write to us from the dashboard’s Help & Support.