Cancelar uma assinatura

DELETE 
/api/public/v1/subscriptions/:subscription_id

Cancela uma assinatura existente, com opção de enviar notificações e executar integrações.

Request

Path Parameters

subscription_id integerrequired

ID da assinatura a ser cancelada

application/json

Body

Dados opcionais para configurar o cancelamento

send_notifications boolean

Indica se notificações (e-mails, SMS, etc) devem ser enviadas

run_integrations boolean

Define se integrações (webhooks, notas fiscais, etc) relacionadas devem ser executadas

Responses

200

Cancelamento bem-sucedido

application/json

Schema

Schema

subscription_id integer

ID da assinatura cancelada

canceled_at date-time

Data e hora do cancelamento

canceled_by string

Usuário que realizou o cancelamento

Example (from schema)

{
  "subscription_id": 0,
  "canceled_at": "2024-11-30T15:28:32.583Z",
  "canceled_by": "string"
}

Example

{
  "subscription_id": "integer",
  "canceled_at": "datetime",
  "canceled_by": "string"
}

403

Acesso não autorizado

application/json

Schema

Schema

any

Example (from schema)

{
  "status": "error",
  "message": "Unauthorized"
}

Example

{
  "status": "error",
  "message": "Unauthorized"
}

404

Assinatura não encontrada

application/json

Schema

Schema

any

Example (from schema)

{
  "status": "error",
  "message": "Subscription not found"
}

Example

{
  "status": "error",
  "message": "Subscription not found"
}

Loading...