RecurrenceCancel recurrence

Cancel recurrence

POST/v1/recurrency/:id/cancelhttps://api.securitypag.com

Authentication: Bearer · API key

Use the v1/recurrency/:id/cancel route to end a recurrence. No new charge is generated and the charge that was scheduled ends with it, without a notice of its own. Only an ACTIVE recurrence can be cancelled.

Path parameters

idstringrequired
Id of the recurrence to cancel.

This route takes no request body.

Responses

200Recurrence cancelled. No future charges are generated.

403The store is not allowed to use recurrence for this charge method.

409The recurrence is not active. Only an ACTIVE recurrence can be cancelled.

messagestring
Error description message.

404Recurrence not found in this store.

Something wrong on this page? Talk to us

Request

curl --request POST \
  --url https://api.securitypag.com/v1/recurrency/recr_01HXYZ123ABC456DEF789/cancel \
  --header 'Authorization: Bearer SUA_CHAVE_DE_API' \
  --header 'Content-Type: application/json'

const response = await fetch("https://api.securitypag.com/v1/recurrency/recr_01HXYZ123ABC456DEF789/cancel", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.SUA_CHAVE_DE_API,
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

<?php
$ch = curl_init("https://api.securitypag.com/v1/recurrency/recr_01HXYZ123ABC456DEF789/cancel");
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer " . getenv("SUA_CHAVE_DE_API"),
    "Content-Type: application/json",
  ],
]);

$data = json_decode(curl_exec($ch), true);
print_r($data);

import os
import requests

response = requests.request(
    "POST",
    "https://api.securitypag.com/v1/recurrency/recr_01HXYZ123ABC456DEF789/cancel",
    headers={
        "Authorization": "Bearer " + os.environ["SUA_CHAVE_DE_API"],
        "Content-Type": "application/json",
    },
)

print(response.json())

Response

{
  "id": "recr_01HXYZ123ABC456DEF789",
  "amount": 9900,
  "currency": "BRL",
  "method": "PIXAUTOMATIC",
  "status": "CANCELLED",
  "description": "Assinatura mensal",
  "options": {
    "frequency": "MONTHLY",
    "freqInterval": 1,
    "maxPeriods": null
  },
  "customer": {
    "name": "John Doe",
    "taxId": "12345678900",
    "email": "john.doe@example.com",
    "phone": "11999990000"
  },
  "pix": {
    "emv": "00020101021226850014br.gov.bcb.pix2563api.gateway.test/pix/123e4567-e89b-12d3-a456-4266141740005204000053039865802BR6304ABCD",
    "retryPolicy": "THREE_RETRIES_7_DAYS"
  },
  "card": null,
  "invoice": null,
  "orderId": null,
  "cancelledAt": "2026-04-07T18:45:10.532Z",
  "externalRef": "order_123456",
  "notificationUrl": "https://example.com/webhook/recurrency",
  "metadata": null,
  "createdAt": "2026-01-05T10:12:33.120Z",
  "updatedAt": "2026-04-07T18:45:10.532Z"
}

{
  "message": "The user does not have permission for this operation."
}

{
  "message": "Invalid status update."
}

{
  "message": "Not found."
}