Skip to content

Credits ​

Credits are customer balances that can reduce a future invoice or be refunded. They are created by subscription proration workflows when a billed period is reduced or cancelled; the application preserves related product, date-range, quantity, and reason metadata.

Review credits ​

Open Credits directly or use a customer's Credits tab. Filter by customer ID or status. Each record shows its original amount, remaining amount, reason, status, and creation date.

Apply a credit to an invoice ​

Apply credits from the target invoice, not from the credit record:

  1. Open a payment-due invoice that has no payment in progress.
  2. Select Apply credits and choose an available credit for the same customer.
  3. Confirm the action.

The amount applied is the smaller of the credit's remaining balance and the invoice's outstanding balance. The balance is reduced atomically with the invoice payment record, preventing the same balance from being applied twice.

Refund a credit ​

Use Refund on an available credit when money must be returned rather than applied to an invoice.

  1. Enter a positive amount no greater than the remaining balance.
  2. Enter the refund reason (the default is credit_refund) and, if useful, the payment provider, external payment ID, and notes.
  3. Submit the refund request. This reserves the selected credit amount and creates a due refund record.
  4. Complete the refund record after the payment provider has issued the refund, recording its external refund ID and date.

If a due refund is cancelled, its reserved amount is restored to the credit balance.

Cancel a credit ​

Use Cancel only when the credit is still fully available—its remaining amount must equal its original amount. A partially used or fully applied credit cannot be cancelled.

Statuses ​

StatusMeaning
availableHas a positive balance that can be applied to an invoice or reserved for a refund.
appliedIts full balance has been applied to invoices.
refundedIts full balance has been reserved for refund.
cancelledThe untouched credit was cancelled and cannot be used.

Credits cannot be moved between customers. An application or refund that would exceed the remaining balance is rejected.