Skip to main content
POST
Criar produto

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.1.

Corpo

application/json
name
string
obrigatório

Nome do produto.

Required string length: 1 - 80
Exemplo:

"Plano Empresarial"

currency
enum<string>
obrigatório

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

Preço em centavos. Padrão: 0.

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

99900

description
string

Descrição do produto.

Maximum string length: 1000
Exemplo:

"Plano completo para grandes equipes."

code
string

Código interno ou SKU.

Maximum string length: 60
Exemplo:

"PLANO-EMP"

is_active
boolean

Se o produto está ativo. Padrão: true.

Exemplo:

true

billing_cycle
enum<string>

Ciclo de cobrança. Padrão: one_time.

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

"monthly"

image
string

Imagem do produto. Aceita URL HTTPS pública, Base64 puro ou data URI completo (data:image/png;base64,...). Máximo 2 MB.

Exemplo:

"https://exemplo.com/produto.png"

Resposta

Produto criado com sucesso.

data
object