O objeto invoice representa os documentos gerados automaticamente ao final de cada ciclo de uma assinatura, discriminando todos os valores referentes à assinatura, como itens e descontos, para realização da cobrança do assinante. Saiba mais sobre faturas. o objeto invoice tem os seguintes atributos:
| Atributos | Tipo | Descrição |
|---|---|---|
id | string | Código da fatura. Formato: in_XXXXXXXXXXXXXXXX |
url | string | URL da página de pagamento da fatura. |
amount | integer | Valor total em centavos. |
payment_method | string | Meio de pagamento. Valores possíveis: credit_card, boleto ou cash |
installments | integer | Quantidade de parcelas. Será aplicado caso o método de pagamento da assinatura seja cartão de crédito. |
status | string | Status da fatura. Valores possíveis: pending, paid, canceled, scheduled ou failed. |
billing_at | datetime | Data da cobrança da fatura. |
seen_at | datetime | Data de visualização da fatura. |
due_at | datetime | Data de vencimento da fatura. |
created_at | datetime | Data de criação da fatura (UTC). |
canceled_at | datetime | Data de cancelamento da fatura (UTC). |
period | object | Período da fatura. |
items | array of objects | Item da fatura. |
subscription | object | Dados da assinatura. Saiba mais sobre assinaturas. |
customer | object | Dados do cliente. Saiba mais sobre clientes. |
metadata | object | Informações adicionais sobre a fatura. Saiba mais sobre metadata |
total_discount | integer | _Cálculo total dos descontos aplicados. |
total_increment | integer | _Cálculo total dos acréscimos aplicados. |