List transactionsPOST

OpenStock Docs

POST

/api/customer-balance-api/customers/transactions

customer_balance_api

Returns a customer’s balance history. Pagination parameters go in the body for this endpoint.

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.

typestring

Filter by credit or debit.

limitinteger

Between 1 and 100. Default: 20

offsetinteger

Number of results to skip. Default: 0

Responses#

200A page of transactions.
404Unknown customer.
401Missing, malformed, disabled or expired API key.

curl -X POST "https://openstock.dev/api/customer-balance-api/customers/transactions" \
  -H "Authorization: Bearer $OPENSTOCK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "limit": 20
  }'

A page of transactions.

{
  "data": [
    {
      "id": "b1e0c9d8-7a6f-4e5d-8c3b-2a1f0e9d8c7b",
      "type": "credit",
      "amount": 10,
      "reason": "Referral reward",
      "metadata": {},
      "created_at": "2026-03-04T18:30:00.000Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}