Rotar secreto

POSThttps://api.copayex.com/api/v1/webhooks/subscriptions/:id/rotate-secret

Parámetros de solicitud

Campo	Tipo	Ubicación	Requerido	Descripción
`id`	string	Path	Sí	Suscripción objetivo.
`graceDays`	number (>=1)	Body (JSON)	Sí	Días que ambos secretos conviven.

Durante graceDays recibirás los webhooks firmados con el secreto viejo y el nuevo. Validá ambos hasta que el anterior expire.

Parámetros de respuesta

La rotación devuelve la suscripción actualizada junto con el nuevo secret y el graceDays solicitado.

Campo	Tipo	Descripción
`subscription`	object	La suscripción con sus campos habituales (`id`, `uuid`, `clientId`, `url`, `events`, `active`, `secretVersion`, `createdAt`, `updatedAt`).
`secret`	string	Nuevo secreto firmado (se muestra únicamente en esta respuesta, guardalo enseguida).
`graceDays`	number	Días durante los cuales ambos secretos serán válidos.

Ejemplos de solicitud

curl -X POST "https://api.copayex.com/api/v1/webhooks/subscriptions/:id/rotate-secret" \
  -H "Authorization: Bearer <client_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "graceDays": 5
  }'

const response = await fetch(
  "https://api.copayex.com/api/v1/webhooks/subscriptions/:id/rotate-secret",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer <client_access_token>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      graceDays: 5,
    }),
  }
);
 
const data = await response.json();
console.log(data);

import requests
 
payload = {
    "graceDays": 5,
}
 
headers = {
    "Authorization": "Bearer <client_access_token>",
    "Content-Type": "application/json",
}
 
response = requests.post(
    "https://api.copayex.com/api/v1/webhooks/subscriptions/sub_123/rotate-secret",
    json=payload,
    headers=headers,
    timeout=10,
)
response.raise_for_status()
print(response.json())

Respuesta de ejemplo

{
  "subscription": {
    "clientId": 1,
    "url": "https://webhook.site/webhook",
    "events": [
      "payments.item.completed",
      "payments.item.partial_payment",
      "payments.item.payment_failed",
      "payments.item.payment_canceled"
    ],
    "active": true,
    "secretVersion": "v2",
    "id": 3,
    "uuid": "9cf1f29b-1846-41b3-9ebc-f4de8b7ab061",
    "createdAt": "2025-11-11T01:45:11.416Z",
    "updatedAt": "2025-11-12T12:00:00.000Z"
  },
  "secret": "3f8372bc1e0f4e2ea4b70630aa1c7a8fddb8d16ab936b45ab********",
  "graceDays": 5
}

Actualizar suscripción Eliminar suscripción