Revoke subscription

---

POST /api/v1/integrator/subscription/revoke

This POST method allows the integrator to revoke an active subscription in Keepz. Once revoked, the subscription will no longer trigger automatic payment cycles.

Request details

When sending request to Keepz, these four parameters must always be included in the query parameters:

identifier

• Unique ID of the integrator in the Keepz system.
• Provided by Keepz during the integration process.

encryptedData

• Contains the actual request payload encrypted using a randomly generated symmetric key and IV (Initialization Vector).

encryptedKeys

• Contains the AES key and IV used to encrypt encryptedData.

aes

• Boolean flag indicating that the request uses AES-based symmetric encryption (needed for backward compatibility with older encryption methods).

For details on the encryption process, see the Encryption Guide documentation.

Parameters

The following parameters form the actual revoke subscription payload. They must be included inside the encryptedData parameter, which is encrypted and passed in the request as shown above.

Parameter	Type	Required	Description	Possible values
subscriptionId	string (UUID v4)	✅	Unique ID of the subscription in the Keepz system. Provided when subscription was created.

Response details

✅ Success Response

If the request is valid, the API returns HTTP status code 200 OK.

❌ Error Response

If an error occurs, the response is returned without encryption (plain JSON):

{
  "message": "Integrator order not found",
  "statusCode": 6005,
  "exceptionGroup": 5
}

Parameter	Type	Description
message	string	Error message. Details are provided in the dedicated section below.
statusCode	number	Error status code. Details are provided in the dedicated section below.
exceptionGroup	number	Error group. Details are provided in the dedicated section below.