Alterar plano da assinatura
curl --request POST \
--url https://api.abacatepay.com/v2/subscriptions/change-plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "subs_abc123xyz",
"productId": "prod_plano_pro",
"quantity": 1,
"items": [
{
"productId": "prod_abc123xyz",
"quantity": 1
}
]
}
'import requests
url = "https://api.abacatepay.com/v2/subscriptions/change-plan"
payload = {
"id": "subs_abc123xyz",
"productId": "prod_plano_pro",
"quantity": 1,
"items": [
{
"productId": "prod_abc123xyz",
"quantity": 1
}
]
}
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',
productId: 'prod_plano_pro',
quantity: 1,
items: [{productId: 'prod_abc123xyz', quantity: 1}]
})
};
fetch('https://api.abacatepay.com/v2/subscriptions/change-plan', 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/change-plan",
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',
'productId' => 'prod_plano_pro',
'quantity' => 1,
'items' => [
[
'productId' => 'prod_abc123xyz',
'quantity' => 1
]
]
]),
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/change-plan"
payload := strings.NewReader("{\n \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_plano_pro\",\n \"quantity\": 1,\n \"items\": [\n {\n \"productId\": \"prod_abc123xyz\",\n \"quantity\": 1\n }\n ]\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/change-plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_plano_pro\",\n \"quantity\": 1,\n \"items\": [\n {\n \"productId\": \"prod_abc123xyz\",\n \"quantity\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/change-plan")
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 \"productId\": \"prod_plano_pro\",\n \"quantity\": 1,\n \"items\": [\n {\n \"productId\": \"prod_abc123xyz\",\n \"quantity\": 1\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "subu_abc123xyz",
"subscriptionId": "subs_abc123xyz",
"status": "PENDING",
"productId": "prod_plano_pro",
"quantity": 1,
"newAmount": 4990,
"requestedAt": "2024-12-06T20:05:00.000Z"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}{
"error": "Subscription not found or not active"
}{
"error": "Product must have a billing cycle"
}Assinaturas
Alterar plano da assinatura
Altera o produto principal de uma assinatura ativa.
A mudança é agendada como PENDING e aplicada automaticamente no início do próximo ciclo de cobrança. Só pode existir uma alteração pendente por assinatura — uma nova chamada substitui a anterior ainda não aplicada.
O produto informado em productId deve ter um ciclo de cobrança definido, igual ao da assinatura. Produtos avulsos (sem ciclo) retornam erro.
POST
/
subscriptions
/
change-plan
Alterar plano da assinatura
curl --request POST \
--url https://api.abacatepay.com/v2/subscriptions/change-plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "subs_abc123xyz",
"productId": "prod_plano_pro",
"quantity": 1,
"items": [
{
"productId": "prod_abc123xyz",
"quantity": 1
}
]
}
'import requests
url = "https://api.abacatepay.com/v2/subscriptions/change-plan"
payload = {
"id": "subs_abc123xyz",
"productId": "prod_plano_pro",
"quantity": 1,
"items": [
{
"productId": "prod_abc123xyz",
"quantity": 1
}
]
}
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',
productId: 'prod_plano_pro',
quantity: 1,
items: [{productId: 'prod_abc123xyz', quantity: 1}]
})
};
fetch('https://api.abacatepay.com/v2/subscriptions/change-plan', 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/change-plan",
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',
'productId' => 'prod_plano_pro',
'quantity' => 1,
'items' => [
[
'productId' => 'prod_abc123xyz',
'quantity' => 1
]
]
]),
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/change-plan"
payload := strings.NewReader("{\n \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_plano_pro\",\n \"quantity\": 1,\n \"items\": [\n {\n \"productId\": \"prod_abc123xyz\",\n \"quantity\": 1\n }\n ]\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/change-plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_plano_pro\",\n \"quantity\": 1,\n \"items\": [\n {\n \"productId\": \"prod_abc123xyz\",\n \"quantity\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/change-plan")
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 \"productId\": \"prod_plano_pro\",\n \"quantity\": 1,\n \"items\": [\n {\n \"productId\": \"prod_abc123xyz\",\n \"quantity\": 1\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "subu_abc123xyz",
"subscriptionId": "subs_abc123xyz",
"status": "PENDING",
"productId": "prod_plano_pro",
"quantity": 1,
"newAmount": 4990,
"requestedAt": "2024-12-06T20:05:00.000Z"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}{
"error": "Subscription not found or not active"
}{
"error": "Product must have a billing cycle"
}Altera o produto principal de uma assinatura ativa. O novo valor começa a ser cobrado no próximo ciclo de cobrança — o ciclo atual não é afetado.
Exemplo — upgrade de plano:
Requer a permissão
SUBSCRIPTION:CREATE.Corpo da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID da assinatura (subs_...) |
productId | string | Sim | ID do novo produto (prod_...) — deve ter ciclo definido |
quantity | integer | Sim | Quantidade do produto (mínimo 1) |
O produto informado em
productId precisa ter um cycle configurado, igual ao da assinatura. Produtos avulsos (sem ciclo) retornam erro.{
"id": "subs_abc123xyz",
"productId": "prod_plano_pro",
"quantity": 1
}
Resposta
Retorna um objeto de atualização pendente (status: "PENDING"). A mudança é aplicada automaticamente no início do próximo ciclo.
{
"data": {
"id": "subu_abc123xyz",
"subscriptionId": "subs_abc123xyz",
"status": "PENDING",
"productId": "prod_plano_pro",
"quantity": 1,
"newAmount": 4990,
"requestedAt": "2024-12-06T20:05:00.000Z"
},
"success": true,
"error": null
}
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID da atualização pendente (subu_...) |
subscriptionId | string | ID da assinatura |
status | string | PENDING até o próximo ciclo; APPLIED após aplicado |
productId | string | ID do novo produto |
quantity | integer | Quantidade do produto |
newAmount | integer | Novo valor em centavos (preço × quantidade) |
requestedAt | string | Data/hora da solicitação |
Um evento
subscription.plan_changed é disparado imediatamente após a solicitação, com os detalhes do novo plano e o ID da atualização pendente.Só pode existir uma atualização
PENDING por assinatura. Chamar o endpoint novamente sobrescreve a alteração anterior ainda não aplicada.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 alterada.
Example:
"subs_abc123xyz"
Identificador do novo produto. Deve ter ciclo de cobrança definido.
Example:
"prod_plano_pro"
Quantidade do novo produto.
Required range:
x >= 1Example:
1
Lista de produtos do novo plano. Alternativa a productId/quantity quando a assinatura passa a ter mais de um produto.
Minimum array length:
1Show child attributes
Show child attributes
Was this page helpful?