v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
periods

Atualiza um período existente.

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.

put/v1/periods/{id}

Path parameters

idinteger required

ID do período.

Request body

bodystring

JSON com os novos atributos do período.

billing_atstring

Data para geração automática da cobrança do período

end_atstring

Data do término do período

Response

Período atualizado com sucesso.

idinteger required

ID do período

billing_atstring

Data para geração automática da cobrança do período

cycleinteger required

Ciclo do período

start_atstring required

Data e hora do início do período

end_atstring required

Data e hora do término do período

durationinteger required

Duração do período em número de segundos

created_atstring required

Data e hora da geração do período

updated_atstring required

Data e hora da última atualização do período