> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fastpaybrasil.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar uma assinatura

> Atualiza o metadata de uma assinatura ativa. É o único campo que pode ser alterado.

Esta rota atualiza as informações livres (`metadata`) de uma assinatura ativa, como o ID do usuário no seu sistema, a campanha de origem ou uma observação do atendimento. Cartão, plano, valor e pausa **não** podem ser alterados aqui nem em nenhuma outra rota.

## Quando usar

| Situação | Como usar esta rota |
| - | - |
| Vincular a assinatura ao ID do usuário no seu sistema | `metadata` com o seu identificador |
| Marcar um cliente (VIP, parceria, campanha) | `metadata` com a marcação |
| Trocar o cartão da assinatura | Não existe troca. Cancele e crie outra assinatura com o novo cartão |
| Trocar de plano (upgrade ou downgrade) | Não existe troca. Cancele e crie outra assinatura no novo plano |
| Pausar a cobrança | Não existe pausa |

## 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](https://docs.fastpaybrasil.com/guias/assinaturas/visao-geral.md#permissões-por-perfil)).
* A assinatura precisa estar com status `active`. Nos demais status a resposta é `400`. Esta rota não serve para destravar uma assinatura `pending_activation`.

> [!WARNING]
>
> 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](https://docs.fastpaybrasil.com/guias/assinaturas/visao-geral.md).

> [!WARNING]
>
> Não existe troca de cartão, troca de plano, alteração de valor nem pausa. Para trocar o cartão ou o plano, **cancele a assinatura e crie outra**. A nova assinatura começa um ciclo novo, com cobrança imediata. Leve isso em conta: o cliente pode pagar o novo ciclo antes do fim do período já pago da assinatura anterior.

## Parâmetros de caminho

**id** `string` *required*

Identificador único da assinatura. Ex.: `2RhQg9M7ZCg3X3nMb9W1kX8Q`.

## Corpo da requisição

Apenas `metadata` pode ser atualizado.

**metadata** `object`

Informações suas, em formato livre, guardadas na assinatura. Ex.: `{"notes": "Cliente VIP"}`.

## Respostas

**success** `boolean`

Indica se a atualização foi feita. Ex.: `true`.

**id** `string`

ID da assinatura. Ex.: `2RhQg9M7ZCg3X3nMb9W1kX8Q`.

**metadata** `object`

`metadata` atualizado. Ex.: `{"notes": "VIP customer"}`.

| HTTP | Significado | Corpo |
| - | - | - |
| `200` | Assinatura atualizada | `success`, `id`, `metadata` |
| `400` | Só assinaturas ativas podem ser atualizadas | `{"statusCode": 400, "message": "Only active subscriptions can be updated"}` |
| `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` | Assinatura não encontrada | `{"statusCode": 404, "message": "Subscription not found"}` |

> [!NOTE]
>
> **Para o negócio:** o `metadata` da assinatura volta nos webhooks de assinatura (campo `data.metadata`) e na [consulta da assinatura](https://docs.fastpaybrasil.com/referencia/assinaturas/consultar.md). Gravar ali o identificador do cliente no seu sistema facilita a conciliação de cada evento com a conta certa.

> [!TIP]
>
> **Para o desenvolvedor:** a documentação não diz se o `metadata` enviado é mesclado ao existente ou se o substitui. Para não perder chaves, consulte a assinatura, monte o objeto completo e envie tudo de uma vez.

## Erros comuns

| Sintoma | Causa | Como resolver |
| - | - | - |
| `400` "Only active subscriptions can be updated" | Assinatura `pending_activation`, `cancelled` ou `expired` | Só atualize assinaturas `active` |
| Assinatura `pending_activation` não sai do lugar | Esta rota não reativa assinaturas, e a API não tenta de novo a primeira cobrança | Crie uma nova assinatura com outro cartão e cancele a pendente (veja [Criar assinatura](https://docs.fastpaybrasil.com/referencia/assinaturas/criar.md)) |
| `404` "Subscription not found" | `id` errado ou de outra conta | Confira o `id` em [Listar assinaturas](https://docs.fastpaybrasil.com/referencia/assinaturas/listar.md) |
| `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](https://docs.fastpaybrasil.com/guias/assinaturas/visao-geral.md#permissões-por-perfil) |
| Cartão ou plano continuam os mesmos depois da chamada | Só `metadata` é atualizável | Cancele e crie outra assinatura |

```http REST (JSON) theme={null}
PATCH /v1/subscriptions/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
Content-Type: application/json

{
  "metadata": {
    "notes": "Cliente VIP"
  }
}
```

```bash cURL theme={null}
curl -X PATCH "https://api-global.fastpaybrasil.com/v1/subscriptions/2RhQg9M7ZCg3X3nMb9W1kX8Q" \
  -u "$FINVIA_API_KEY:" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "notes": "Cliente VIP"
    }
  }'
```

```javascript Node.js theme={null}
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');

const response = await fetch(
  'https://api-global.fastpaybrasil.com/v1/subscriptions/2RhQg9M7ZCg3X3nMb9W1kX8Q',
  {
    method: 'PATCH',
    headers: {
      Authorization: `Basic ${credentials}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      metadata: { notes: 'Cliente VIP', internalUserId: '12345' },
    }),
  },
);

const result = await response.json();
```

```python Python theme={null}
import os

import requests

payload = {
    "metadata": {
        "notes": "Cliente VIP",
    },
}

response = requests.request(
    "PATCH",
    "https://api-global.fastpaybrasil.com/v1/subscriptions/2RhQg9M7ZCg3X3nMb9W1kX8Q",
    auth=(os.environ["FINVIA_API_KEY"], ""),
    json=payload,
    timeout=30,
)

print(response.status_code)
if response.content:
    print(response.json())
```

```php PHP theme={null}
<?php

$payload = [
    'metadata' => [
        'notes' => 'Cliente VIP',
    ],
];

$ch = curl_init('https://api-global.fastpaybrasil.com/v1/subscriptions/2RhQg9M7ZCg3X3nMb9W1kX8Q');

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));
```

```java Java theme={null}
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 = """
            {
              "metadata": {
                "notes": "Cliente VIP"
              }
            }
            """;

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api-global.fastpaybrasil.com/v1/subscriptions/2RhQg9M7ZCg3X3nMb9W1kX8Q"))
            .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());
    }
}
```

```csharp C# theme={null}
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 = """
{
  "metadata": {
    "notes": "Cliente VIP"
  }
}
""";

var request = new HttpRequestMessage(HttpMethod.Patch, "https://api-global.fastpaybrasil.com/v1/subscriptions/2RhQg9M7ZCg3X3nMb9W1kX8Q");
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());
```

```go Go theme={null}
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	payload := strings.NewReader(`{
	  "metadata": {
	    "notes": "Cliente VIP"
	  }
	}`)

	req, err := http.NewRequest("PATCH", "https://api-global.fastpaybrasil.com/v1/subscriptions/2RhQg9M7ZCg3X3nMb9W1kX8Q", 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))
}
```

```ruby Ruby theme={null}
require "json"
require "net/http"
require "uri"

uri = URI("https://api-global.fastpaybrasil.com/v1/subscriptions/2RhQg9M7ZCg3X3nMb9W1kX8Q")
request = Net::HTTP::Patch.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "metadata" => {
    "notes" => "Cliente VIP",
  },
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.code
puts response.body
```

```json 200 theme={null}
{
  "success": true,
  "id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
  "metadata": {
    "notes": "VIP customer"
  }
}
```

```json 400 theme={null}
{
  "statusCode": 400,
  "message": "Only active subscriptions can be updated"
}
```

## Veja também

> [card] [Ciclo de vida](https://docs.fastpaybrasil.com/guias/assinaturas/ciclo-de-vida.md)
>
> Status, renovação, retentativas e cancelamento.

> [card] [Visão geral de assinaturas](https://docs.fastpaybrasil.com/guias/assinaturas/visao-geral.md)
>
> Fluxo completo, do cliente à cobrança recorrente.

> [card] [Planos](https://docs.fastpaybrasil.com/guias/assinaturas/planos.md)
>
> Recorrência, trial e status do plano.

> [card] [Webhooks de assinatura](https://docs.fastpaybrasil.com/guias/webhooks/assinatura.md)
>
> Eventos enviados a cada etapa da assinatura.

> [card] [Registrar cartão](https://docs.fastpaybrasil.com/referencia/cartoes/registrar.md)
>
> Registre o novo cartão antes de recriar a assinatura.

> [card] [Cancelar assinatura](https://docs.fastpaybrasil.com/referencia/assinaturas/cancelar.md)
>
> Primeiro passo para trocar cartão ou plano.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.