Skip to main content
PATCH
Update customer balance
Store credit is real spendable value. The balance applies immediately at your checkout and never expires, so treat this like issuing money.It is not cashable - customers cannot withdraw it - and a top-up order can never be refunded to balance, since that would credit them twice.

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required

The ID of the store.

customerId
string<uuid>
required

The ID of the customer whose balance to update.

Body

The form containing the new balance value.

Form used to update a customer's balance for a given store.

newBalance
number<currency>
required

The new balance to set for the customer. Must be zero or positive.

Required range: 0 <= x <= 1.7976931348623157e+308
comment
string | null

Optional comment or reason for this balance update, for audit purposes.

Maximum string length: 256

Response

The object was successfully updated.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

A descriptive message providing additional context or information about the response.

code
string | null

The error code (if there was an error) to use when referencing the error

data
any | null

Represents the data associated with a response.

Last modified on August 2, 2026