Update a payment link
Updates mutable fields on an existing payment link. All fields are optional;
only those present in the request body are changed. When line_items is
provided, currency and amount_total are also required. Sending an empty
array for optional_items or custom_fields clears those lists.
Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
A unique key that makes retries safe: the same key with the same request body returns the original response instead of repeating the operation.
255Path Parameters
The payment link id (pl_…).
Body
All fields are optional; absent fields are not modified. Providing line_items requires currency and amount_total.
Replaces the existing line items. Requires currency and amount_total.
Replaces optional items. Send an empty array to clear.
New total in minor units. Required when line_items is provided.
New currency. Required when line_items is provided.
Specifies which contact fields to collect at checkout and how.
Replaces custom fields. Send an empty array to clear.
pay, book, donate one_time, subscription, invoice Visual overrides for the hosted checkout page.
Payment-intent configuration forwarded when a checkout session is created from this link.
Response
The updated payment link.
Payment link identifier (pl_…).
payment_link True for live-mode links; false for test-mode.
False when deactivated; the hosted checkout shows an inactive state.
The public checkout URL (https://buy.ionicfi.com/c/…).
Three-letter ISO currency code.
Total in minor units.
Specifies which contact fields to collect at checkout and how.
pay, book, donate one_time, subscription, invoice Unix epoch seconds.
Omitted when the link has no optional add-ons.
Omitted when the link has no custom fields.
Omitted when no branding overrides are set.
Omitted when no payment-intent overrides are set.

