VIvindi
usages

Cria um novo registro de utilização.

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.

post/v1/usages

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/usages
  • Auth
    HTTP basic

Request body

bodystring

JSON com atributos do novo registro de utilização.

period_idinteger required

ID do período que receberá o registro de utilização

product_idinteger

ID do produto que receberá o registro de utilização. Informe este parâmetro ou product_item_id

product_item_idinteger

ID do item da assinatura que receberá o registro de utilização. Informe este parâmetro ou product_id

descriptionstring

Descrição opcional

metadata'array'

Metadados do registro de utilização

quantityinteger required

Quantidade do registro de utilização

Response

Registro de utilização criado com sucesso.

idinteger required

ID do registro de utilização

descriptionstring

Descrição opcional

created_atstring required

Data e hora da geração do registro de utilização

metadataobject

Metadados do registro de utilização

quantityinteger required

Quantidade informada no registro de utilização

Changes

No recorded changes to this operation across all 1 revision of this API.