Skip to main content
PUT
cURL

Authorizations

x-api-key
string
header
required

Your Recoup API key. Learn more.

Path Parameters

id
string<uuid>
required

The unique identifier (UUID) of the account. Must be the authenticated account or another accessible via organization membership.

Body

application/json

Auto top-up settings

enabled
boolean
required
Example:

true

amountCents
integer
required

Amount to charge and grant per top-up, in cents (5.00 to 1,000.00 USD).

Required range: 500 <= x <= 100000
Example:

10000

thresholdCents
integer
required

Balance, in cents, below which a top-up runs. Must be below amountCents.

Required range: x >= 0
Example:

100

Response

Settings saved.

account_id
string<uuid>
required
Example:

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

enabled
boolean
required

Whether auto top-up is on. Off by default.

Example:

true

amountCents
integer | null
required

Amount charged and granted per top-up, in cents. Null until set.

Example:

10000

thresholdCents
integer | null
required

Balance, in cents, below which a top-up runs. Null until set.

Example:

100

lastRunAt
string<date-time> | null
required

When the last auto top-up was attempted. Null until the first run.

Example:

"2026-09-04T15:05:00Z"

lastError
string | null
required

Stripe decline message from the attempt that turned auto top-up off. Null while healthy or once re-enabled.

Example:

"Your card was declined."