Skip to main content
GET
Consultar plano

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.0 (opaco) com o escopo dv.partner, obtido em POST /authentication/v1/oauth/token.

Parâmetros de caminho

partnerId
string<uuid>
obrigatório

UUID do parceiro ou da revenda.

planId
string<uuid>
obrigatório

UUID do plano.

Resposta

Plano encontrado.

id
string<uuid>
obrigatório

UUID do plano.

name
string
obrigatório

Nome do plano.

standard
boolean
obrigatório

Indica se é o plano padrão do parceiro.

code
string
obrigatório

Código do plano.

status
enum<string>
obrigatório

Status do plano.

Opções disponíveis:
DRAFT,
AVAILABLE,
UNAVAILABLE
visibility
enum<string>
obrigatório

Para quem o plano pode ser oferecido.

Opções disponíveis:
PUBLIC,
PRIVATE,
RESALE,
DIRECT_MERCHANT
features
object[]
obrigatório

Recursos do plano.