/api/v1/customer/credit-spend

Deducts credit from the customer account. The amount is always treated as negative (spending). Returns the old and new balance along with a transaction ID.

customerpostApiV1CustomerCredit-spend

Parameters

1 query · 4 body

5 total

Query · 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

Body · 4

identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

amountnumberRequired

descriptionstring

App internal description.

customerRealIpstring

User IP address used for GEO/IP intelligence.
Accepted formats: IPv4 (e.g. 1.1.1.1), IPv6 (e.g. 2001:4860:4860::8888)
Normalization:

::1, 0.0.0.0, localhost (or empty value) is normalized to 127.0.0.1
Invalid values are rejected (the API expects a valid IP string).

If provided, the system can resolve additional context (reverse DNS, geolocation, ASN, proxy/hosting flags) via our internal VikiTron GEO/IP resolver. Learn more

Request

POST /api/v1/customer/credit-spend

post

curl -X POST "https://api.bizkithub.com/api/v1/customer/credit-spend?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "identityId": "Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg",
  "amount": 100,
  "description": "video.rewrite:15m",
  "customerRealIp": "1.1.1.1"
}'

Response

JSON payload

{
  "success": true,
  "transactionId": "HxanU4a1n4El61zx",
  "oldCreditBalance": 510,
  "newCreditBalance": 410
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key