Skip to main content
PATCH
Update a payment link

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Path Parameters

id
string<uuid>
required

Payment link UUID.

Body

application/json

Partial update. Every field is optional; only fields present are changed.

name
string
Maximum string length: 120
description
string
Maximum string length: 1000
imageUrl
string<uri>
Maximum string length: 2048
amount
number
Required range: 0.01 <= x <= 1000000
type
enum<string>

Checked against the resulting merged state.

Available options:
one_time,
subscription
billingInterval
enum<string>
Available options:
month,
year

Response

The updated payment link.

id
string<uuid>
required

Payment link UUID.

org_id
string<uuid>
required
user_id
string<uuid>
required

Public ID used in the checkout URL.

amount
number
required

Currency units.

currency
string
required

Settlement currency or token.

description
string | null
required
metadata
object
required

Your custom data.

checkout_fields
object[]
required
webhook_url
string | null
required
success_url
string | null
required
cancel_url
string | null
required
tax_rate_id
string<uuid> | null
required
status
enum<string>
required
Available options:
active,
cancelled
payment_count
integer
required

Successful payments against this link so far.

supported_networks
string[]
required
expires_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string | null
required
image_url
string | null
required
max_uses
integer | null
required

null means unlimited.

seller_mode
enum<string>
required

mor (card + bank) or crypto (on-chain). The snake_case column equivalent of the computed sellerMode.

Available options:
mor,
crypto
type
enum<string>
required
Available options:
one_time,
subscription
billing_interval
enum<string> | null
required
Available options:
month,
year,
null
environment
enum<string>
required
Available options:
test,
live
checkoutUrl
string
required

Full URL to share with buyers. Computed, camelCase, no snake_case equivalent.

sellerMode
enum<string>
required
Available options:
mor,
crypto