---
title: "Cria um novo registro de utilização."
method: POST
path: "/v1/usages"
tags: ["usages"]
---

# Cria um novo registro de utilização.

`POST /v1/usages`

Para criar um novo registro de utilização em um período é necessário informar um dos produtos contidos na assinatura. Isso pode ser feito através do atributo `product_id` (ID do produto) ou `product_item_id` (ID do item da assinatura).

  Ao remover um registro com sucesso, o próprio será retornado no corpo da resposta.

## Request body

- PostV1Usages — Cria um novo registro de utilização.
  - `body` string — JSON com atributos do novo registro de utilização.
  - `period_id` integer, required — ID do período que receberá o registro de utilização
  - `product_id` integer — ID do produto que receberá o registro de utilização. Informe este parâmetro ou `product_item_id`
  - `product_item_id` integer — ID do item da assinatura que receberá o registro de utilização. Informe este parâmetro ou `product_id`
  - `description` string — Descrição opcional
  - `metadata` 'array' — Metadados do registro de utilização
  - `quantity` integer, required — Quantidade do registro de utilização

## Response `201`

Registro de utilização criado com sucesso.

- Usage — Para criar um novo registro de utilização em um período é necessário informar um dos produtos contidos na assinatura. Isso pode ser feito através do atributo `product_id` (ID do produto) ou `product_item_id` (ID do item da assinatura). Ao remover um registro com sucesso, o próprio será retornado no corpo da resposta.
  - `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

## Other responses

- `400` — Erro de sintaxe JSON no corpo do request.
- `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)