Error
A valid request URL is required to generate request examples{
"data": [
{
"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": {}
}
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"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": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Payment link endpoints
List payment links
GET
/
payment_links
Error
A valid request URL is required to generate request examples{
"data": [
{
"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": {}
}
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"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": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Query Parameters
Filter by active state. Accepts true or false; omit to return all.
Filter by name (case-insensitive substring match).
Page size (default 20, max 99).
Required range:
1 <= x <= 99Cursor: a payment link id (typically the previous response's next_cursor). Returns results strictly after it, newest first.

