Skip to main content
POST
Reset a rule budget
Reset a rule’s program-wide (PROGRAM) budget for one asset. Pass asset_id as a query parameter. Use this to restore a budget used up by incorrect events or to let the rule issue more rewards before its next reset. The request sets consumed to zero and advances next_reset_at to the next scheduled reset. A lifetime budget has no next reset. Per-participant budgets cannot be reset through this endpoint; if the asset has only a PARTICIPANT budget, it returns 404.
See Resetting a budget for examples and ways to let a capped participant earn more.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Rule ID

Query Parameters

asset_id
string<uuid>
required

Asset ID to reset budget for

Response

Budget reset

asset_id
string<uuid>

Asset this budget constrains

Example:

"550e8400-e29b-41d4-a716-446655440000"

consumed
string

Amount credited in the current budget period. Returned only for PROGRAM budgets; PARTICIPANT usage differs for each recipient.

Example:

"4500.00"

cron_expression
string

Cron expression for CRON-based resets, evaluated in UTC (e.g., first of every month)

Example:

"0 0 1 * *"

interval
string

Duration for INTERVAL-based resets

Example:

"720h"

limit
string

Maximum allowed spend for this budget period (per participant for a PARTICIPANT budget)

Example:

"10000.00"

next_reset_at
string<date-time>

Next scheduled reset. Omitted for lifetime budgets and PARTICIPANT budgets.

Example:

"2026-03-01T00:00:00Z"

schedule_type
string

Reset schedule type: CRON or INTERVAL (null for lifetime budgets)

Example:

"CRON"

scope
enum<string>

Whether the limit caps all credits of this asset from the rule (PROGRAM) or each recipient's credits (PARTICIPANT).

Available options:
PROGRAM,
PARTICIPANT
Example:

"PROGRAM"