Skip to main content
PATCH
Update a payment link

Authorizations

Authorization
string
header
required

Bearer Authentication

Headers

X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Path Parameters

id
string<nanoid>
required
Example:

"bus_123456789"

Body

application/json
quote_amount
string | null

nullable decimal value

Example:

"100"

quote_currency
string<string> | null
Required string length: 1 - 10
Example:

"BTC"

target_amount
string | null

nullable decimal value

Example:

"100"

target_currency
string<string>

A valid currency

Required string length: 1 - 10
Example:

"BTC"

name
string
title
string
description
string
status
enum<string>
Available options:
pending,
active
require_extra_info
object[]
images
string<url>[]
allow_customer_amount
boolean
amount_limit
object
allow_quantity_selection
boolean
customer_email
string<email>

Can update customer email for existing invoices

customer_name
string

Can update customer name for existing invoices

due_date
string<date-time>

Can update due date for existing invoices (must be in the future)

note
string

Can update note for existing invoices (max 250 characters)

Maximum string length: 250
items
object[]

Update line items for existing invoices

Response

Successful response

General response Values

status
enum<string>
required
Available options:
success,
error
Example:

"success"

message
string
required
Example:

"message for success"

data
object
required