Cancelar uma assinatura
curl --request POST \
--url https://api.abacatepay.com/v2/subscriptions/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "subs_abc123xyz"
}
'import requests
url = "https://api.abacatepay.com/v2/subscriptions/cancel"
payload = { "id": "subs_abc123xyz" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: 'subs_abc123xyz'})
};
fetch('https://api.abacatepay.com/v2/subscriptions/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.abacatepay.com/v2/subscriptions/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'subs_abc123xyz'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.abacatepay.com/v2/subscriptions/cancel"
payload := strings.NewReader("{\n \"id\": \"subs_abc123xyz\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.abacatepay.com/v2/subscriptions/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"subs_abc123xyz\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"subs_abc123xyz\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "subs_abc123xyz",
"name": "Plano Premium Mensal",
"description": "Assinatura mensal do plano premium",
"amount": 10000,
"currency": "BRL",
"method": "PIX",
"status": "PENDING",
"customerId": "cust_abc123xyz",
"devMode": false,
"createdAt": "2024-11-04T18:38:28.573Z",
"updatedAt": "2024-11-04T18:38:28.573Z"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}{
"error": "Subscription not found"
}Assinaturas
Cancelar uma assinatura
Cancela imediatamente uma assinatura ativa.
A assinatura passa para o status CANCELLED e nenhuma cobrança futura será gerada. Esta operação é irreversível.
POST
/
subscriptions
/
cancel
Cancelar uma assinatura
curl --request POST \
--url https://api.abacatepay.com/v2/subscriptions/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "subs_abc123xyz"
}
'import requests
url = "https://api.abacatepay.com/v2/subscriptions/cancel"
payload = { "id": "subs_abc123xyz" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: 'subs_abc123xyz'})
};
fetch('https://api.abacatepay.com/v2/subscriptions/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.abacatepay.com/v2/subscriptions/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'subs_abc123xyz'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.abacatepay.com/v2/subscriptions/cancel"
payload := strings.NewReader("{\n \"id\": \"subs_abc123xyz\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.abacatepay.com/v2/subscriptions/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"subs_abc123xyz\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"subs_abc123xyz\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "subs_abc123xyz",
"name": "Plano Premium Mensal",
"description": "Assinatura mensal do plano premium",
"amount": 10000,
"currency": "BRL",
"method": "PIX",
"status": "PENDING",
"customerId": "cust_abc123xyz",
"devMode": false,
"createdAt": "2024-11-04T18:38:28.573Z",
"updatedAt": "2024-11-04T18:38:28.573Z"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}{
"error": "Subscription not found"
}Cancela uma assinatura ativa imediatamente. Parcelas futuras pendentes são canceladas junto.
Exemplo:
Requer a permissão
SUBSCRIPTION:DELETE.Corpo da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID da assinatura (subs_...) |
{
"id": "subs_abc123xyz"
}
Resposta
Retorna o objeto da assinatura comstatus atualizado para CANCELLED.
{
"data": {
"id": "subs_abc123xyz",
"customerId": "cust_abc123xyz",
"amount": 2990,
"status": "CANCELLED",
"method": "CARD",
"coupons": [],
"devMode": false,
"trialDays": null,
"trialEndsAt": null,
"createdAt": "2024-12-06T20:00:00.000Z",
"updatedAt": "2024-12-06T20:00:05.000Z"
},
"success": true,
"error": null
}
O cancelamento é aplicado na hora (
cancelPolicy: NOW). Não há período de carência — o cliente perde o acesso imediatamente.Authorizations
Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.
Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.
Body
application/json
Identificador único da assinatura a ser cancelada
Example:
"subs_abc123xyz"
Was this page helpful?