Produtos

Um product (produto) representa o item de catálogo ou serviço que a sua organização vende. Ele funciona como o container de alto nível de uma oferta — guardando o nome, a descrição comercial e a imagem do produto —, enquanto os valores monetários e as regras de cobrança (avulsas ou recorrentes) ficam por conta dos objetos price associados, quando eles existem. Os produtos são a base para criar 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 vários preços ativos ao mesmo tempo (por exemplo, um preço mensal e um anual), permitindo que a mesma oferta seja cobrada de formas diferentes 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_kUB1FemYPFAEPsRf",
  "object": "product",
  "created_at": "2026-05-19T18:00:00Z",
  "default_price": "price_GhafJJvD1HTTs36P",
  "description": "Acesso premium à plataforma de desenvolvimento",
  "image_url": "https://images.chargefy.io/product/prod_kUB1FemYPFAEPsRf.png",
  "is_active": true,
  "is_tax_applicable": false,
  "livemode": true,
  "marketing_features": [
    {
      "name": "Acesso ilimitado"
    },
    {
      "name": "Suporte prioritário"
    }
  ],
  "metadata": {},
  "name": "Plano Premium Dev",
  "prices": [
    {
      "id": "price_GhafJJvD1HTTs36P",
      "object": "price",
      "created_at": "2026-05-19T18:00:00Z",
      "currency": "brl",
      "is_active": true,
      "livemode": true,
      "metadata": {},
      "name": "Mensalidade Pro",
      "product": "prod_kUB1FemYPFAEPsRf",
      "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"
}

string

Identificador único do produto. Usa o prefixo prod_*.

string

Sempre "product".

string

Data de criação em formato ISO 8601.

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.

string | null

Descrição interna ou comercial do produto.

string | null

URL pública da imagem do produto usada no checkout.

boolean

Define se o produto está ativo e disponível para novas vendas ou assinaturas.

boolean

Define se o produto é tributável.

boolean

true se gerado em produção; false se em testes.

array

Lista de recursos de marketing do produto, exibidos em superfícies de venda para o comprador. Retorna [] quando vazio. Cada item é um objeto:

Show Campos de marketing_features[]

string

Texto do recurso exibido ao comprador. Até 80 caracteres.

object

Metadados customizados do produto. Retorna {} quando vazio.

string

Nome do produto exibido para o comprador final.

string | null

Data da última atualização em formato ISO 8601.

array

Lista de preços deste produto. Retorna [] quando o produto ainda não tem preços.

Show Campos de prices[]

string

Identificador único do preço (price_*).

string

Sempre "price".

string

Data de criação em formato ISO 8601.

string

Moeda (ex: brl).

boolean

Define se este preço está ativo.

boolean

true em produção; false em testes.

object

Metadados do preço.

string | null

Rótulo/nome interno do preço.

string

ID do produto pai (prod_*).

string | null

Como o imposto se relaciona ao valor.

Valor	Descrição
`unspecified`	Comportamento de imposto não definido.
`inclusive`	Imposto já incluso no valor.
`exclusive`	Imposto somado ao valor.

string

Forma de cobrança do preço.

Valor	Descrição
`one_time`	Compra única.
`recurring`	Cobrança que se repete em um intervalo definido.

integer

Valor unitário em centavos.

string | null

Data de atualização em formato ISO 8601.

object | null

Configurações de recorrência se o tipo for recurring. Contém: interval (string com o intervalo de recorrência), interval_count (integer com a quantidade de intervalos entre cobranças), trial_period_days (integer com dias grátis de teste) e usage_type (sempre "licensed").Valores possíveis de interval:

Valor	Descrição
`day`	Cobrança diária.
`week`	Cobrança semanal.
`month`	Cobrança mensal.
`year`	Cobrança anual.

Operações

Eventos

Mudanças nesse objeto disparam os seguintes eventos:

O payload carrega o objeto product completo em data.object.

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Objeto product

Operações

Eventos

​Objeto product

​Operações

​Eventos

Objeto product

Operações

Eventos