Skip to main content
curl -X DELETE "https://api.chargefy.io/v1/prices/price_123" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "price_123",
  "object": "price",
  "deleted": true
}
Remove um price quando ele nunca foi usado. Se o preço já estiver referenciado por histórico financeiro, checkout ou assinatura, a Chargefy desativa o preço 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 preço é removido de verdade. A resposta traz deleted: true.
  • Já teve venda, checkout ou assinatura → o preço é arquivado (is_active=false) em vez de apagado. A resposta traz o objeto completo com is_active: false.
Fazemos assim para nunca quebrar o histórico. Cobranças e assinaturas que já usaram aquele preço precisam continuar apontando para ele; apagar deixaria faturas e relatórios sem referência. Arquivar tira o preço de novos checkouts e assinaturas sem afetar nada que já foi cobrado.
É por isso que, para mudar de valor, você cria um preço novo e arquiva o antigo (is_active=false) — em vez de editar o valor. Assim as assinaturas ativas seguem no preço antigo e as novas pegam o novo, sem perder o histórico.

​
Autenticação

A API key da própria organização atua diretamente. A API key de plataforma exige o header Organization: <organization_id> apontando para uma organização conectada ativa.

​
Parâmetros de caminho

​
id
string
required
ID do preço (price_*).
curl -X DELETE "https://api.chargefy.io/v1/prices/price_123" \
  -H "Authorization: Bearer {{API_KEY}}"

​
Resposta

200 OK com um destes dois shapes: Quando a row pôde ser removida — objeto curto de remoção:
CampoTipoObservação
idstringID do preço removido
objectstringSempre "price"
deletedbooleanSempre true
{
  "id": "price_123",
  "object": "price",
  "deleted": true
}
Quando o preço precisava permanecer auditável — mesmo shape de GET /v1/prices/:id com is_active=false.

​
Erros comuns

StatuscodeQuando ocorre
404resource_missingPreço não existe nesta organização

​
Webhook

Quando o preço é desativado em vez de removido, dispara price.updated com previous_attributes.is_active = true.