Update a Payment Link — PATCH /payment-links/{id}

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

is_active

boolean

required

true to enable the link, false to disable it.

Response

Returns the updated payment link object.

string

The payment link ID.

is_active

boolean

The new active state.

curl https://api.blockra.io/payment-links/plink_7h8i9j0k1l2m3n4o \
  -X PATCH \
  -H "X-API-Key: bk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "is_active": false }'

{
  "data": {
    "id": "plink_7h8i9j0k1l2m3n4o",
    "label": "Pro plan",
    "amount": 49.00,
    "currency": "USD",
    "uses": 12,
    "is_active": false,
    "created_at": "2026-07-09T02:40:00.000Z"
  },
  "error": null
}

Create WebhookRegister an endpoint to receive payment events. The signing secret is returned once, here. Requires webhooks:write.

curl https://api.blockra.io/payment-links/plink_7h8i9j0k1l2m3n4o \
  -X PATCH \
  -H "X-API-Key: bk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "is_active": false }'

{
  "data": {
    "id": "plink_7h8i9j0k1l2m3n4o",
    "label": "Pro plan",
    "amount": 49.00,
    "currency": "USD",
    "uses": 12,
    "is_active": false,
    "created_at": "2026-07-09T02:40:00.000Z"
  },
  "error": null
}

​Request

​Path parameters

​Body parameters

​Response

Request

Path parameters

Body parameters

Response