Payment links
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/payment-links.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
A payment link records how payments received on a sales order are split across its invoices (the web app calls this a payment allocation). It is not a URL or payment page a customer opens to pay, and it moves no money.
Learn more: Invoices and payments · Take payments and refunds
7 operations
- POSTCreate a payment link for a sales order
/A payment link (Allocations in the web app) records which invoices a payment pays: it splits payments received on the order across the order's invoices.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {hash_id}/ payment_link - GETList the payment links of a sales order
/A payment link (Allocations in the web app) records which invoices a payment pays: it splits payments received on the order across the order's invoices.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {hash_id}/ payment_link - GETShow one payment link with allocations
/A payment link records how payments already received on a sales order are split across its invoices (the web app calls this a payment allocation).v2/ api/ store/ {team_slug}/ v2/ payment_link/ {hash_id} - GETGet the starting point for editing a payment link
/Returns what you need to build an Update a payment link body: the link with itsv2/ api/ store/ {team_slug}/ v2/ payment_link/ {hash_id}/ get_update_template allocated_transactions(stateexisting, each with its allocationid), plusunallocated_transactions: every payment on the order that still has money… - GETGet what a new payment link can allocate
/A payment link (Allocations in the web app) records which invoices a payment pays: it splits payments received on the order across the order's invoices.v2/ api/ store/ {team_slug}/ v2/ sales_order/ {hash_id}/ payment_link/ get_create_template - PUTUpdate a payment link
/A payment link records how payments already received on a sales order are split across its invoices (the web app calls this a payment allocation).v2/ api/ store/ {team_slug}/ v2/ payment_link/ {hash_id} - DELETEDelete a payment link
/Deletes a payment link and all its allocations.v2/ api/ store/ {team_slug}/ v2/ payment_link/ {hash_id}