> ## 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.

# Consultar um plano

> Devolve os dados de um plano de assinatura: preço, periodicidade, status e quantidade de assinaturas ativas.

Esta rota traz a configuração atual de um plano a partir do `id`. Use-a para conferir se o plano está disponível antes de levar o cliente ao checkout e para exibir nome, preço e imagem do plano na sua aplicação.

## Quando usar

| Situação | Como usar esta rota |
| - | - |
| Antes do checkout da assinatura | Confira se `status` é `active`. Plano inativo faz a criação da assinatura falhar com `404` |
| Página de detalhes do plano | Exiba `name`, `price`, `buyerMessage` e `imageUrl` |
| Conferir uma alteração feita em [Atualizar plano](https://docs.fastpaybrasil.com/referencia/planos/atualizar.md) | Compare os campos e o `updatedAt` |
| Ver todos os planos | Use [Listar planos](https://docs.fastpaybrasil.com/referencia/planos/listar.md) |

## Antes de chamar

* Tenha uma chave secreta gerada por usuário com a permissão **visualizar assinaturas**. Nos perfis padrão, são **Owner**, **Manager**, **Operador** e **Visualizador**. Os perfis Desenvolvedor e Financeiro recebem `403` (veja [Permissões por perfil](https://docs.fastpaybrasil.com/guias/assinaturas/visao-geral.md#permissões-por-perfil)).
* Tenha o `id` do plano, devolvido na criação ou na listagem.

> [!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).

## Parâmetros de caminho

**id** `string` *required*

Identificador único do plano. Ex.: `2RhQg9M7ZCg3X3nMb9W1kX8Q`.

## Respostas

**id** `string`

Identificador único do plano.

**merchantId** `string`

ID do merchant dono do plano.

**name** `string`

Nome do plano. Ex.: `Plano Premium Mensal`.

**price** `number`

Preço do plano, em reais: `99.9` significa R\$ 99,90.

**currency** `string`

Código da moeda. Ex.: `BRL`.

**recurrenceType** `string`

Periodicidade: `weekly` (semanal), `biweekly` (quinzenal), `monthly` (mensal) ou `custom` (intervalo personalizado).

**recurrenceInterval** `integer | null`

Intervalo da recorrência personalizada, em dias corridos (ex.: `90` = a cada 90 dias). `null` quando o plano não é `custom`.

**endDate** `string | null`

Data de término do plano (formato `date-time`). `null` quando não há data de término.

**buyerMessage** `string | null`

Mensagem exibida ao comprador. Ex.: `Bem-vindo ao Plano Premium!`.

**paymentMethods** `string[]`

Formas de pagamento aceitas. Ex.: `["credit_card"]`.

**imageUrl** `string | null`

URL da imagem do plano.

**status** `string`

Status do plano: `active` (aceita novas assinaturas) ou `inactive` (não aceita).

**activeSubscriptionsCount** `integer`

Quantidade de assinaturas ativas no plano. Ex.: `150`.

**createdAt** `string`

Data de criação (formato `date-time`).

**updatedAt** `string`

Data da última atualização (formato `date-time`).

| HTTP | Significado | Corpo |
| - | - | - |
| `200` | Plano encontrado | Objeto do plano |
| `401` | Credencial inválida | `{"statusCode": 401, "message": "Unauthorized"}` |
| `403` | O usuário que gerou a chave não tem a permissão visualizar assinaturas | `{"message": "Acesso negado", "error": "Forbidden", "statusCode": 403}` |
| `404` | Plano não encontrado | `{"statusCode": 404, "message": "Subscription plan not found"}` |

> [!NOTE]
>
> **Para o negócio:** os dados devolvidos aqui valem para **novas** assinaturas. Quem já assinou continua pagando o preço, a moeda e a periodicidade da data da contratação, mesmo que o plano tenha sido alterado depois. Para saber o que um assinante específico paga, consulte a assinatura em [Consultar assinatura](https://docs.fastpaybrasil.com/referencia/assinaturas/consultar.md).

## Erros comuns

| Sintoma | Causa | Como resolver |
| - | - | - |
| `404` com "Subscription plan not found" | `id` errado ou de outra conta | Confira o `id` na [listagem de planos](https://docs.fastpaybrasil.com/referencia/planos/listar.md) feita com a mesma chave |
| `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 visualizar assinaturas (ex.: 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) |
| Checkout da assinatura falha mesmo com plano encontrado | Plano com `status` `inactive` | Reative em [Alterar status do plano](https://docs.fastpaybrasil.com/referencia/planos/alterar-status.md) ou use outro plano |

```http REST (JSON) theme={null}
GET /v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
```

```bash cURL theme={null}
curl -X GET "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q" \
  -u "$FINVIA_API_KEY:"
```

```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/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q',
  { headers: { Authorization: `Basic ${credentials}` } },
);

const plan = await response.json();
if (plan.status !== 'active') {
  // não leve o cliente ao checkout com um plano inativo
}
```

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

import requests

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

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

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

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

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
]);

$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());

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q"))
            .header("Authorization", "Basic " + credentials)
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .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 request = new HttpRequestMessage(HttpMethod.Get, "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q");

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"
)

func main() {
	req, err := http.NewRequest("GET", "https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q", nil)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")

	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 "net/http"
require "uri"

uri = URI("https://api-global.fastpaybrasil.com/v1/subscription-plans/2RhQg9M7ZCg3X3nMb9W1kX8Q")
request = Net::HTTP::Get.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")

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}
{
  "id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
  "merchantId": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
  "name": "Plano Premium Mensal",
  "price": 99.9,
  "currency": "BRL",
  "recurrenceType": "monthly",
  "recurrenceInterval": null,
  "endDate": null,
  "buyerMessage": "Bem-vindo ao Plano Premium!",
  "paymentMethods": ["credit_card"],
  "imageUrl": "https://storage.example.com/plans/image.png",
  "status": "active",
  "activeSubscriptionsCount": 150,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}
```

```json 404 theme={null}
{
  "statusCode": 404,
  "message": "Subscription plan not found"
}
```

## Veja também

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

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

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

> [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)
>
> Guarde o cartão no cofre antes de criar a assinatura.

> [card] [Atualizar plano](https://docs.fastpaybrasil.com/referencia/planos/atualizar.md)
>
> Altere preço, nome ou trial para novas assinaturas.


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