Update Payment Link

PATCH

/api/:account_id/payment-links/:external_id

PATCH

/api/:account_id/payment-links/:external_id

$ curl -X PATCH https://app.paymentkit.com/api/account_id/payment-links/external_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "id": "pl_dev_x7k9m2n4p8q1",
3   "secure_token": "dGhpcyBpcyBhIHRlc3QgdG9rZW4",
4   "url": "http://localhost:9000/api/pay/share/dGhpcyBpcyBhIHRlc3QgdG9rZW4",
5   "mode": "payment",
6   "success_url": "https://example.com/success",
7   "expires_in_hours": 24,
8   "allow_cart_edit": false,
9   "is_active": true,
10   "is_pinned": false,
11   "created_at": "2024-01-15T09:30:00Z",
12   "updated_at": "2024-01-15T09:30:00Z",
13   "name": "Monthly Subscription Link",
14   "customer_id": "cus_dev_x7k9m2n4",
15   "customer_email": "customer@example.com",
16   "coupon_id": "cpn_dev_x7k9m2n4",
17   "promotion_code": "HALOWEEN20",
18   "discount": {
19     "coupon_id": "cpn_dev_x7k9m2n4",
20     "discount_type": "percent_off",
21     "duration": "forever",
22     "is_expired": false,
23     "coupon_name": "Black Friday",
24     "promotion_code": "HALOWEEN20",
25     "amount_atom_off": 1000,
26     "percent_off": 16.67,
27     "trial_days_off": 14,
28     "currency": "aed",
29     "duration_in_months": 3
30   },
31   "free_trial_days": 14,
32   "return_url": "https://example.com/cancel",
33   "accepted_payment_methods": [
34     "string"
35   ],
36   "content_type": "products",
37   "package_ids": [
38     "pkg_dev_x7k9m2n4"
39   ],
40   "package_names": [
41     "Pro Bundle"
42   ],
43   "packages": [
44     {
45       "id": "pkg_dev_x7k9m2n4",
46       "name": "Pro Bundle",
47       "items": [
48         {
49           "quantity": 1,
50           "product_name": "Pro Plan",
51           "price_name": "$50.00 / month",
52           "unit_amount_atom": 50000,
53           "currency": "usd",
54           "recurring_interval": "month",
55           "recurring_interval_count": 1
56         }
57       ]
58     }
59   ],
60   "line_items": [
61     {
62       "id": "plli_dev_x7k9m2n4p8q1",
63       "price_id": "price_dev_x7k9m2n4",
64       "quantity": 1,
65       "created_at": "2024-01-15T09:30:00Z",
66       "updated_at": "2024-01-15T09:30:00Z",
67       "description": "Premium subscription plan",
68       "product_name": "Pro Plan",
69       "price_name": "$50.00 / month",
70       "unit_amount_atom": 50000,
71       "amount_atom": 50000,
72       "currency": "aed",
73       "billing_scheme": "per_unit",
74       "pricing_type": "recurring",
75       "recurring_interval": "month",
76       "recurring_interval_count": 1,
77       "tier_amount_info": {
78         "mode": "volume",
79         "amount_atoms": [
80           {
81             "unit_amount_atom": 1,
82             "units_upto": 1,
83             "flat_amount_atom": 0
84           }
85         ]
86       }
87     }
88   ],
89   "total_amount_atom": 50000,
90   "currency": "aed",
91   "metadata": {}
92 }

Update a payment link. Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired

account_idstringRequired

Request

This endpoint expects an object.

namestring or nullOptional<=255 characters

Internal name for the payment link

is_activeboolean or nullOptional

Whether the payment link is active

coupon_idstring or nullOptional

ID of coupon to apply to this payment link

free_trial_daysinteger or nullOptional1-730

Free trial period in days (subscription mode only)

success_urlstring or nullOptional

HTTPS URL to redirect to on successful payment

return_urlstring or nullOptional

HTTPS URL to redirect to on cancellation

allow_cart_editboolean or nullOptional

Allow customers to edit cart items during checkout

accepted_payment_methodslist of strings or nullOptional

List of accepted payment method types. Null means all methods accepted.

is_pinnedboolean or nullOptional

Pin this payment link to the top of the list

metadatamap from strings to any or nullOptional

Custom metadata for the payment link

Response

Successful Response

idstring

Unique payment link identifier

secure_tokenstring

Secure token for the public URL

urlstring

Public shareable URL

modestring

Payment mode: ‘payment’, ‘subscription’, or ‘setup’

success_urlstring

URL to redirect to on successful payment

expires_in_hoursinteger

Hours until checkout session expires

allow_cart_editboolean

Whether customers can edit cart items during checkout

is_activeboolean

Whether the payment link is active

is_pinnedboolean

Whether the payment link is pinned to the top of the list

created_atdatetime

When the payment link was created

updated_atdatetime

When the payment link was last updated

namestring or nullOptional

Internal name for the payment link

customer_idstring or nullOptional

Pre-assigned customer Identifier

customer_emailstring or nullOptional

Customer email address for display

coupon_idstring or nullOptional

ID of coupon applied to this payment link

promotion_codestring or nullOptional

Promotion code string associated with the coupon (e.g., ‘HALOWEEN20’)

discountobject or nullOptional

Structured discount details when a coupon is applied. Prefer this over the bare coupon_id/promotion_code for display.

free_trial_daysinteger or nullOptional

Free trial period in days (subscription mode only)

return_urlstring or nullOptional

URL to redirect to on cancellation

accepted_payment_methodslist of strings or nullOptional

List of accepted payment method types. Null means all methods accepted.

content_typestring or nullOptional

Content type: ‘products’, ‘package’, or null (setup mode)

package_idslist of strings or nullOptional

Package Identifiers (for package-based links)

package_nameslist of strings or nullOptional

Package names for display (for package-based links)

packageslist of objects or nullOptional

Inline package details with contained products and prices

line_itemslist of objectsOptional

List of line items in the payment link

total_amount_atominteger or nullOptional

Total amount of all line items in smallest currency unit

currencyenum or nullOptional

Currency of the payment link (from line items)

metadatamap from strings to any or nullOptional

Custom metadata for the payment link

Errors

422

Unprocessable Entity Error