Excluir uma organização

curl -X DELETE "https://api.chargefy.io/v1/organizations/org_5Nq8rT2wX7mK4pV9" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Idempotency-Key: delete-org-5Nq8rT2wX7mK4pV9"

{
  "id": "org_5Nq8rT2wX7mK4pV9",
  "object": "organization",
  "deleted": true
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": "resource_missing",
    "message": "Organization not found",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "organization_not_deletable",
    "message": "Organization has pending live activity: 7 receivables, 1 subscription. Resolve these items before deleting.",
    "type": "invalid_request_error"
  }
}

Exclui uma organização conectada da sua plataforma. A organização sai de circulação: deixa de aparecer na listagem, não pode mais ser consultada por GET /v1/organizations/:id, o header Organization com o identificador dela passa a responder 403, e as páginas hospedadas dela (checkout, fatura, portal e ativação) ficam indisponíveis. O histórico é preservado internamente: vendas, clientes, assinaturas e ajustes posteriores de vendas antigas — como um chargeback tardio — continuam sendo processados normalmente. A exclusão não é uma confirmação bancária: ela não atesta que valores já liquidados chegaram à conta do recebedor. Se a plataforma cadastrar novamente o mesmo CPF/CNPJ depois da exclusão, uma nova organização é criada, com outro id. Nenhuma venda, cliente ou catálogo da organização excluída é transferido para ela.

Autenticação

Requer API key de plataforma com escopo platform_admin.

Não envie o header Organization. A organização-alvo é o id do caminho e a API responde 400 se esse header estiver presente.

Elegibilidade

A exclusão é recusada com 409 e code: "organization_not_deletable" enquanto a organização tiver pendências de produção:

recebíveis pendentes ou futuros — inclusive parcelas e tarifas geradas por vendas dela;
pagamentos em andamento, estornos não concluídos ou disputas abertas;
assinaturas não encerradas, agendamentos de assinatura não encerrados ou faturas em aberto.

Sobras de teste não bloqueiam: assinaturas, faturas e pagamentos de sandbox permanecem como histórico, com os estados que tinham, e nada novo é criado a partir do fechamento. Uma API key de teste só exclui uma organização sem uso de produção. Uma venda real antiga, mesmo já liquidada, exige uma API key de produção.

Parâmetros de caminho

string

obrigatório

ID da organização conectada (org_*).

curl -X DELETE "https://api.chargefy.io/v1/organizations/org_5Nq8rT2wX7mK4pV9" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Idempotency-Key: delete-org-5Nq8rT2wX7mK4pV9"

Resposta

200 OK com o objeto curto de remoção.

Campo	Tipo	Observação
`id`	`string`	ID da organização excluída
`object`	`string`	Sempre `"organization"`
`deleted`	`boolean`	Sempre `true`

Repetir a requisição com o mesmo Idempotency-Key reproduz o mesmo sucesso, sem novo fechamento nem novo evento. Uma nova requisição (sem a mesma chave) para uma organização já excluída responde 404.

{
  "id": "org_5Nq8rT2wX7mK4pV9",
  "object": "organization",
  "deleted": true
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": "resource_missing",
    "message": "Organization not found",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "organization_not_deletable",
    "message": "Organization has pending live activity: 7 receivables, 1 subscription. Resolve these items before deleting.",
    "type": "invalid_request_error"
  }
}

Erros comuns

Status	`code`	Quando ocorre
`403`	—	A API key não é de plataforma
`404`	`resource_missing`	Organização inexistente, já excluída ou de outra plataforma
`409`	`organization_not_deletable`	Pendências de produção, ou API key de teste diante de uso de produção — a mensagem diz o que resolver

Webhook

A exclusão dispara organization.deleted para a plataforma, com o organization completo em data.object no estado imediatamente anterior ao fechamento — o último retrato da organização, mesmo que a plataforma não consiga mais consultá-la.

curl -X DELETE "https://api.chargefy.io/v1/organizations/org_5Nq8rT2wX7mK4pV9" \
  -H "Authorization: Bearer {{API_KEY}}" \
  -H "Idempotency-Key: delete-org-5Nq8rT2wX7mK4pV9"

{
  "id": "org_5Nq8rT2wX7mK4pV9",
  "object": "organization",
  "deleted": true
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": "resource_missing",
    "message": "Organization not found",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "organization_not_deletable",
    "message": "Organization has pending live activity: 7 receivables, 1 subscription. Resolve these items before deleting.",
    "type": "invalid_request_error"
  }
}

Visão geral

Ativação de organizações

Planos de taxas

Marca e domínio próprio

Modelo de negócio

Excluir uma organização

Autenticação

Elegibilidade

Parâmetros de caminho

Resposta

Erros comuns

Webhook

​Autenticação

​Elegibilidade

​Parâmetros de caminho

​Resposta

​Erros comuns

​Webhook

Autenticação

Elegibilidade

Parâmetros de caminho

Resposta

Erros comuns

Webhook