Delete payment link

Deletes a payment link and deactivates it, so its payment_url stops accepting payments. Payments already made on the link are kept and still appear in List payments.

Returns {"success": true} when the link is deleted.

A deleted link is still returned by List payment links and Fetch payment link info, with active: false and status: "inactive". It can't take payments again, even if you set active to true.

🚧

This can't be undone

To pause a link you may want to reuse, set active to false with Update payment link instead.

Path Params
string
required
Defaults to MB-LINK-8B9C0D1E2F

Payment link ID

Headers
string

A unique key, such as a UUID, that makes it safe to retry this request. Reuse the same key when you retry. See Idempotency.

Responses

404

Invalid request

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json