Skip to main content
Um product (produto) representa o item de catálogo ou serviço que a sua organização comercializa. Ele atua como o container de alto nível de uma oferta — armazenando o nome, a descrição comercial e a imagem do produto —, enquanto os valores monetários e as regras de cobrança (sejam avulsas ou recorrentes) são delegados a objetos price associados quando eles existem. Os produtos são a base para a criação de checkouts, links de pagamento e planos de assinatura. Um produto pode começar sem preço quando a cobrança ainda está indefinida, ou ter múltiplos preços ativos em paralelo (por exemplo, um preço mensal e um anual), permitindo que a mesma oferta física ou digital seja cobrada sob diferentes termos de pagamento de acordo com a escolha do comprador.

​
Objeto product

Este é o formato completo retornado em create, get, update, itens de list e em data.object dos webhooks product.*. 
{
  "id": "prod_123",
  "object": "product",
  "created_at": "2026-05-19T18:00:00Z",
  "default_price": "price_123",
  "description": "Acesso premium à plataforma de desenvolvimento",
  "image_url": "https://images.chargefy.io/product/prod_123.png",
  "is_active": true,
  "is_tax_applicable": false,
  "livemode": true,
  "metadata": {},
  "name": "Plano Premium Dev",
  "prices": [
    {
      "id": "price_123",
      "object": "price",
      "created_at": "2026-05-19T18:00:00Z",
      "currency": "brl",
      "is_active": true,
      "livemode": true,
      "metadata": {},
      "name": "Mensalidade Pro",
      "product": "prod_123",
      "recurring": {
        "interval": "month",
        "interval_count": 1,
        "trial_period_days": 7,
        "usage_type": "licensed"
      },
      "tax_behavior": "unspecified",
      "type": "recurring",
      "unit_amount": 9990,
      "updated_at": "2026-05-19T18:00:00Z"
    }
  ],
  "updated_at": "2026-05-19T18:00:00Z"
}
​
id
string
Identificador único do produto. Usa o prefixo prod_*.
​
object
string
Sempre "product".
​
created_at
string
Data de criação em formato ISO 8601.
​
default_price
string | null
ID do preço padrão (price_*) associado a este produto, ou null quando o produto ainda não tem preço padrão.
​
description
string | null
Descrição interna ou comercial do produto.
​
image_url
string | null
A URL pública para a imagem ilustrativa do produto utilizada no checkout.
​
is_active
boolean
Define se o produto está ativo e disponível para novas vendas ou assinaturas.
​
is_tax_applicable
boolean
Define se impostos são aplicáveis ao produto.
​
livemode
boolean
true se gerado em produção; false se em testes.
​
metadata
object
Metadados customizados vinculados ao produto. Retorna {} quando vazio.
​
name
string
Nome do produto exibido para o comprador final.
​
updated_at
string | null
Data da última atualização em formato ISO 8601.
​
prices
array
Lista de preços estruturados cadastrados sob este produto. Retorna [] quando o produto ainda não tem preços.

​
Operações

​
Webhooks

Mudanças nesse objeto disparam os seguintes eventos de webhook: O payload carrega o objeto product completo em data.object.