Produtos
Excluir um produto
Remove ou desativa um produto.
Remove um
Quando o produto precisava permanecer auditável — mesmo shape de
product quando ele nunca foi usado. Se o produto já estiver
referenciado por histórico financeiro, checkout ou assinatura, a Chargefy
desativa o produto automaticamente com is_active=false e retorna o objeto
completo atualizado em vez do shape curto de remoção.
Delete ou arquivamento: como decidimos
Você sempre chama a mesma rota, e a Chargefy escolhe o caminho seguro por você:- Nunca foi usado → o produto é removido de verdade. A resposta traz
deleted: true. - Já teve venda, checkout ou assinatura → o produto é arquivado
(
is_active=false) em vez de apagado. A resposta traz o objeto completo comis_active: false.
Autenticação
A API key da própria organização atua diretamente. A API key de plataforma exige o headerOrganization: <organization_id> apontando para uma organização
conectada ativa.
Parâmetros de caminho
string
required
ID do produto (
prod_*).Resposta
200 OK com um destes dois shapes:
Quando a row pôde ser removida — objeto curto de remoção:
GET /v1/products/:id com
is_active=false.
Erros comuns
Webhook
Quando o produto é desativado em vez de removido, disparaproduct.updated com
previous_attributes.is_active = true.
