---
title: "Atualiza um período existente."
method: PUT
path: "/v1/periods/{id}"
tags: ["periods"]
---

# Atualiza um período existente.

`PUT /v1/periods/{id}`

Atualiza um período existente.

#### Data de término
A duração de um período pode ser atualizada modificando sua data de término. Esta atualização é possível apenas no último período de uma assinatura. Períodos subsequentes desta assinatura serão calculados conforme a nova data, respeitando o intervalo original.

#### Data de cobrança
Através deste método também é possível atualizar a data de cobrança de um período, porém a plataforma não irá realizar cobranças retroativas automaticamente. Caso a atualização seja para uma data igual ou anterior ao dia de hoje, será necessário forçar a cobrança usando `POST /periods/{id}/bill`.

## Path parameters

- `id` integer, required

## Request body

- PutV1Periods — Atualiza um período existente.
  - `body` string — JSON com os novos atributos do período.
  - `billing_at` string — Data para geração automática da cobrança do período
  - `end_at` string — Data do término do período

## Response `200`

Período atualizado com sucesso.

- Period — Uma assinatura deve possuir obrigatoriamente um ou mais períodos, que são gerados automaticamente conforme a configuração de cobrança e periodicidade da assinatura. Em uma assinatura baseada em um plano mensal, cada período terá a duração de aproximadamente 30 dias. #### Registros de utilização Todo período deverá possuir um ou mais registros de utilização. A fatura do período será gerada a partir destes registros de utilização. Para produtos configurados com preço fixo ou preço por quantidade, a plataforma irá criar automaticamente um registro de utilização conforme a quantidade indicada na assinatura. Para produtos com preços baseados no volume, nenhum registro será criado automaticamente e o período aguardará obrigatoriamente a informação do registro de utilização. A inclusão do registro pode ser feita através do painel de administração ou pela API. #### Fatura Normalmente um período possuirá uma única fatura que será gerada automaticamente na data `billing_at`, porém em casos especiais um período poderá possuir mais de uma fatura.
  - `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
  - `customer` CustomerSummary
    - `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
  - `subscription` SubscriptionSummary
    - `id` integer, required — ID da assinatura
    - `code` string — Código externo 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
    - `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
  - `usages` Usage[] — Lista de registros de utilização no período
    - `id` integer, required — ID do registro de utilização
    - `description` string — Descrição opcional
    - `created_at` string, required — Data e hora da geração do registro de utilização
    - `metadata` object — Metadados do registro de utilização
    - `product_item` ProductItemSummary, required
      - `id` integer, required — ID do item
      - `product` ProductSummary, required
        - `id` integer, required — ID do produto
        - `name` string, required — Nome do produto
        - `code` string — Código externo do produto
    - `bill` BillSummary
      - `id` integer, required — ID da fatura
      - `code` string — Código externo para referência via API
    - `quantity` integer, required — Quantidade informada no registro de utilização
  - `created_at` string, required — Data e hora da geração do período
  - `updated_at` string, required — Data e hora da última atualização do período

## Other responses

- `400` — Erro de sintaxe JSON no corpo do request.
- `404` — Período não encontrado.
- `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/revisions/9d11e5de9308/schema)