Skip to main content
GET
Consultar plano
Retorna os detalhes de um plano de assinatura.

Authorizations

client-id
string
header
required
client-secret
string
header
required

Headers

client-id
string
required

ID público da credencial do merchant

client-secret
string
required

Secret da credencial do merchant

Path Parameters

planId
string<uuid>
required

Response

Detalhe do plano

id
string<uuid>

Identificador do plano.

name
string

Nome do plano.

description
string | null

Descrição do plano.

amount
integer

Valor do plano em centavos.

pricing_type
enum<string>

Modelo de precificação.

Available options:
FIXED_PRICE,
PAY_WHAT_YOU_WANT
currency
string

Moeda ISO 4217.

interval
enum<string>

Cadência de cobrança.

Available options:
ONE_TIME,
DAILY,
WEEKLY,
MONTHLY,
QUARTERLY,
BIANNUAL,
ANNUAL,
CUSTOM
custom_interval
integer | null

Intervalo customizado (quando interval = CUSTOM).

allowed_payment_types
enum<string>[]

Métodos de pagamento aceitos.

Available options:
credit_card,
pix
default_trial_unit
enum<string> | null

Unidade do trial padrão do plano.

Available options:
DAY,
WEEK,
MONTH,
YEAR
default_trial_duration
integer | null

Duração do trial padrão do plano.

prevent_trial_abuse
boolean

Se o plano bloqueia reuso de trial pelo mesmo customer.

plan_status
enum<string>

Situação do plano: ACTIVE ou INACTIVE.

Available options:
ACTIVE,
INACTIVE
origin
enum<string>

Origem da criação: API ou PORTAL.

Available options:
API,
PORTAL
created_at
string<date-time>

Data de criação do plano.

updated_at
string<date-time>

Data da última atualização do plano.