Deduct balancePOST

OpenStock Docs

POST

/api/customer-balance-api/customers/deduct-balance

customer_balance_api100 requests / hour

Debits a customer’s store balance. Fails if the customer does not exist or has insufficient balance.

Authorization#

AuthorizationBearer <token>

In: header. A store API key starting with sk_ that has the customer_balance_api permission.

Request body#

application/json

emailrequiredstring

Customer email address.

amountrequirednumber

Positive amount to deduct.

reasonstring

Shown in the customer’s transaction history. Default: "API balance deduction"

metadataobject

Stored with the transaction.

Responses#

200Balance updated.
400Insufficient balance or invalid input.
404Unknown customer.
401Missing, malformed, disabled or expired API key.

curl -X POST "https://openstock.dev/api/customer-balance-api/customers/deduct-balance" \
  -H "Authorization: Bearer $OPENSTOCK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "amount": 5,
    "reason": "Manual adjustment"
  }'

Balance updated.

{
  "success": true,
  "customer": {
    "id": "6f1d3c2a-0b4e-4c8d-9a7f-2e5b1c0d9a8e",
    "email": "jane@example.com",
    "balance": 20
  },
  "transaction": {
    "type": "debit",
    "amount": 5,
    "reason": "Manual adjustment"
  }
}