Skip to main content
PUT
Node.js

Headers

x-api-key
string
required

API key from your PriceOS dashboard.

Path Parameters

bonusId
string<uuid>
required

Bonus ID.

Body

application/json
amount
number

Optional updated bonus amount.

expiresAt
integer | null

Optional Unix timestamp (ms) when the bonus expires. Use null to clear.

reason
string | null

Optional reason for the bonus. Use null to clear.

metadata
object | null

Optional metadata for the bonus (string key/value pairs). Use null to clear.

Response

Bonus updated

Bonus update result.

bonus
object
required

Updated bonus.

counterRemaining
number
required

Total remaining bonus amount for this customer + feature.