Excluir uma assinatura

curl -X DELETE "https://api.chargefy.io/v1/subscriptions/sub_EaNM8xFeUay7QzwY" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "sub_EaNM8xFeUay7QzwY",
  "object": "subscription",
  "billing_cycle_anchor": "2026-05-19T18:00:00Z",
  "cancel_at": null,
  "cancel_at_period_end": false,
  "canceled_at": "2026-05-20T12:00:00Z",
  "cancellation_details": {
    "comment": null,
    "feedback": null,
    "reason": "cancellation_requested"
  },
  "collection_method": "charge_automatically",
  "created_at": "2026-05-19T18:00:00Z",
  "currency": "brl",
  "current_period_end": "2026-06-19T18:00:00Z",
  "current_period_start": "2026-05-19T18:00:00Z",
  "customer": "cus_ZJ7imE5PKP1RF9m3",
  "days_until_due": null,
  "default_payment_method": "pm_4WEwTx83TY6vjThd",
  "discount": null,
  "ended_at": null,
  "installments": 1,
  "items": {
    "object": "list",
    "data": [],
    "has_more": false,
    "url": "/v1/subscription-items?subscription=sub_EaNM8xFeUay7QzwY"
  },
  "latest_invoice": "inv_b2fgbezGQaDK1oJc",
  "livemode": true,
  "metadata": {},
  "next_billing_at": "2026-06-19T18:00:00Z",
  "pause_collection": null,
  "payment_settings": {},
  "pending_setup_intent": null,
  "pending_update": null,
  "resumed_at": null,
  "schedule": null,
  "schedule_phase_index": null,
  "start_date": "2026-05-19T18:00:00Z",
  "status": "canceled",
  "trial_end": null,
  "trial_settings": {
    "end_behavior": {
      "missing_payment_method": "create_invoice"
    }
  },
  "trial_start": null,
  "updated_at": "2026-05-20T12:00:00Z"
}

Cancela uma subscription imediatamente. Esse é o endpoint de remoção do recurso: a assinatura sai de uso agora, mas o registro continua existindo para preservar histórico financeiro, invoices e webhooks. Depois do DELETE, a Chargefy atualiza a assinatura para status: "canceled", preenche canceled_at, remove qualquer cancelamento agendado, cancela jobs pendentes de trial/renovação e dispara subscription.canceled. A resposta retorna o objeto subscription completo atualizado. Por padrão, faturas que já estavam em aberto continuam open e cobráveis depois do cancelamento — o cancelamento não apaga o que o cliente já devia. Envie void_open_invoices: true para anular essas faturas no mesmo passo.

Este endpoint é para encerrar agora. Quando a assinatura tem prazo combinado, declare o prazo em vez de agendar um clique: use o endpoint de update com cancel_at_period_end: true para encerrar no fim do período atual, ou cancel_at para encerrar numa data específica. Os dois campos também são aceitos na criação, o que permite vender com prazo em uma requisição só.Para desfazer, envie cancel_at_period_end: false ou cancel_at: null.

string

required

ID da subscription (sub_*).

object

Detalhes opcionais do cancelamento. Aceita comment e feedback; reason é definido pela Chargefy.Valores aceitos em feedback:

Valor	Descrição
`customer_service`	Insatisfação com o atendimento.
`low_quality`	Qualidade abaixo do esperado.
`missing_features`	Faltam funcionalidades importantes.
`other`	Outro motivo.
`switched_service`	Trocou por outro serviço.
`too_complex`	Produto complexo demais.
`too_expensive`	Preço alto demais.
`unused`	Não usava o produto.

boolean

default:"false"

Quando true, todas as faturas em aberto da assinatura passam para status: "void" e seus payment intents em aberto são cancelados. Por padrão (false), as faturas em aberto permanecem cobráveis após o cancelamento.

