POST
/
customers
/
{customer_id}
/
balance_transactions

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

customer_id
string
required

Body

application/json
amount
string
required
type
enum<string>
required
Available options:
increment,
decrement
description
string | null

An optional description that can be specified around this entry.

Response

200
application/json
OK
id
string
required

A unique id for this transaction.

created_at
string
required

The creation time of this transaction.

starting_balance
string
required

The original value of the customer's balance prior to the transaction, in the customer's currency.

ending_balance
string
required

The new value of the customer's balance prior to the transaction, in the customer's currency.

amount
string
required

The value of the amount changed in the transaction.

action
enum<string>
required
Available options:
applied_to_invoice,
manual_adjustment,
prorated_refund,
revert_prorated_refund,
return_from_voiding,
credit_note_applied,
credit_note_voided,
overpayment_refund,
external_payment
description
string | null
required

An optional description provided for manual customer balance adjustments.

invoice
object | null
required
type
enum<string>
required
Available options:
increment,
decrement
credit_note
object | null
required