Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

A merchant secret key (sk_…) sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

A unique key that makes retries safe: the same key with the same request body returns the original response instead of repeating the operation.

Maximum string length: 255

Path Parameters

id
string
required

The payment link id (pl_…).

Response

The deactivated payment link.

id
string
required

Payment link identifier (pl_…).

object
enum<string>
required
Available options:
payment_link
merchant_id
string
required

ID of the account that owns the payment link (mer_…).

livemode
boolean
required

True for live-mode links; false for test-mode.

active
boolean
required

False when deactivated; the hosted checkout shows an inactive state.

name
string
required

Display name shown on the hosted checkout.

description
string | null
required

Description shown on the checkout page.

url
string
required

The public checkout URL (https://buy.ionicfi.com/c/…).

currency
string
required

Three-letter ISO currency code.

amount_total
integer
required

Total in minor units.

line_items
object[]
required

Price references that make up the order.

collect_config
object
required

Specifies which contact fields to collect at checkout and how.

submit_type
enum<string> | null
required

Label for the checkout submit button.

Available options:
pay,
book,
donate

The kind of payment the link collects: one_time, subscription, or invoice.

Available options:
one_time,
subscription,
invoice
theme_id
string | null
required

Theme id applied to the checkout page.

success_url
string | null
required

URL to redirect to after a successful payment.

cancel_url
string | null
required

URL to redirect to if the buyer cancels.

inactive_message
string | null
required

Message shown on the checkout when the link is inactive.

metadata
object
required

Custom key-value pairs for your use.

created_at
integer
required

Unix epoch seconds.

updated_at
integer
required

Unix epoch seconds when the link was last updated.

optional_items
object[]

Omitted when the link has no optional add-ons.

custom_fields
object[]

Omitted when the link has no custom fields.

branding
object | null

Omitted when no branding overrides are set.

payment_intent_data
object | null

Omitted when no payment-intent overrides are set.