Skip to main content
POST
cURL
Reads the current balance for a customer and active feature without consuming credits. Send the stable customerId and featureId. The response includes allowed, availableCredits, and that feature’s creditCost; an insufficient balance returns 200 with allowed: false. A check does not reserve credits. Other usage may occur before you record this action, so Record usage makes a fresh decision and may return 409 insufficient_credits even after allowed: true. Call from your backend before performing the feature, then track only a successful action. An unknown customer or archived/unknown feature returns 404 customer_not_found or 404 feature_not_found. See Credits and usage for balance order and concurrency behavior.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
customerId
string
required
Required string length: 1 - 255
featureId
string
required
Required string length: 1 - 100

Response

Current credit availability

allowed
boolean
required
availableCredits
integer
required
Required range: x >= 0
creditCost
integer
required