Skip to main content
PUT
Update auto-top-up configuration

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
enabled
boolean
required

Whether auto-top-up should be active.

threshold_minor
integer
required

Balance, in minor units (cents), at or below which a charge is triggered.

recharge_amount_minor
integer
required

Amount, in minor units (cents), to add; must exceed the threshold.

currency
string
required

ISO-4217 currency; must match the org's payment currency.

max_monthly_minor
integer | null

Optional monthly cap, in minor units.

clear_cap
boolean

Set true to explicitly clear the monthly cap; otherwise a null max_monthly_minor leaves the stored cap unchanged.

Response

200 - application/json

The persisted auto-top-up configuration after the update.

data
object
meta
object