Grant or take back credits by hand. Writes an adjustment into the ledger — history is never edited, and another adjustment reverses anything. Taking back more than the customer holds is refused (422) — a balance never goes below zero.
Request Parameters
Field
Type
Required
Description
customer_email
string
Requiredone of these two
The customer's email
customer_id
integer
Requiredone of these two
The customer id
delta
integer
Required
Credits to add — negative takes back
note
string
Optional
Why — shows in the ledger
idempotency_key
string
Optional
Your own reference for this adjustment. Sending the same key again returns the original result instead of adjusting twice
Response Fields
Field
Type
Description
customer_id
integer
The customer
delta
integer
What was asked for
applied
boolean
true when this call changed the balance; false when it matched an earlier idempotency_key and nothing more was applied