Skip to main content
Payment links are reusable checkout links backed by catalog prices. Create products and prices first, then create a link with one or more price_id line items. For request fields, required badges, examples, and response schemas, open the endpoint pages in this group. A typical setup creates catalog records with Create product and Create price, then publishes a reusable link with Create payment link. Buyers enter through the public link and create buyer-scoped checkout sessions from there.

​
Attributes

​
string
Payment link identifier (pl_…).
​
boolean
False when deactivated; the hosted checkout shows an inactive state.
​
string
Display name shown on the hosted checkout.
​
string
The public checkout URL (https://buy.ionicfi.com/c/…).
​
string
Three-letter ISO currency code.
​
integer
Total in minor units.
​
array of objects
Price references that make up the order.
​
object
Custom key-value pairs for your use.
See every field in the response of Retrieve a payment link.

​
Endpoints

​
Notes

  • name, line_items, currency, and amount_total are required on create.
  • line_items uses price_id; payment links do not accept inline name and amount items.
  • When updating line_items, include the new currency and amount_total.
  • collect_config controls buyer fields on hosted checkout.
  • custom_fields is for merchant-defined checkout fields such as PO number or account ID.