BizKitHub
DocsInteractive API Docs/api/v1/customer/credit-spend
post

/api/v1/customer/credit-spend

API endpoint documentation

Endpoint Info
Base URLapi.bizkithub.com
AuthBearer Token
Methods1
Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

1 query, 4 body parameters

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

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

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/customer/credit-spend?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "identityId": "Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg",
    "amount": 100,
    "description": "video.rewrite:15m",
    "customerRealIp": "1.1.1.1"
  })
});

const data = await response.json();
console.log(data);
post

Example Response

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

cURL

Command line example

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

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key
Back to API DocumentationAPI Reference