Skip to main content
PATCH
Atualizar plano
Atualiza um plano de assinatura existente.

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

Body

application/json
name
string

Novo nome do plano.

description
string | null

Nova descrição do plano.

amount
integer

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

Required range: 1 <= x <= 1000000
pricing_type
enum<string>

Novo modelo de precificação.

Available options:
FIXED_PRICE,
PAY_WHAT_YOU_WANT
currency
string

Nova moeda ISO 4217.

interval
enum<string>

Cadência é imutável após criação — alterar retorna 422 CADENCE_IMMUTABLE

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

Intervalo customizado. Faz parte da cadência imutável.

allowed_payment_types
enum<string>[]

Novos métodos de pagamento aceitos (credit_card, pix).

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

Nova unidade do trial padrão do plano.

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

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

Required range: 1 <= x <= 31
prevent_trial_abuse
boolean

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

Response

Plano atualizado

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.