Skip to main content
PATCH
Set the company's spend limits

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json
limits_enabled
boolean

Whether the monthly spend limits are on.

auto_reload
boolean

Whether a low balance reloads itself; turning it on needs reload_authorization_version.

reload_authorization_version
string

The auto-reload authorization version the merchant was shown and accepts.

auto_reload_threshold_cents
integer | null

Reload below this spendable balance

Required range: x >= 1
auto_reload_amount_cents
integer | null

What one reload buys

Required range: x >= 1
orders_limit_cents
integer | null

Orders and checkout; notified

Required range: x >= 1
ai_limit_cents
integer | null

Monthly ceiling on AI

Required range: x >= 1
hosting_limit_cents
integer | null

Apps

Required range: x >= 1
studios_limit_cents
integer | null

Monthly ceiling on Fluid Studios

Required range: x >= 1
ai_daily_limit_cents
integer | null

Daily ceiling on AI

Required range: x >= 1
studios_daily_limit_cents
integer | null

Daily ceiling on Fluid Studios

Required range: x >= 1
auto_reload_daily_cap_cents
integer | null

The most auto-reload tops up in a day; null is Fluid's default.

Required range: x >= 1
auto_reload_monthly_cap_cents
integer | null

The most auto-reload tops up in a month; null is Fluid's default.

Required range: x >= 1
shown_reload_threshold_cents
integer

The reload threshold the merchant was shown with the consent, as reload_threshold_cents reads it. Sent with a save that turns auto-reload on or renews its consent; if the threshold the save would store differs, the save is refused with 409 usage_controls_changed. A renewal renews the consent only when it sends all four shown_reload_* figures: with none, the old consent stays and the rest of the save applies; with only some, the save is refused with 422. Left out of a first turn-on, it is not checked.

Required range: x >= 1
shown_reload_amount_cents
integer

The reload amount shown with the consent, as reload_amount_cents reads it; checked like shown_reload_threshold_cents.

Required range: x >= 1
shown_reload_daily_cap_cents
integer

The daily reload cap shown with the consent, as reload_caps.daily_cents reads it; checked like shown_reload_threshold_cents.

Required range: x >= 1
shown_reload_monthly_cap_cents
integer

The monthly reload cap shown with the consent, as reload_caps.monthly_cents reads it; checked like shown_reload_threshold_cents.

Required range: x >= 1

Response

Success

The merchant's spend limits and auto-reload.

usage_controls
object
required

What the merchant has set about its own usage: spend limits, and auto-reload, which buys the reload amount with the payment method on file when the spendable balance falls below the threshold, within the reload caps, and only with its authorization on record.