Apply balance to invoice

Apply customer balance (credit) to an open or past-due invoice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Apply a customer's credit balance to an open or past-due invoice. If the credit covers the full amount due, the invoice is marked as paid. Otherwise the balance is partially applied and the amount due is reduced.

Behavior

  • Only works on open or past_due invoices
  • Returns 400 if the customer has no credit balance
  • Returns 400 if the invoice is already paid, voided, or uncollectible
  • When fully paid, fires the invoice.payment_succeeded event
  • The customer's balance is debited by the applied amount
Path Params
int32
required

The invoice ID.

Query Params
int32
required

The unique identifier of the site associated with your account.

Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json