Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Your Merchant API key. Create one in Dashboard → Developers → API keys.

Path Parameters

storeId
string
required

Your store id. Find it in Dashboard → Developers, or in GET /stores with MCP.

customerKey
string
required

Customer email, or the customer id.

Body

application/json
type
enum<string>
required
Available options:
add,
subtract,
set
amount
number
required
Required range: x >= 0
note
string | null
Maximum string length: 500

Response

The new balance.

The response is of type object.