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

/api-gateway/recurrents/disable-subscriber-billing-link

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

idstringrequired

Payment link ID

Example: 42a8b646-c7e3-49fc-b536-ae4c25bdea79

merchantIdstringrequired

Merchant ID

Example: deefcd05-aa9d-4e9c-99ef-05afd371ce8f

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/api-gateway/recurrents/disable-subscriber-billing-link' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "42a8b646-c7e3-49fc-b536-ae4c25bdea79",
    "merchantId": "deefcd05-aa9d-4e9c-99ef-05afd371ce8f"
  }'

200

200

{
  "success": true,
  "response": {
    "id": "42a8b646-c7e3-49fc-b536-ae4c25bdea79",
    "merchantId": "deefcd05-aa9d-4e9c-99ef-05afd371ce8f",
    "currency": "USDT",
    "network": "ethereum",
    "createdAt": "2024-12-26T08:21:53.366Z",
    "updatedAt": "2024-12-26T08:21:53.366Z",
    "status": "BLOCKED"
  }
}