Faturas

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:

AtributosTipoDescrição
idstringCódigo da fatura. Formato: in_XXXXXXXXXXXXXXXX
urlstringURL da página de pagamento da fatura.
amountintegerValor total em centavos.
payment_methodstringMeio de pagamento. Valores possíveis: credit_card, boleto ou cash
installmentsintegerQuantidade de parcelas. Será aplicado caso o método de pagamento da assinatura seja cartão de crédito.
statusstringStatus da fatura. Valores possíveis: pending, paid, canceled, scheduled ou failed.
billing_atdatetimeData da cobrança da fatura.
seen_atdatetimeData de visualização da fatura.
due_atdatetimeData de vencimento da fatura.
created_atdatetimeData de criação da fatura.
canceled_atdatetimeData de cancelamento da fatura.
periodobjectPeríodo da fatura.
itemsarray of objectsItem da fatura.
subscriptionobjectDados da assinatura. Saiba mais sobre assinaturas.
customerobjectDados do cliente. Saiba mais sobre clientes.
metadataobjectInformações adicionais sobre a fatura. Saiba mais sobre metadata
total_discountinteger_Cálculo total dos descontos aplicados.
total_incrementinteger_Cálculo total dos acréscimos aplicados.