Disabling the payment link

The method allows you to disable the payment link. You will no longer be able to connect subscriptions and make payments using this payment link

Disabling the payment link

post

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

Request body to disable the payment link

idstringRequired

Payment link ID

Example: 9b0838e7-54ca-4da7-9634-d497a47f9381

merchantIdstringRequired

Merchant ID

Example: 86f1f78d-77c6-4bb1-b67c-8389218ce646

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /api-gateway/recurrents/disable-subscriber-billing-link HTTP/1.1
Host: app.apollopayment.io
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "id": "9b0838e7-54ca-4da7-9634-d497a47f9381",
  "merchantId": "86f1f78d-77c6-4bb1-b67c-8389218ce646"
}

200Success

{
  "success": true,
  "response": {
    "id": "9b0838e7-54ca-4da7-9634-d497a47f9381",
    "merchantId": "86f1f78d-77c6-4bb1-b67c-8389218ce646",
    "currency": "USDT",
    "network": "ethereum",
    "status": "BLOCKED",
    "createdAt": "2025-06-09T13:18:29.433Z",
    "updatedAt": "2025-06-09T13:18:29.433Z"
  }
}