---
title: "Editar Assinatura"
method: PUT
path: "/subscriptions/{id}"
---

# Editar Assinatura

`PUT /subscriptions/{id}`

Altera os dados de uma Assinatura, quaisquer parâmetros não informados não serão alterados.

## Path parameters

- `id` string, required

## Request body

- object
  - `plan_identifier` string — Identificador do Plano. Só é enviado para assinaturas que não são credits_based
  - `expires_at` string, date — Data de Expiração "AAAA-MM-DD". (Também é a data da próxima cobrança)
  - `payable_with` string[] — Método de pagamento que será disponibilizado para as Faturas desta Assinatura (all, credit_card, pix ou bank_slip). Obs: Dependendo do valor, este atributo será herdado, pois a prioridade é herdar o valor atribuído ao Plano desta Assinatura; caso este esteja atribuído o valor ‘all’, o sistema considerará o payable_with da Assinatura; se não, o sistema considerará o payable_with do Plano
  - `ignore_due_email` boolean — Desabilita o envio de emails notificando o vencimento de uma fatura em assinaturas que podem ser pagas com boleto bancário.
  - `credits_based` boolean — É uma assinatura baseada em créditos? booleano
  - `price_cents` integer — Preço em centavos da recarga para assinaturas baseadas em crédito
  - `credits_cycle` integer — Quantidade de créditos adicionados a cada ciclo, só enviado para assinaturas credits_based
  - `credits_min` integer — Quantidade de créditos que ativa o ciclo, por ex: Efetuar cobrança cada vez que a assinatura tenha apenas 1 crédito sobrando. Esse 1 crédito é o credits_min
  - `subitems` object[] — Adiciona itens de cobrança a mais na assinatura do cliente. "price_cents" valor mínimo 100. Para remover, envie "id" do subitem + "_destroy:true"
    - `id` string — ID do subitem a ser removido
    - `_destroy` boolean — true ou false
    - `description` string — Descrição do item
    - `price_cents` string — Preço em Centavos. Valores negativos entram como desconto no total das Faturas criadas pela Assinatura. "price_cents" valor mínimo 100.
    - `quantity` string — Quantidade
    - `recurrent` boolean — Item Recorrente?
  - `suspended` boolean — Assinatura suspensa? booleano
  - `skip_charge` boolean — Ignorar Cobrança? booleano
  - `custom_variables` object[] — Variáveis Personalizadas
    - `name` string — Nome da Variável
    - `value` string — Valor da Variável
  - `two_step` boolean — Habilita/Desabilita transações em duas etapas para a assinatura (precisa ter o da conta ativado para usar)
  - `suspend_on_invoice_expired` boolean — Quando uma assinatura tem uma fatura expirada, se esse campo estiver como FALSE, assinatura não será suspensa. (porém é necessário ajustar a data de vencimento para seguir com o ciclo.
  - `soft_descriptor_light` string — Altera a descrição da cobrança no cartão de crédito do cliente final (Até 12 caracteres). Caso não seja enviado, será utilizada a descrição configurada na conta.

## Response `200`

200

- object
  - `id` string
  - `suspended` boolean
  - `plan_identifier` string
  - `price_cents` integer
  - `currency` string
  - `features` object
  - `customer_name` string
  - `customer_email` string
  - `cycled_at` string
  - `credits_min` integer
  - `credits_cycle` unknown
  - `payable_with` string
  - `ignore_due_email` boolean
  - `max_cycles` integer
  - `cycles_count` integer
  - `recent_invoices` object[]
    - `id` string
    - `due_date` string
    - `status` string
    - `total` string
    - `secure_url` string
  - `subitems` object[]
    - `id` string
    - `description` string
    - `quantity` integer
    - `price_cents` integer
    - `recurrent` boolean
    - `price` string
    - `total` string
  - `logs` object[]
    - `id` string
    - `description` string
    - `notes` string
    - `subscription_changes` string
    - `created_at` string
  - `custom_variables` object[]
  - `expires_at` unknown
  - `created_at` string
  - `updated_at` string
  - `customer_id` string
  - `plan_name` string
  - `customer_ref` string
  - `plan_ref` string
  - `active` boolean
  - `two_step` boolean
  - `suspend_on_invoice_expired` boolean
  - `in_trial` unknown
  - `credits` integer
  - `credits_based` boolean

## Other responses

- `400` — 400

---

[API](https://skmtc.net/iugu/apis/tokens-de-api.md) · [All operations](https://skmtc.net/iugu/apis/tokens-de-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/iugu/tokens-de-api/versions/4590fc729d1e/schema)