A valid request URL is required to generate request examples{
"id": "<string>",
"object": "payment_link",
"merchant_id": "<string>",
"livemode": true,
"active": true,
"name": "<string>",
"description": "<string>",
"url": "<string>",
"currency": "<string>",
"amount_total": 123,
"line_items": [
{
"price_id": "<string>",
"quantity": 2,
"adjustable_quantity": {
"minimum": 123,
"maximum": 123
}
}
],
"collect_config": {
"email": "required",
"name": "required",
"phone": "required",
"address": "required",
"require_full_billing_address": true,
"require_shipping_address": true,
"require_phone": true,
"wallet_billing_mode": "min"
},
"submit_type": "pay",
"link_type": "one_time",
"theme_id": "<string>",
"success_url": "<string>",
"cancel_url": "<string>",
"inactive_message": "<string>",
"metadata": {},
"created_at": 123,
"updated_at": 123,
"optional_items": [
{
"price_id": "<string>",
"quantity": 2,
"adjustable_quantity": {
"minimum": 123,
"maximum": 123
}
}
],
"custom_fields": [
{
"key": "<string>",
"label": "<string>",
"field_type": "text",
"required": true,
"options": [
"<string>"
]
}
],
"branding": {
"logo_url": "<string>",
"icon_url": "<string>",
"primary_color": "<string>",
"background_color": "<string>",
"font_family": "Inter",
"border_radius": "rounded"
},
"payment_intent_data": {
"capture_method": "automatic",
"setup_future_usage": "on_session",
"description": "<string>",
"reference": "<string>",
"metadata": {}
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "currency and amount_total are required when updating line_items"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "PAYMENT_LINK_NOT_FOUND",
"message": "payment link not found"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Retrieve a payment link
A valid request URL is required to generate request examples{
"id": "<string>",
"object": "payment_link",
"merchant_id": "<string>",
"livemode": true,
"active": true,
"name": "<string>",
"description": "<string>",
"url": "<string>",
"currency": "<string>",
"amount_total": 123,
"line_items": [
{
"price_id": "<string>",
"quantity": 2,
"adjustable_quantity": {
"minimum": 123,
"maximum": 123
}
}
],
"collect_config": {
"email": "required",
"name": "required",
"phone": "required",
"address": "required",
"require_full_billing_address": true,
"require_shipping_address": true,
"require_phone": true,
"wallet_billing_mode": "min"
},
"submit_type": "pay",
"link_type": "one_time",
"theme_id": "<string>",
"success_url": "<string>",
"cancel_url": "<string>",
"inactive_message": "<string>",
"metadata": {},
"created_at": 123,
"updated_at": 123,
"optional_items": [
{
"price_id": "<string>",
"quantity": 2,
"adjustable_quantity": {
"minimum": 123,
"maximum": 123
}
}
],
"custom_fields": [
{
"key": "<string>",
"label": "<string>",
"field_type": "text",
"required": true,
"options": [
"<string>"
]
}
],
"branding": {
"logo_url": "<string>",
"icon_url": "<string>",
"primary_color": "<string>",
"background_color": "<string>",
"font_family": "Inter",
"border_radius": "rounded"
},
"payment_intent_data": {
"capture_method": "automatic",
"setup_future_usage": "on_session",
"description": "<string>",
"reference": "<string>",
"metadata": {}
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "currency and amount_total are required when updating line_items"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "PAYMENT_LINK_NOT_FOUND",
"message": "payment link not found"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.
^mer_[0-9A-Za-z]{14}$Path Parameters
The payment link id (pl_…).
Response
The payment link.
Payment link identifier (pl_…).
payment_link ID of the account that owns the payment link (mer_…).
True for live-mode links; false for test-mode.
False when deactivated; the hosted checkout shows an inactive state.
Display name shown on the hosted checkout.
Description shown on the checkout page.
The public checkout URL (https://buy.ionicfi.com/c/…).
Three-letter ISO currency code.
Total in minor units.
Price references that make up the order.
Show child attributes
Show child attributes
Specifies which contact fields to collect at checkout and how.
Show child attributes
Show child attributes
Label for the checkout submit button.
pay, book, donate The kind of payment the link collects: one_time, subscription, or invoice.
one_time, subscription, invoice Theme id applied to the checkout page.
URL to redirect to after a successful payment.
URL to redirect to if the buyer cancels.
Message shown on the checkout when the link is inactive.
Custom key-value pairs for your use.
Show child attributes
Show child attributes
Unix epoch seconds.
Unix epoch seconds when the link was last updated.
Omitted when the link has no optional add-ons.
Show child attributes
Show child attributes
Omitted when the link has no custom fields.
Show child attributes
Show child attributes
Omitted when no branding overrides are set.
Show child attributes
Show child attributes
Omitted when no payment-intent overrides are set.
Show child attributes
Show child attributes