Payment Links

Update a payment link

Partial update: only send the fields you want to change.

patch/gateway/payment-links/{id}

Request

  • Base URL: https://api.agentaos.ai/api/v1
  • URL: https://api.agentaos.ai/api/v1/gateway/payment-links/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring uuid required

Payment link UUID.

Request body

namestring
descriptionstring
imageUrlstring uri
amountnumber
type'one_time' | 'subscription'

Checked against the resulting merged state.

billingInterval'month' | 'year'
trialPeriodDaysinteger

Free-trial length in days; subscription links only.

Response

The updated payment link.

idstring uuid required

Payment link UUID.

org_idstring uuid required
user_idstring uuid required
secure_link_idstring required

Public ID used in the checkout URL.

amountnumber required

Currency units.

currencystring required

Settlement currency or token.

descriptionstring nullable required
metadataobject required

Your custom data.

webhook_urlstring nullable required
success_urlstring nullable required
cancel_urlstring nullable required
tax_rate_idstring uuid nullable required
status'active' | 'cancelled' required
payment_countinteger required

Successful payments against this link so far.

supported_networksstring[] required
expires_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required
namestring nullable required
image_urlstring nullable required
max_usesinteger nullable required

null means unlimited.

seller_mode'mor' | 'crypto' required

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

type'one_time' | 'subscription' required
billing_interval'month' | 'year' | 'null' nullable required
environment'test' | 'live' required
checkoutUrlstring required

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

sellerMode'mor' | 'crypto' required

Changes

No recorded changes to this operation across all 1 revision of this API.