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

get https://app.vindi.com.br/api/v1/periods/{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.

Responses

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.vindi.com.br/api/v1/periods/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok. Período encontrado.

400Erro de sintaxe JSON no corpo do request.

404Período não encontrado.

422Parâmetros inválidos. Verificar erro na resposta.