---
title: "Cancela uma assinatura através do ID."
method: DELETE
path: "/v1/subscriptions/{id}"
tags: ["subscriptions"]
---

# Cancela uma assinatura através do ID.

`DELETE /v1/subscriptions/{id}`

## Path parameters

- `id` integer, required

## Query parameters

- `cancel_bills` string
- `comments` string

## Response `200`

Assinatura cancelada com sucesso.

- Subscription — Utilize este método para listar as assinaturas associadas à sua conta na Vindi. Leia a documentação sobre [paginação](http://atendimento.vindi.com.br/hc/pt-br/articles/203020644#pagination) e [filtros de busca](http://atendimento.vindi.com.br/hc/pt-br/articles/204163150). #### Atributos para busca <code>status</code>, <code>id</code>, <code>code</code>, <code>installments</code>, <code>customer_id</code>, <code>interval</code>, <code>interval_count</code>, <code>billing_trigger_day</code>, <code>billing_trigger_type</code>, <code>billing_cycles</code>, <code>plan_id</code>, <code>payment_method_id</code>, <code>start_at</code>, <code>cancel_at</code>, <code>overdue_since</code>, <code>created_at</code>, <code>updated_at</code> e <code>end_at</code>. #### Inadimplência Além dos filtros acima, a busca por assinaturas adimplentes ou inadimplentes pode ser realizada através do atributo `overdue_since` no parâmetro `query`. Exemplos: - Assinaturas adimplentes: `overdue_since = null` - Assinaturas inadimplentes: `overdue_since != null` - Assinaturas inadimplentes há mais de n dias: `overdue_since < 2016-03-15` #### Itens da assinatura Uma assinatura é composta de vários itens representados no array `product_items`. Este endpoint lista apenas os 25 primeiros itens de cada assinatura. Caso queira listar mais itens de uma assinatura, utilize o método da API `GET /subscriptions/{id}/product_items`.
  - `id` integer, required — ID da assinatura
  - `status` 'active' | 'canceled' | 'future' | 'expired', required — Status da assinatura
  - `start_at` string, required — Data do início da assinatura no formato ISO 8601
  - `end_at` string — Data do término da assinatura no formato ISO 8601
  - `next_billing_at` string — Data da próxima cobrança da assinatura
  - `overdue_since` string — Data do início da inadimplência
  - `code` string — Código externo para referência via API
  - `cancel_at` string — Data do cancelamento da assinatura
  - `interval` 'days' | 'months', required — Duração do intervalo
  - `interval_count` integer, required — Número de intervalos dentro de um período
  - `billing_trigger_type` 'beginning_of_period' | 'end_of_period' | 'day_of_month', required — Referência para data de geração da cobrança
  - `billing_trigger_day` integer, required — Dia para geração da cobrança.
  - `billing_cycles` integer — Número máximo de períodos da assinatura. Nulo significa duração indefinida
  - `installments` integer, required — Número de parcelas
  - `created_at` string, required — Data e hora do cadastro da assinatura
  - `updated_at` string, required — Data e hora da última atualização da assinatura
  - `customer` CustomerSummary, required
    - `id` integer, required — ID do cliente
    - `name` string, required — Nome do cliente
    - `email` string — E-mail do cliente
    - `code` string — Código opcional para referência via API
  - `plan` PlanSummary, required
    - `id` integer, required — ID do plano
    - `name` string, required — Nome do plano
    - `code` string — Código externo do plano
  - `product_items` ProductItem[], required — Produtos incluídos na assinatura. Este atributo exibe os primeiros 25 itens. Para os demais, consulte o método `GET /subscriptions/:id/product_items`.
    - `id` integer, required — ID do item
    - `status` 'active' | 'inactive' | 'deleted', required — Status do item
    - `uses` integer — Número de ciclos de recorrência que utilizaram o produto.
    - `cycles` integer — Número de ciclos de recorrência onde o produto será aplicado a partir do momento de sua criação. Nulo significa duração ilimitada
    - `quantity` integer — Quantidade do produto incluído na assinatura. Se não for informado, o valor '1' será utilizado
    - `created_at` string, required — Data e hora da criação do item
    - `updated_at` string, required — Data e hora da última atualização do item
    - `product` ProductSummary, required
      - `id` integer, required — ID do produto
      - `name` string, required — Nome do produto
      - `code` string — Código externo do produto
    - `pricing_schema` PricingSchema
      - `id` string, required — ID do esquema de precificação
      - `short_format` string, required — Descrição da precificação gerada automaticamente
      - `price` number, required — Preço base
      - `minimum_price` number — Preço mínimo
      - `schema_type` 'flat' | 'per_unit' | 'step_usage' | 'volume_usage' | 'tier_usage', required — Tipo de cálculo da precificação
      - `pricing_ranges` PricingRange[] — Lista de faixas de precificação
        - `id` string, required — ID do faixa de precificação
        - `start_quantity` integer, required — Início da faixa
        - `end_quantity` integer — Término da faixa. Opcional apenas para a última
        - `price` number, required — Preço da unidade ou da faixa, dependendo do tipo escolhido
        - `overage_price` number — Preço unitário do excedente da faixa
      - `created_at` string, required — Data e hora do cadastro do esquema de precificação
    - `discounts` DiscountSummary[] — Lista de descontos ativos. Descontos já aplicados não serão retornados
      - `id` integer, required — ID do desconto
      - `discount_type` 'percentage' | 'amount' | 'quantity', required — Tipo do desconto
      - `percentage` number — Valor numérico para porcentagem de 0.01 até 100
      - `amount` number — Valor para desconto fixo
      - `quantity` integer — Número para desconto por quantidade
      - `cycles` integer — Número de ciclos de recorrência onde o desconto será aplicado a partir do momento de sua criação. Nulo significa desconto por tempo indefinido
  - `payment_method` PaymentMethodSummary, required
    - `id` integer, required — ID do método de pagamento
    - `public_name` string, required — Nome público do método de pagamento
    - `name` string, required — Nome interno do método de pagamento
    - `code` string, required — Código externo para referência via API
    - `type` string, required — Tipo do método de pagamento
  - `current_period` PeriodSummary
    - `id` integer, required — ID do período
    - `billing_at` string — Data para geração automática da cobrança do período
    - `cycle` integer, required — Ciclo do período
    - `start_at` string, required — Data e hora do início do período
    - `end_at` string, required — Data e hora do término do período
    - `duration` integer, required — Duração do período em número de segundos
  - `metadata` object — Metadados da assinatura
  - `payment_profile` PaymentProfileSummary
    - `id` integer, required — ID do perfil de pagamento
    - `holder_name` string — Nome do titular/portador do perfil de pagamento
    - `registry_code` string — CPF ou CNPJ do titular/portador
    - `bank_branch` string — Agência da conta bancária
    - `bank_account` string — Número da conta bancária
    - `card_expiration` string — Validade do cartão de crédito no formato MM/AA
    - `allow_as_fallback` string — Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.
    - `card_number_first_six` string — Primeiros 6 dígitos do cartão de crédito (BIN/IIN)
    - `card_number_last_four` string — Últimos 4 dígitos do cartão de crédito
    - `renewed_card` object
      - `card_number_last_four` string — Últimos quatro dígitos do cartão de crédito renovado
      - `card_expiration` string — Nova validade do cartão de crédito renovado
    - `card_renewed_at` string — Data da renovação do cartão de crédito renovado
    - `token` string, required — Token interno para referência do perfil de pagamento
    - `created_at` string, required — Data e hora do cadastro do perfil de pagamento
    - `payment_company` PaymentCompany, required
      - `id` integer, required — ID da bandeira ou banco
      - `name` string, required — Nome da bandeira ou banco
      - `code` string, required — Código para referência via API
  - `invoice_split` string — Nota fiscal fracionada. Indica se uma nota fiscal será emitida de acordo com a periodicidade do plano.
  - `subscription_affiliates` SubscriptionAffiliateResponseFull[] — Lista de participantes da assinatura. Este campo é exclusivo para transaçõesque utilizaram a regra de split de pagamento e os participantes estejam ativos.
    - `affiliate_id` integer — ID do participante
    - `amount` number — Fração do valor da assinatura referente ao participante
    - `amount_type` integer — Tipo de valor da assinatura, onde 1 representa uma quantia fixa (amount) e 2 representa a porcentagem (percentage)
    - `status` string — Status do participante em uma assinatura

## Other responses

- `400` — Erro de sintaxe JSON no corpo do request.
- `404` — Assinatura não encontrada.
- `422` — Parâmetros inválidos. Verificar erro na resposta.

---

[API](https://skmtc.net/vindi/apis/001-vindi-pagamentos-agost.md) · [All operations](https://skmtc.net/vindi/apis/001-vindi-pagamentos-agost/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vindi/001-vindi-pagamentos-agost/versions/9d11e5de9308/schema)