Skip to main content
GET
Buscar plano por ID
GET /plans/:id Faz parte do recurso Planos e Preços — o conceito e os status estão lá. Devolve a oferta completa: o plano, seus itens e, em cada item, o preço em vigor (currentPrice). É a leitura para montar uma tela de contratação — a listagem devolve só o plano, sem os itens.
currency escolhe o preço, não filtra os itens. Com ela, cada item traz o preço vigente naquela moeda; um item que não tenha preço nessa moeda aparece do mesmo jeito, com currentPrice nulo. Sem ela, cada item traz o primeiro preço encontrado.
Itens arquivados não aparecem. Arquivar um item o retira das próximas assinaturas e da resposta desta rota. Isso não afeta as assinaturas em curso, que já o instanciaram e continuam cobrando por ele — o item some do catálogo, não da cobrança.
A cadência e o teste vêm duas vezes, e é de propósito. Na raiz estão os do plano; dentro de cada currentPrice, os que aquele preço herdou quando foi criado. Divergem quando o plano mudou depois — o que vale para uma assinatura é sempre o do preço que ela contratou.

Exemplo

Resposta 200
O exemplo está abreviado — o playground ao lado mostra o corpo inteiro.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID do plano

Query Parameters

currency
string

Moeda (ISO 4217) do preço devolvido em currentPrice. Não filtra a lista de itens: componente sem preço nesta moeda vem com currentPrice nulo. Omitida, cada item traz o primeiro preço encontrado.

Response

Plano com itens e preços em vigor

id
string

Identificador único do registro.

code
string

Código de identificação do recurso (ex.: código do plano ou do contrato).

name
string

Nome de exibição do plano ou do componente.

description
string | null

Descrição do item (item do plano ou linha da fatura).

status
string

Status atual do registro (assinatura, fatura, plano ou slip de pagamento).

recurrence
object | null

Cadência da cobrança: a cada quantas unidades (interval), qual unidade (unit), a âncora do ciclo e se cobra no início ou no fim. Vale para todos os itens recorrentes.

trialSpec
object | null

Período de teste padrão da oferta. A assinatura pode sobrescrevê-lo.

metadata
object

Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).

items
object[]

Itens do plano, cada um com o preço em vigor.