Saldo de crédito do cliente
Todos os clientes no Stripe Billing têm um saldo de crédito no qual você pode fazer ajustes de crédito e débito. Os ajustes no saldo de crédito podem ser um crédito (você deve dinheiro a eles) ou um débito (eles lhe devem dinheiro). Esses ajustes compõem um saldo do cliente que pode ser aplicado a faturas futuras.
Como o saldo de crédito é calculado a partir de um livro-razão (uma lista imutável de transações de débito e crédito), ele proporciona uma trilha de auditoria das transações do cliente. Essas transações de saldo do cliente podem fazer referência ao objeto indicado no ajuste (como uma nota de crédito ou cliente) ou até mesmo aos metadados que você pode usar como referência.
Exemplos de casos de uso
Estes são alguns casos de uso comuns para os saldos de crédito do cliente:
- Emitir uma nota de crédito para criar um crédito que reduza o valor devido na próxima fatura.
- Cálculos pro rata em downgrade de uma assinatura podem criar indiretamente créditos para reduzir o valor devido na próxima fatura.
- Quando o valor devido em uma fatura é inferior ao menor valor cobrável, a fatura é marcada como paga, e o valor devido é transferido para o saldo de crédito como débito. Essa função só existe para clientes sem cash_balance.
Detalhes do saldo de crédito do cliente
Lembre-se dos seguintes detalhes quando usar saldos de crédito dos clientes:
- O saldo de crédito é aplicado automaticamente à próxima fatura finalizada para um cliente.
- Não é possível escolher uma fatura específica para aplicação do saldo de crédito.
- Não é possível optar por não aplicar o saldo de crédito a uma fatura.
- O saldo de crédito está na moeda do cliente.
- Clientes com saldo em dinheiro não podem manter um saldo positivo, ou seja, não podem aumentar o valor devido na próxima fatura.
Débitos e créditos
Valores negativos são tratados como créditos (uma redução no valor devido pelo cliente a você) que você pode aplicar na próxima fatura.
Valores positivos são tratados como débitos (um aumento no valor devido pelo cliente a você) que você pode aplicar na próxima fatura.
Transações
Todas as modificações no saldo de crédito são tratadas como transações. Após a criação de uma transação, somente as propriedades description
ou metadata
podem ser alteradas. Não é possível editar outras propriedades ou excluir uma transação.
Desfazer uma transação
A única forma de desfazer uma transação é revertê-la com uma nova transação. Por exemplo, se você creditou US$ 10 para um cliente, precisa debitar o mesmo valor do cliente em uma nova transação para que uma cancele a outra.
Tipos de transação
Todas as transações criadas com a API ou no Dashboard são do tipo adjustment
e representam um débito ou crédito que você aplica manualmente para o cliente.
A propriedade type
tem vários outros valores possíveis para representar a fonte da criação e o motivo da transação. A tabela a seguir resume e descreve os valores de type
:
Tipo | Descrição |
---|---|
adjustment | Uma transação de ajuste criada especificamente para debitar ou creditar o saldo de crédito. Esse é o único tipo de transação que você pode criar usando integrações com a API e o Dashboard. |
applied_to_invoice | Rastreia a aplicação de crédito a uma fatura vinculada. |
credit_note | Rastreia a criação de crédito para uma nota de crédito e a fatura associada. |
invoice_too_small | Quando o valor devido em uma fatura é inferior ao menor valor cobrável da Stripe, e o cliente não tem um saldo em dinheiro, a fatura é debitada do saldo de crédito e adicionada ao valor devido da próxima fatura emitida. |
invoice_too_large | Quando o valor devido em uma fatura é superior ao maior valor cobrável da Stripe, e o cliente não tem saldo em dinheiro, a fatura é debitada do saldo de crédito e adicionada ao valor devido da próxima fatura emitida. |
unapplied_from_invoice | Rastreia a anulação de um saldo de crédito aplicado de uma fatura vinculada. Associado a uma transação ‘applied_to_invoice’ anterior. |
unspent_receiver_credit | Quando fundos não gastos em fontes do favorecido associados a um cliente sem saldo em dinheiro não são cobrados integralmente depois de 60 dias, a Stripe cobra automaticamente esses fundos em seu nome e credita o seu saldo. Quando isso ocorre, a Stripe também cria uma transação de crédito correspondente. |
initial | Representa o valor inicial do saldo de crédito do cliente quando o cliente é criado usando a API com um balanço de crédito diferente de zero. |
Modificar o saldo de crédito
Você pode modificar o saldo de crédito de um cliente no Dashboard criando um ajuste de transação de saldo do cliente na página de dados do cliente.
Role até encontrar o painel Saldo de crédito da fatura e clique em Ajustar saldo para exibir o modal Ajuste de saldo de crédito.
Nesse modal, você pode definir os dados do ajuste, como Tipo de ajuste (crédito ou débito), Moeda (disponível apenas para clientes que ainda não têm uma moeda definida), Valor e observação interna (visível para usuários do Dashboard, mas não para os clientes).
API
Crie ajustes usando a API Customer Balance, como no exemplo de código a seguir.
Histórico de transações de saldo de crédito
Para auditar os ajustes de saldo de crédito no Dashboard, acesse a página de dados do cliente e role até o painel Saldo de crédito da fatura.
O painel Saldo de crédito da fatura exibe o valor atual do saldo de crédito. Clique em Ver detalhes para ver o histórico de transações usado para calcular o valor. Cada linha de transação exibe os dados do tipo de transação, como um link para a fatura que aplicou o saldo de crédito ou a nota de crédito que creditou o saldo.
API
Use a API Customer Balance List para acessar uma lista de todas as transações de um cliente.
Saldos em dinheiro do cliente
Os clientes que usam transferências bancárias como forma de pagamento têm um objeto cash_balance com uma ou mais moedas no objeto available
. Esses fundos podem ser usados para fazer pagamentos ou pagar faturas. Clientes com saldos disponíveis apresentam o seguinte comportamento:
Não é possível criar um saldo negativo de cliente, pois isso representa dinheiro enviado do
Customer
.Não é possível finalizar uma fatura de valor muito baixo ou muito alto com o saldo em dinheiro (por exemplo, criar uma assinatura de US$ 0,01). Saiba mais sobre valores mínimos e máximos.
You can delete
Customers
that have a cash balance, but only if their cash balance is 0.Não é possível remover o saldo em dinheiro de um
Customer
.