Turn agent purchasing on or off and set its limits; every change is audited

put/v1/account/billing/agent-purchasing

Request

  • Base URL: https://api.roveapi.com
  • URL: https://api.roveapi.com/v1/account/billing/agent-purchasing
  • Auth: API key in cookie rove_session

Request body

state'off' | 'on' required

off by default: no API key can buy until the owner turns it on

per_purchase_max_centsinteger required

Ceiling $500; not above period_max_cents.

period'day' | 'week' | 'month' required

Calendar periods in UTC; weeks start Monday.

period_max_centsinteger required

Ceiling $2,000.

off_session_allowedboolean required

Response

Successful response (Cache-Control: no-store)

state'off' | 'on' required

off by default: no API key can buy until the owner turns it on

per_purchase_max_centsinteger required

Ceiling $500; not above period_max_cents.

period'day' | 'week' | 'month' required

Calendar periods in UTC; weeks start Monday.

period_max_centsinteger required

Ceiling $2,000.

off_session_allowedboolean required
updated_atstring date-time nullable required

null until the owner first changes it; the values are then the defaults ($25 per purchase, $100 per month).

period_committed_centsinteger required

Live agent and auto top-up purchases this period that reserve or spent their amount; owner purchases never count.

period_resets_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.