curl -X DELETE "https://api.chargefy.io/v1/subscriptions/sub_EaNM8xFeUay7QzwY" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "sub_EaNM8xFeUay7QzwY",
  "object": "subscription",
  "billing_cycle_anchor": "2026-05-19T18:00:00Z",
  "cancel_at": null,
  "cancel_at_period_end": false,
  "canceled_at": "2026-05-20T12:00:00Z",
  "cancellation_details": {
    "comment": null,
    "feedback": null,
    "reason": "cancellation_requested"
  },
  "collection_method": "charge_automatically",
  "created_at": "2026-05-19T18:00:00Z",
  "currency": "brl",
  "current_period_end": "2026-06-19T18:00:00Z",
  "current_period_start": "2026-05-19T18:00:00Z",
  "customer": "cus_ZJ7imE5PKP1RF9m3",
  "days_until_due": null,
  "default_payment_method": "pm_4WEwTx83TY6vjThd",
  "discount": null,
  "ended_at": null,
  "installments": 1,
  "items": {
    "object": "list",
    "data": [],
    "has_more": false,
    "url": "/v1/subscription-items?subscription=sub_EaNM8xFeUay7QzwY"
  },
  "latest_invoice": "inv_b2fgbezGQaDK1oJc",
  "livemode": true,
  "metadata": {},
  "next_billing_at": "2026-06-19T18:00:00Z",
  "pause_collection": null,
  "payment_settings": {},
  "pending_setup_intent": null,
  "pending_update": null,
  "resumed_at": null,
  "schedule": null,
  "schedule_phase_index": null,
  "start_date": "2026-05-19T18:00:00Z",
  "status": "canceled",
  "trial_end": null,
  "trial_settings": {
    "end_behavior": {
      "missing_payment_method": "create_invoice"
    }
  },
  "trial_start": null,
  "updated_at": "2026-05-20T12:00:00Z"
}

Webhooks

O cancelamento imediato dispara subscription.canceled com a subscription completa em data.object. Com void_open_invoices: true, cada fatura anulada dispara invoice.voided e cada payment intent cancelado dispara payment.intent.canceled, antes do subscription.canceled.

curl -X DELETE "https://api.chargefy.io/v1/subscriptions/sub_EaNM8xFeUay7QzwY" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "sub_EaNM8xFeUay7QzwY",
  "object": "subscription",
  "billing_cycle_anchor": "2026-05-19T18:00:00Z",
  "cancel_at": null,
  "cancel_at_period_end": false,
  "canceled_at": "2026-05-20T12:00:00Z",
  "cancellation_details": {
    "comment": null,
    "feedback": null,
    "reason": "cancellation_requested"
  },
  "collection_method": "charge_automatically",
  "created_at": "2026-05-19T18:00:00Z",
  "currency": "brl",
  "current_period_end": "2026-06-19T18:00:00Z",
  "current_period_start": "2026-05-19T18:00:00Z",
  "customer": "cus_ZJ7imE5PKP1RF9m3",
  "days_until_due": null,
  "default_payment_method": "pm_4WEwTx83TY6vjThd",
  "discount": null,
  "ended_at": null,
  "installments": 1,
  "items": {
    "object": "list",
    "data": [],
    "has_more": false,
    "url": "/v1/subscription-items?subscription=sub_EaNM8xFeUay7QzwY"
  },
  "latest_invoice": "inv_b2fgbezGQaDK1oJc",
  "livemode": true,
  "metadata": {},
  "next_billing_at": "2026-06-19T18:00:00Z",
  "pause_collection": null,
  "payment_settings": {},
  "pending_setup_intent": null,
  "pending_update": null,
  "resumed_at": null,
  "schedule": null,
  "schedule_phase_index": null,
  "start_date": "2026-05-19T18:00:00Z",
  "status": "canceled",
  "trial_end": null,
  "trial_settings": {
    "end_behavior": {
      "missing_payment_method": "create_invoice"
    }
  },
  "trial_start": null,
  "updated_at": "2026-05-20T12:00:00Z"
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Excluir uma assinatura

Webhooks

​Webhooks

Webhooks