Skip to main content

Documentation Index

Fetch the complete documentation index at: https://storekit.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use payment links to collect payments outside of the standard order flow. Share a link via email or SMS and your customer pays directly through a hosted checkout page — no order required. Payment links come in two types:
TypeDescription
One-offDeactivates automatically after a single successful payment
ReusableStays active and accepts multiple payments (optionally up to a configured limit)

​
Amount types

TypeDescription
FixedA set amount the customer must pay
VariableThe customer enters the amount at checkout, optionally within a min/max range you configure
1

Open Payment Links

Go to Payments > Payment Links in your dashboard and click Create link.
2

Configure the link

Fill in the link details:
  • Title — displayed to the customer at checkout (required)
  • Description — optional context shown below the title
  • Reference — an internal reference for your records (e.g. an invoice number)
  • Type — one-off or reusable
  • Amount type — fixed or variable
  • Amount — required for fixed links; enter in your store’s currency
  • Min / Max amount — optional bounds for variable links
  • Max payments — optional cap on total payments for reusable links
  • Expiry date — optional date after which the link becomes inactive
  • Image — optional image displayed on the checkout page
  • Customer details — optionally collect business name, customer name, email, and phone at checkout (see Customer detail collection)
3

Configure post-payment behaviour

Choose what happens after a successful payment:
  • Thank you page — show a customisable thank-you message (default)
  • Redirect — send the customer to a URL of your choice
4

Share the link

Once created, copy the link URL or use the Send option to deliver it by email or SMS.
You can send a payment link directly from the dashboard:
  1. Open the payment link from Payments > Payment Links
  2. Click Send
  3. Enter the customer’s email address or phone number
  4. Click Send link
The customer receives a message with a direct link to the checkout page.
StatusDescription
ActiveThe link is live and accepting payments
InactiveThe link has been manually deactivated, or a one-off link has been paid
ExpiredThe link’s expiry date has passed
To stop a link from accepting payments, open it from Payments > Payment Links and click Deactivate. Deactivated links return a “no longer active” message to anyone who visits them.

​
Customer detail collection

You can configure a payment link to collect customer information at checkout. Each field can be set independently to one of three modes:
ModeDescription
disabledThe field is not shown at checkout (default)
optionalThe field is shown but not required
requiredThe field must be filled in before payment can proceed
The available fields are:
  • Business name — the customer’s company or trading name
  • Customer name — the customer’s full name
  • Email — the customer’s email address
  • Phone — the customer’s phone number
Collected details are stored against each payment record and visible in the Transactions tab.

​
QR codes

Every payment link has a QR code that encodes the checkout URL. You can download the QR code as a PNG image from the payment link detail page, or generate it via the API or MCP get-payment-link-qr tool. The QR code is useful for printing on invoices, receipts, or physical signage so customers can scan and pay directly.

​
Refunds

You can issue a refund for any payment collected via a payment link:
  1. Open the payment link from Payments > Payment Links
  2. Go to the Transactions tab
  3. Select the payment you want to refund
  4. Click Refund and enter the amount
Partial refunds are supported. The payment status updates to Partially refunded or Fully refunded accordingly.

​
Viewing transactions

Each payment link has a Transactions tab showing all payments received, including the amount, currency, payment reference, and any customer details collected. Payment links use a plink_ prefixed ID (for example, plink_019dbc4d828174419d9ff9fae24aea7b). Use this ID when referencing a link via the API or webhooks.

​
Webhook events

Storekit fires the following webhook events for payment links:
EventDescription
payment_link.createdFired when a new payment link is created
payment_link.paidFired when a payment is successfully collected via a payment link
payment_link.refund.createdFired when a refund is initiated for a payment link payment
payment_link.refund.succeededFired when the payment gateway confirms a refund succeeded
payment_link.refund.failedFired when the payment gateway rejects a refund
See Webhook Events for full payload references.

​
API & MCP access

Payment links are available via the storekit API and MCP tools. You can:
  • List payment links (filter by venue, status, or type)
  • Get a single payment link by ID
  • Create a new payment link
  • Generate a QR code for a payment link (get-payment-link-qr)
See the Developer Introduction for more on API and MCP access.