v1
latestOpenAPI 3.0.32026-08-0623677345.2 KBPayments
Replace payment link
put/payment_links/links/{id}/
Request body
idinteger
namestring required
publishable_keystring
Use this key on the publishable endpoints to fetch and pay the link.
cta'book' | 'donate' | 'pay'
amountnumber nullable
amount_minnumber nullable
amount_maxnumber nullable
amount_presetnumber nullable
amount_scheme'custom' | 'fixed'
currencystring required
ISO currency code.
customer_type'individual' | 'business' | 'both'
descriptionstring nullable
end_descriptionstring nullable
Markdown shown after a successful payment.
hosted_page_titlestring nullable
hosted_page_descriptionstring nullable
hosted_page_layout'vertical' | 'horizontal'
imagestring uri nullable
return_urlstring uri nullable
create_invoiceboolean
When true, completed payments generate an invoice with document.
documentinteger nullable
status'active' | 'archived'
test_modeboolean
createdstring date-time
updatedstring date-time
Response
Updated payment link.
idinteger
namestring required
publishable_keystring
Use this key on the publishable endpoints to fetch and pay the link.
cta'book' | 'donate' | 'pay'
amountnumber nullable
amount_minnumber nullable
amount_maxnumber nullable
amount_presetnumber nullable
amount_scheme'custom' | 'fixed'
currencystring required
ISO currency code.
customer_type'individual' | 'business' | 'both'
descriptionstring nullable
end_descriptionstring nullable
Markdown shown after a successful payment.
hosted_page_titlestring nullable
hosted_page_descriptionstring nullable
hosted_page_layout'vertical' | 'horizontal'
imagestring uri nullable
return_urlstring uri nullable
create_invoiceboolean
When true, completed payments generate an invoice with document.
documentinteger nullable
status'active' | 'archived'
test_modeboolean
createdstring date-time
updatedstring date-time