Skip to main content

Visão geral

Use este endpoint para cadastrar um novo produto no seu catálogo. Produtos podem ser referenciados na criação de links de pagamento e assinaturas, simplificando a geração de cobranças recorrentes ou avulsas.

Endpoint

Parâmetros do corpo

string
required
Nome do produto, exibido em links de pagamento e faturas.
string
Descrição detalhada do produto.
integer
required
Preço do produto em centavos (ex: 9990 representa R$ 99,90).
string
required
Código da moeda no formato ISO 4217. Atualmente, apenas BRL é suportado.
object
Conjunto de pares chave-valor para armazenar informações adicionais sobre o produto.

Resposta

string
Identificador único do produto, no formato prod_xxxxxxxxxxxx.
string
Nome do produto.
string
Descrição do produto.
integer
Preço do produto em centavos.
string
Código da moeda do produto.
string
Data e hora de criação do produto, no formato ISO 8601.

Exemplo de resposta

Utilize o campo metadata para armazenar identificadores internos do seu sistema e facilitar a conciliação posterior.

Erros comuns

Próximos passos

Listar produtos

Consulte todos os produtos cadastrados.

Editar produto

Atualize os dados de um produto existente.