v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
periods

Retorna um período específico através do ID.

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.

get/v1/periods/{id}

Path parameters

idinteger required

ID do período que deverá ser retornado.

Response

Ok. Período encontrado.

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