v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
bills

Retorna uma fatura específica através do ID.

A fatura totaliza, em valores financeiros, mercadorias ou serviços que serão cobrados do cliente final. Faturas podem ser classificadas em dois tipos:

  1. Faturas provenientes de assinaturas: São as faturas geradas a partir de assinaturas e seus respectivos períodos.
  2. Faturas avulsas: Faturas que não possuem qualquer relação com uma assinatura.

Faturas provenientes de assinaturas

Podem ser geradas de duas formas diferentes:

  1. Automaticamente no dia programado para cobrança através do atributo billing_at do período (apenas se este cumprir com os requisitos de faturamento automático).
  2. Manualmente através do painel de administração ou pelo método da API POST /periods/{id}/bill.

Aprovação de faturas

Ao menos que seja especificado nas configurações da plataforma, toda fatura é gerada com o status "Aguardando aprovação" (review). Este status serve para validar os valores que serão enviados e cobrados do cliente final. A fatura será cobrada somente após a aprovação, que pode ser feita manualmente através do painel de administração ou do método da API POST /bills/{id}/approve.

Itens da fatura

Uma fatura é composta de vários itens representados no array bill_items. Cada item possui um valor e um produto associado. A soma de todos os itens é igual ao total da fatura. A única exceção para esta regra é no caso da aplicação de movimentos adicionais de crédito ou débito.

Descontos

Um desconto será representado por um bill_item com amount negativo e um objeto discount associado. Apenas faturas de assinaturas possuem descontos. Faturas avulsas devem ser geradas com seu valor final.

Cobranças

O ato da aprovação da fatura, seja ele automático ou manual, irá gerar um objeto do tipo cobrança (charge). Este objeto é a representação da cobrança enviada ao cliente e controla, entre outras coisas, vencimento, notificações automáticas e número de retentativas. Normalmente uma fatura irá conter uma única cobrança, porém a plataforma suporta múltiplas cobranças para uma mesma fatura.

get/v1/bills/{id}

Path parameters

idinteger required

ID da fatura que deverá ser retornada.

Response

Ok. Fatura encontrada.

idinteger required

ID da fatura

codestring

Código externo para referência via API

amountnumber required

Valor da fatura

installmentsinteger required

Número de parcelas

status'review' | 'pending' | 'paid' | 'canceled' | 'scheduled' required

Status da fatura

seen_atstring required

Última visualização da fatura

billing_atstring

Data opcional de emissão da cobrança

due_atstring

Data de vencimento da fatura

urlstring required

URL para pagamento da fatura

created_atstring required

Data e hora da geração da fatura

updated_atstring required

Data e hora da última atualização da fatura

metadataobject

Metadados da fatura