Skip to main content
Enables or disables a payment link. A disabled link stops accepting new payments. Requires the payment_links:write scope.

Request

PATCH https://api.blockra.io/payment-links/{id}

Path parameters

string
required
The payment link ID (prefixed plink_).

Body parameters

boolean
required
true to enable the link, false to disable it.

Response

Returns the updated payment link object.
string
The payment link ID.
boolean
The new active state.