Buscar plano por ID
Retorna o plano com seus itens, cada um acompanhado do preço em vigor.
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.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
Authorizations
API Key da Credential (gerada no Backoffice)
Path Parameters
ID do plano
Query Parameters
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
Identificador único do registro.
Código de identificação do recurso (ex.: código do plano ou do contrato).
Nome de exibição do plano ou do componente.
Descrição do item (item do plano ou linha da fatura).
Status atual do registro (assinatura, fatura, plano ou slip de pagamento).
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.
Período de teste padrão da oferta. A assinatura pode sobrescrevê-lo.
Metadados livres (pares chave-valor) para uso do integrador; não afeta o processamento.
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).
Itens do plano, cada um com o preço em vigor.