PATCH /v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
Content-Type: application/json
{
"confirmationToken": "abc123xyz"
}
curl -X PATCH "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm" \
-u "$FINVIA_API_KEY:" \
-H "Content-Type: application/json" \
-d '{"confirmationToken": "abc123xyz"}'
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');
const response = await fetch(
'https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm',
{
method: 'PATCH',
headers: {
Authorization: `Basic ${credentials}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ confirmationToken: 'abc123xyz' }),
},
);
if (response.status === 400) {
// token expirado: peça a desativação de novo
}
import os
import requests
payload = {
"confirmationToken": "abc123xyz",
}
response = requests.request(
"PATCH",
"https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm",
auth=(os.environ["FINVIA_API_KEY"], ""),
json=payload,
timeout=30,
)
print(response.status_code)
if response.content:
print(response.json())
<?php
$payload = [
'confirmationToken' => 'abc123xyz',
];
$ch = curl_init('https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, PHP_EOL;
print_r(json_decode($body, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
public class Exemplo {
public static void main(String[] args) throws Exception {
String credentials = Base64.getEncoder()
.encodeToString((System.getenv("FINVIA_API_KEY") + ":").getBytes());
String payload = """
{
"confirmationToken": "abc123xyz"
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm"))
.header("Authorization", "Basic " + credentials)
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString(payload))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http.Headers;
using System.Text;
var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");
var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);
var payload = """
{
"confirmationToken": "abc123xyz"
}
""";
var request = new HttpRequestMessage(HttpMethod.Patch, "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
payload := strings.NewReader(`{
"confirmationToken": "abc123xyz"
}`)
req, err := http.NewRequest("PATCH", "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm", payload)
if err != nil {
panic(err)
}
req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode)
fmt.Println(string(body))
}
require "json"
require "net/http"
require "uri"
uri = URI("https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm")
request = Net::HTTP::Patch.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
"confirmationToken" => "abc123xyz",
})
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.code
puts response.body
(sem corpo)
{
"statusCode": 400,
"message": "Invalid or expired confirmation token"
}
Planos de assinatura
Confirmar desativação do plano
Segunda etapa da desativação: envia o token de confirmação e efetiva a desativação do plano.
PATCH
/
v1
/
subscription-plans
/
{id}
/
status
/
confirm
PATCH /v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
Content-Type: application/json
{
"confirmationToken": "abc123xyz"
}
curl -X PATCH "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm" \
-u "$FINVIA_API_KEY:" \
-H "Content-Type: application/json" \
-d '{"confirmationToken": "abc123xyz"}'
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');
const response = await fetch(
'https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm',
{
method: 'PATCH',
headers: {
Authorization: `Basic ${credentials}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ confirmationToken: 'abc123xyz' }),
},
);
if (response.status === 400) {
// token expirado: peça a desativação de novo
}
import os
import requests
payload = {
"confirmationToken": "abc123xyz",
}
response = requests.request(
"PATCH",
"https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm",
auth=(os.environ["FINVIA_API_KEY"], ""),
json=payload,
timeout=30,
)
print(response.status_code)
if response.content:
print(response.json())
<?php
$payload = [
'confirmationToken' => 'abc123xyz',
];
$ch = curl_init('https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, PHP_EOL;
print_r(json_decode($body, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
public class Exemplo {
public static void main(String[] args) throws Exception {
String credentials = Base64.getEncoder()
.encodeToString((System.getenv("FINVIA_API_KEY") + ":").getBytes());
String payload = """
{
"confirmationToken": "abc123xyz"
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm"))
.header("Authorization", "Basic " + credentials)
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString(payload))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http.Headers;
using System.Text;
var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");
var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);
var payload = """
{
"confirmationToken": "abc123xyz"
}
""";
var request = new HttpRequestMessage(HttpMethod.Patch, "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
payload := strings.NewReader(`{
"confirmationToken": "abc123xyz"
}`)
req, err := http.NewRequest("PATCH", "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm", payload)
if err != nil {
panic(err)
}
req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode)
fmt.Println(string(body))
}
require "json"
require "net/http"
require "uri"
uri = URI("https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm")
request = Net::HTTP::Patch.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
"confirmationToken" => "abc123xyz",
})
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.code
puts response.body
(sem corpo)
{
"statusCode": 400,
"message": "Invalid or expired confirmation token"
}
Esta rota conclui a desativação de um plano. Ela recebe o
confirmationToken devolvido por Alterar status do plano e, se o token for válido, o plano passa a inactive e deixa de aceitar novas assinaturas. A confirmação vale para qualquer desativação, tenha o plano assinaturas ativas ou não. As duas etapas existem para evitar que um plano seja tirado de venda por engano.
Quando usar
| Situação | Como usar esta rota |
|---|---|
Logo depois de pedir status inactive | Envie o confirmationToken recebido |
| Tela de administração com botão “Desativar plano” | Mostre o activeSubscriptionsCount do plano (Consultar plano), peça a desativação e chame esta rota quando o usuário confirmar |
| Reativar um plano | Não é necessário. A ativação é imediata em Alterar status do plano |
Antes de chamar
- Tenha uma chave secreta gerada por usuário com a permissão atualizar assinaturas. Nos perfis padrão, são Owner, Manager e Operador. Os perfis Visualizador, Desenvolvedor e Financeiro recebem
403(veja Permissões por perfil). - Tenha o
confirmationTokendevolvido porPATCH /v1/subscription-plans/{id}/statuspara o mesmo plano.
Assinaturas não têm modo de teste: as cobranças são reais mesmo com a chave de teste. Veja como homologar em Assinaturas: visão geral.
O token de confirmação vale por 5 minutos e é de uso único. Pedir a desativação de novo gera outro token e invalida o anterior. Com token vencido, já usado ou substituído, a chamada falha com
400 e é preciso pedir a desativação de novo.Parâmetros de caminho
Corpo da requisição
Respostas
A resposta de sucesso não tem corpo. Para conferir o novo status, consulte o plano em Consultar plano.| HTTP | Significado | Corpo |
|---|---|---|
204 | Desativação confirmada | Sem corpo |
400 | Token inválido ou expirado | {"statusCode": 400, "message": "Invalid or expired confirmation token"} |
401 | Credencial inválida | {"statusCode": 401, "message": "Unauthorized"} |
403 | O usuário que gerou a chave não tem a permissão atualizar assinaturas | {"message": "Acesso negado", "error": "Forbidden", "statusCode": 403} |
404 | Plano inexistente ou de outra conta | {"statusCode": 404, "message": "Subscription plan not found"} |
Para o negócio: depois da confirmação, o plano some das opções de venda, mas as assinaturas existentes continuam ativas e renovando a cada ciclo. Desativar um plano não gera estorno nem cancelamento para ninguém. Para encerrar as assinaturas, é preciso cancelar uma a uma.
Erros comuns
| Sintoma | Causa | Como resolver |
|---|---|---|
400 “Invalid or expired confirmation token” | Token com mais de 5 minutos, já usado, substituído por um pedido mais recente, digitado errado ou de outro plano | Peça a desativação de novo em Alterar status do plano e confirme em seguida |
404 “Subscription plan not found” | id do plano errado ou de outra conta | Confira o id na listagem de planos |
401 | Chave ausente, inválida ou header montado errado | Monte o header com o Base64 de sua_chave: |
403 com Acesso negado | O usuário que gerou a chave não tem a permissão atualizar assinaturas (ex.: Visualizador, Desenvolvedor ou Financeiro) | Gere a chave com um usuário Owner ou Manager. Veja Permissões por perfil |
| Resposta vazia interpretada como erro | Sucesso devolve 204 sem corpo | Trate 204 como sucesso e não tente ler JSON da resposta |
PATCH /v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
Content-Type: application/json
{
"confirmationToken": "abc123xyz"
}
curl -X PATCH "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm" \
-u "$FINVIA_API_KEY:" \
-H "Content-Type: application/json" \
-d '{"confirmationToken": "abc123xyz"}'
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');
const response = await fetch(
'https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm',
{
method: 'PATCH',
headers: {
Authorization: `Basic ${credentials}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ confirmationToken: 'abc123xyz' }),
},
);
if (response.status === 400) {
// token expirado: peça a desativação de novo
}
import os
import requests
payload = {
"confirmationToken": "abc123xyz",
}
response = requests.request(
"PATCH",
"https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm",
auth=(os.environ["FINVIA_API_KEY"], ""),
json=payload,
timeout=30,
)
print(response.status_code)
if response.content:
print(response.json())
<?php
$payload = [
'confirmationToken' => 'abc123xyz',
];
$ch = curl_init('https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, PHP_EOL;
print_r(json_decode($body, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
public class Exemplo {
public static void main(String[] args) throws Exception {
String credentials = Base64.getEncoder()
.encodeToString((System.getenv("FINVIA_API_KEY") + ":").getBytes());
String payload = """
{
"confirmationToken": "abc123xyz"
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm"))
.header("Authorization", "Basic " + credentials)
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString(payload))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http.Headers;
using System.Text;
var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");
var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);
var payload = """
{
"confirmationToken": "abc123xyz"
}
""";
var request = new HttpRequestMessage(HttpMethod.Patch, "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
payload := strings.NewReader(`{
"confirmationToken": "abc123xyz"
}`)
req, err := http.NewRequest("PATCH", "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm", payload)
if err != nil {
panic(err)
}
req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode)
fmt.Println(string(body))
}
require "json"
require "net/http"
require "uri"
uri = URI("https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q/status/confirm")
request = Net::HTTP::Patch.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
"confirmationToken" => "abc123xyz",
})
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.code
puts response.body
(sem corpo)
{
"statusCode": 400,
"message": "Invalid or expired confirmation token"
}
Veja também
Planos
Recorrência, trial e status do plano.
Visão geral de assinaturas
Fluxo completo, do cliente à cobrança recorrente.
Ciclo de vida
Status, renovação, retentativas e cancelamento.
Webhooks de assinatura
Eventos enviados a cada etapa da assinatura.
Registrar cartão
Guarde o cartão no cofre antes de criar a assinatura.
Alterar status do plano
Primeira etapa: peça a desativação e receba o token.

