Cancelar Assinatura
curl --request POST \
--url https://garu.com.br/api/subscriptions/{id}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelImmediately": true,
"reason": "<string>"
}
'import requests
url = "https://garu.com.br/api/subscriptions/{id}/cancel"
payload = {
"cancelImmediately": True,
"reason": "<string>"
}
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({cancelImmediately: true, reason: '<string>'})
};
fetch('https://garu.com.br/api/subscriptions/{id}/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://garu.com.br/api/subscriptions/{id}/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([
'cancelImmediately' => true,
'reason' => '<string>'
]),
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://garu.com.br/api/subscriptions/{id}/cancel"
payload := strings.NewReader("{\n \"cancelImmediately\": true,\n \"reason\": \"<string>\"\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://garu.com.br/api/subscriptions/{id}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cancelImmediately\": true,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://garu.com.br/api/subscriptions/{id}/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 \"cancelImmediately\": true,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAssinaturas
Cancelar Assinatura
Cancele uma assinatura imediatamente ou ao fim do período
POST
/
api
/
subscriptions
/
{id}
/
cancel
Cancelar Assinatura
curl --request POST \
--url https://garu.com.br/api/subscriptions/{id}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelImmediately": true,
"reason": "<string>"
}
'import requests
url = "https://garu.com.br/api/subscriptions/{id}/cancel"
payload = {
"cancelImmediately": True,
"reason": "<string>"
}
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({cancelImmediately: true, reason: '<string>'})
};
fetch('https://garu.com.br/api/subscriptions/{id}/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://garu.com.br/api/subscriptions/{id}/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([
'cancelImmediately' => true,
'reason' => '<string>'
]),
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://garu.com.br/api/subscriptions/{id}/cancel"
payload := strings.NewReader("{\n \"cancelImmediately\": true,\n \"reason\": \"<string>\"\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://garu.com.br/api/subscriptions/{id}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cancelImmediately\": true,\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://garu.com.br/api/subscriptions/{id}/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 \"cancelImmediately\": true,\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyVisão Geral
Cancele uma assinatura de duas formas: imediatamente (cliente perde acesso na hora) ou agendado para o fim do período pago (cliente mantém acesso até a data de renovação).Cancelamento Imediato
O cliente perde acesso imediatamente e nenhuma cobrança futura será realizada.curl -X POST https://garu.com.br/api/subscriptions/100/cancel \
-H "Authorization: Bearer sk_test_sua_chave" \
-H "Content-Type: application/json" \
-d '{
"cancelImmediately": true,
"reason": "Cliente solicitou cancelamento"
}'
const response = await fetch(
'https://garu.com.br/api/subscriptions/100/cancel',
{
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.GARU_API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
cancelImmediately: true,
reason: 'Cliente solicitou cancelamento'
})
}
);
const result = await response.json();
console.log(`Status: ${result.status}`); // "canceled"
import requests
import os
url = "https://garu.com.br/api/subscriptions/100/cancel"
headers = {
"Authorization": f"Bearer {os.environ['GARU_API_KEY']}",
"Content-Type": "application/json"
}
payload = {
"cancelImmediately": True,
"reason": "Cliente solicitou cancelamento"
}
response = requests.post(url, json=payload, headers=headers)
result = response.json()
print(f"Status: {result['status']}") # "canceled"
- Status muda para
canceled - Acesso revogado imediatamente
- Nenhuma cobrança futura
Cancelamento Agendado
O cliente mantém acesso até o fim do período pago atual.curl -X POST https://garu.com.br/api/subscriptions/100/cancel \
-H "Authorization: Bearer sk_test_sua_chave" \
-H "Content-Type: application/json" \
-d '{
"cancelImmediately": false,
"reason": "Cliente optou por não renovar"
}'
const response = await fetch(
'https://garu.com.br/api/subscriptions/100/cancel',
{
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.GARU_API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
cancelImmediately: false,
reason: 'Cliente optou por não renovar'
})
}
);
const result = await response.json();
console.log(`Cancelamento agendado para: ${result.cancelAt}`);
import requests
import os
url = "https://garu.com.br/api/subscriptions/100/cancel"
headers = {
"Authorization": f"Bearer {os.environ['GARU_API_KEY']}",
"Content-Type": "application/json"
}
payload = {
"cancelImmediately": False,
"reason": "Cliente optou por não renovar"
}
response = requests.post(url, json=payload, headers=headers)
result = response.json()
print(f"Cancelamento agendado para: {result['cancelAt']}")
- Status muda para
pending_cancellation - Cliente mantém acesso até
currentPeriodEnd - Campo
cancelAtpreenchido com a data de cancelamento - No fim do período, status muda para
canceled
Parâmetros
boolean
required
true = cancelamento imediato, false = cancelamento no fim do período.string
Motivo do cancelamento (opcional, para registro interno).
Resposta de Sucesso
Cancelamento Imediato (200 OK)
{
"id": 100,
"status": "canceled",
"cancelledAt": "2024-02-20T10:00:00.000Z",
"message": "Assinatura cancelada com sucesso"
}
Cancelamento Agendado (200 OK)
{
"id": 100,
"status": "pending_cancellation",
"cancelAt": "2024-03-15T00:00:00.000Z",
"message": "Assinatura será cancelada em 2024-03-15"
}
Erros Comuns
404 - Assinatura não encontrada
404 - Assinatura não encontrada
{
"statusCode": 404,
"message": "Subscription not found"
}
400 - Assinatura já cancelada
400 - Assinatura já cancelada
{
"statusCode": 400,
"message": "Subscription is already canceled"
}
Próximos Passos
Pausar Assinatura
Pause temporariamente as cobranças
Webhooks
Receba notificações de cancelamento
Was this page helpful?