Cancelar una suscripción

Cancelas una suscripción con una sola llamada. Puedes cancelarla al final del periodo actual (el cliente conserva el acceso que ya pagó) o de inmediato.

POST /v1/subscriptions/{id}/cancel

Campo	Tipo	Requerido	Descripción
`at_period_end`	boolean	No	`true` (por defecto) cancela al final del periodo; `false` cancela de inmediato.

Al final del periodo (recomendado)

Con at_period_end: true (u omitido) la suscripción sigue active hasta el fin del periodo actual, con cancel_at_period_end: true. Al cerrar el periodo pasa a canceled y no se generan más cobros.

curl -X POST https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel \
  -H "Authorization: Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{ "at_period_end": true }'

const res = await fetch(
  "https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ at_period_end: true }),
  }
);
const subscription = await res.json();

import requests
 
res = requests.post(
    "https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel",
    headers={
        "Authorization": "Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX",
        "Content-Type": "application/json",
    },
    json={"at_period_end": True},
)
subscription = res.json()

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel"))
    .header("Authorization", "Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{ \"at_period_end\": true }"))
    .build();
 
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using System.Net.Http;
using System.Text;
 
using var http = new HttpClient();
http.DefaultRequestHeaders.Add(
    "Authorization", "Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX");
 
var content = new StringContent(
    "{ \"at_period_end\": true }", Encoding.UTF8, "application/json");
var response = await http.PostAsync(
    "https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

De inmediato

Con at_period_end: false la suscripción pasa a canceled en el acto y se detienen los cobros de una vez.

curl -X POST https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel \
  -H "Authorization: Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{ "at_period_end": false }'

const res = await fetch(
  "https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ at_period_end: false }),
  }
);
const subscription = await res.json();

import requests
 
res = requests.post(
    "https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel",
    headers={
        "Authorization": "Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX",
        "Content-Type": "application/json",
    },
    json={"at_period_end": False},
)
subscription = res.json()

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel"))
    .header("Authorization", "Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("{ \"at_period_end\": false }"))
    .build();
 
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using System.Net.Http;
using System.Text;
 
using var http = new HttpClient();
http.DefaultRequestHeaders.Add(
    "Authorization", "Bearer rk_test_XXXXXXXXXXXXXXXXXXXXXXXX");
 
var content = new StringContent(
    "{ \"at_period_end\": false }", Encoding.UTF8, "application/json");
var response = await http.PostAsync(
    "https://api.rekurra.dev/v1/subscriptions/sub_01HZ.../cancel", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Qué pasa después

El objeto suscripción devuelto refleja el nuevo estado: cancel_at_period_end: true (si cancelaste al final del periodo) o status: "canceled" (si fue inmediata).
Recibes el webhook subscription.canceled cuando la suscripción queda canceled. Configúralo en Webhooks.

Errores posibles

Status	`error.type`	Causa
`404`	`invalid_request`	La suscripción no existe

Consulta el detalle del endpoint en la referencia de la API.

Métodos de pago recurrentes Webhooks