Skip to main content
PATCH
Atualizar produto

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.1.

Parâmetros de caminho

id
string<uuid>
obrigatório

UUID do recurso.

Corpo

application/json

Todos os campos são opcionais. Apenas os campos enviados no body são alterados.

name
string

Novo nome do produto.

Required string length: 1 - 80
Exemplo:

"Plano Empresarial Plus"

currency
enum<string>

Código ISO 4217 de moeda suportado pela Vendaze.

Opções disponíveis:
AED,
ARS,
AUD,
BRL,
CAD,
CHF,
CLP,
CNY,
COP,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
JPY,
KWD,
MAD,
MXN,
MYR,
NGN,
NOK,
NZD,
PEN,
QAR,
SAR,
SEK,
SGD,
TRY,
USD,
UYU,
ZAR
Exemplo:

"BRL"

price_cts
integer

Novo preço em centavos.

Intervalo necessário: 0 <= x <= 1000000000000000
Exemplo:

149900

description
string | null

Nova descrição. Envie null para remover.

Maximum string length: 1000
Exemplo:

"Versão atualizada do plano empresarial."

code
string | null

Novo código interno. Envie null para remover.

Maximum string length: 60
Exemplo:

"PLANO-EMP-PLUS"

is_active
boolean

Atualiza o status de ativo.

Exemplo:

false

billing_cycle
enum<string>

Novo ciclo de cobrança.

Opções disponíveis:
one_time,
monthly,
quarterly,
annually
Exemplo:

"annually"

image
string

Nova imagem do produto. Substitui a imagem atual.

Exemplo:

"https://exemplo.com/nova-imagem.png"

Resposta

Produto atualizado com sucesso.

data
object