Skip to main content
POST
Criar plano
Cria um novo 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

Body

application/json
name
string
required

Nome do plano exibido ao cliente.

Example:

"Plano Mensal Pro"

amount
integer
required

Valor em centavos (mín. 1 = R$ 0,01; máx. 1000000 = R$ 10.000,00)

Required range: 1 <= x <= 1000000
Example:

9900

pricing_type
enum<string>
required

Modelo de precificação: FIXED_PRICE (valor fixo) ou PAY_WHAT_YOU_WANT.

Available options:
FIXED_PRICE,
PAY_WHAT_YOU_WANT
currency
string
required

Moeda ISO 4217 (ex.: BRL).

Example:

"BRL"

interval
enum<string>
required

Cadência de cobrança. Imutável após a criação.

Available options:
ONE_TIME,
DAILY,
WEEKLY,
MONTHLY,
QUARTERLY,
BIANNUAL,
ANNUAL,
CUSTOM
allowed_payment_types
enum<string>[]
required

Métodos de pagamento aceitos pelo plano (credit_card, pix).

Available options:
credit_card,
pix
Example:
prevent_trial_abuse
boolean
required

Bloqueia novo trial para o mesmo customer quando já houve trial no plano.

Example:

true

description
string | null

Descrição livre do plano.

Example:

"Acesso completo mensal"

custom_interval
integer | null

Obrigatório quando interval = CUSTOM

Example:

null

default_trial_unit
enum<string> | null

Unidade do trial padrão do plano (DAY, WEEK, MONTH, YEAR). Use junto com default_trial_duration.

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

Duração do trial padrão do plano (máx. 31 dias)

Required range: 1 <= x <= 31

Response

Plano criado

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.