Update Credit Balance

PUT /users/{user_id}/credits

Overview

Updates a user’s credit balance by increasing or decreasing the current amount.

This operation is typically used after a user action that consumes or restores credits.

Typical use cases

• Deducting credits when a service is used

• Adding credits through events or rewards

• Manually adjusting credits by an administrator

Header

Name	Value
Content-Type	application/json
Authorization (API Key)	Bearer <API Key>

Path

Name	Description
user_id	User identifier (user_id). Optional on create — if not provided, a system-generated ID will be used More description

Body

Name	Type	Description
credit_delta	number	The amount by which the user’s credit balance should change. A positive value will increase the user’s balance, and a negative value will decrease it.
description (optional)	string	A human-readable explanation of the action or transaction. This text helps provide context or reasoning for why the credit was updated.

Response

200

{
    "message": "resource updated successfully",
    "credit_balance": 706
}

400

404